diff --git a/content/.metadata.json b/content/.metadata.json index ba79940e1..f0d582efe 100644 --- a/content/.metadata.json +++ b/content/.metadata.json @@ -1,7 +1,7 @@ { "metadata": { "version": "2.0", - "fetch_date": "2026-08-26T11:18:47.094967Z", + "fetch_date": "2026-08-27T10:43:25.822644Z", "section": "all" }, "items": [ @@ -9,14 +9,14 @@ "url": "https://platform.claude.com/docs/en/home", "status": "success", "path": "en/home.md", - "sha256": "c73dd2b86da6e4c4f8a8d97e3493b941813f39a57a6bd0bf8f39b8532eb2896f", + "sha256": "6ddc70447304afea3d0a4e572ab5c57a6e82a64cca265938b66960d909a3dba2", "size": 11960 }, { "url": "https://platform.claude.com/docs/en/intro", "status": "success", "path": "en/intro.md", - "sha256": "967c1727dbb4b105a214ecae505cbe931a62c47f108aeafa1bd514871d2b04ff", + "sha256": "cbf18b4d02520f74c39d50650a1e541267f16b0268a86fc0b4d6bf1f38ccf55d", "size": 5251 }, { @@ -44,8 +44,8 @@ "url": "https://platform.claude.com/docs/en/build-with-claude/overview", "status": "success", "path": "en/build-with-claude/overview.md", - "sha256": "1c57698b37d647b70b27a404750812646a35049172bd9ec0e066f83166c556ae", - "size": 29262 + "sha256": "4aec13c22c505b6cf663c7e4eeee40888089f48f008f06fb1bc1aedd84c765bb", + "size": 29211 }, { "url": "https://platform.claude.com/docs/en/build-with-claude/working-with-messages", @@ -100,8 +100,8 @@ "url": "https://platform.claude.com/docs/en/build-with-claude/structured-outputs", "status": "success", "path": "en/build-with-claude/structured-outputs.md", - "sha256": "a1528596faaa627c7fb139c775bfc68634777c99be02f4dab92659af7b0b6d8b", - "size": 110777 + "sha256": "1004fc774d446a75680f7ac565d22e481d127ebb12b618bc3e0a44e9896d9313", + "size": 110462 }, { "url": "https://platform.claude.com/docs/en/build-with-claude/citations", @@ -254,15 +254,15 @@ "url": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool", "status": "success", "path": "en/agents-and-tools/tool-use/web-search-tool.md", - "sha256": "68e1c04c7773e6884f4936d6d9254515842fdb65967e46a4bab1e685065c25cd", - "size": 28151 + "sha256": "fe09357ca613ea1d82c62de53e0588ff0cc7b2c5dcffdbaa910bc4de0e436120", + "size": 28270 }, { "url": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool", "status": "success", "path": "en/agents-and-tools/tool-use/web-fetch-tool.md", - "sha256": "a7a468b3c3c953377f61b6ea2d9e626732dad65fbd8024875770baa69a2a486f", - "size": 34781 + "sha256": "2e8fbff0eef10cd393bbc5a8be1af8e8e4572f9df2cc8a5f7db1561aac682df1", + "size": 34906 }, { "url": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool", @@ -310,15 +310,15 @@ "url": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool", "status": "success", "path": "en/agents-and-tools/tool-use/computer-use-tool.md", - "sha256": "2c6cdbb95ff82da72c029087245423563a91170d79f2a5170d57505811a6d97c", - "size": 114735 + "sha256": "0252fb0c6fde0e8841210305918bc4b8e655ac56e7ca019a085cd5529df48a42", + "size": 114818 }, { "url": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool", "status": "success", "path": "en/agents-and-tools/tool-use/browser-use-tool.md", - "sha256": "6138dd716541898693cbe5082681a06f580ae6477ebf2d0d3608b005cdb1e59c", - "size": 105485 + "sha256": "1d56a7112ad8bae81d8929fc5170f39f9e4eee08a40a8cb729c4c7b8d359574c", + "size": 105648 }, { "url": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/troubleshooting-tool-use", @@ -499,8 +499,8 @@ "url": "https://platform.claude.com/docs/en/agents-and-tools/mcp-connector", "status": "success", "path": "en/agents-and-tools/mcp-connector.md", - "sha256": "efd377840fac2d346234750af190ce2abef6337e709beeb5e75eb1bebc4f8e9c", - "size": 49758 + "sha256": "15ce9ae62471a1a50c979825f7896883c28bad1d21a617094602a17c2fc3abae", + "size": 49443 }, { "url": "https://platform.claude.com/docs/en/agents-and-tools/mcp-tunnels/overview", @@ -583,22 +583,22 @@ "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "status": "success", "path": "en/build-with-claude/claude-platform-on-aws.md", - "sha256": "d769dc2d4bc6264830e5cbefec82c7ed4a13899121dce28fc084a097907ea998", - "size": 84725 + "sha256": "e9f1ab24d6dc9e090a8365ca7475346a23ad2521df1242c95111a1cfeb25ba00", + "size": 84958 }, { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai", "status": "success", "path": "en/build-with-claude/claude-on-vertex-ai.md", - "sha256": "3ee5c842437170b9450cddeb9bacd6157a759aed1fc27848f89816eabf9ffe24", - "size": 32818 + "sha256": "f80d1f5b4bbd35852d1cd71936213b7c9fe3f9e07ca11460ae71f90b2763c94b", + "size": 32554 }, { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry", "status": "success", "path": "en/build-with-claude/claude-in-microsoft-foundry.md", - "sha256": "8f71636f39fdbfb44266f9bf7a78559591c8ed739e4be264bbb7b3824881007d", - "size": 36506 + "sha256": "fe0020a280f5e8bba8155d595db1169ccb219914c7a1fb712ec3f7677bc094c3", + "size": 37128 }, { "url": "https://platform.claude.com/docs/en/managed-agents/overview", @@ -793,8 +793,8 @@ "url": "https://platform.claude.com/docs/en/manage-claude/admin-api", "status": "success", "path": "en/manage-claude/admin-api.md", - "sha256": "0e5af336fe39eb46fa97aace4cf37760242b8db76be96f33ddc977f2c2ec0f68", - "size": 15175 + "sha256": "baa15e54a84889ae23ae3a0329e2b27bda2e139b16b94794c1166ce12fcef47b", + "size": 52363 }, { "url": "https://platform.claude.com/docs/en/manage-claude/user-management", @@ -807,8 +807,8 @@ "url": "https://platform.claude.com/docs/en/manage-claude/workspaces", "status": "success", "path": "en/manage-claude/workspaces.md", - "sha256": "76727e2a928d45415b66937142407eb3bffb1eec50fdcf6bde711bb95b545d4e", - "size": 25240 + "sha256": "7a0a90bd5d8b65479b93e3b76b675be9411dc425dd3b3cb2ac563edb7ffb6fde", + "size": 41956 }, { "url": "https://platform.claude.com/docs/en/manage-claude/admin-api-keys", @@ -835,8 +835,8 @@ "url": "https://platform.claude.com/docs/en/manage-claude/wif-admin-api", "status": "success", "path": "en/manage-claude/wif-admin-api.md", - "sha256": "fb1cc106693f7221864bfbbdd1dcd5b42bb6ec99c125b5f231b7b443ec416710", - "size": 14656 + "sha256": "c07be3aa1af5afd5b7c58697cabe61a63f969f5a3791a4b8893aad759094309f", + "size": 46716 }, { "url": "https://platform.claude.com/docs/en/manage-claude/wif-reference", @@ -898,15 +898,15 @@ "url": "https://platform.claude.com/docs/en/manage-claude/usage-cost-api", "status": "success", "path": "en/manage-claude/usage-cost-api.md", - "sha256": "a27a6eb355e359ae5cecb139fdf8cb6d2af064fc0f2edc47c02c29090dffaf62", - "size": 15905 + "sha256": "127960ac9f6acd66fa03a31ca3f0a4a4409223eb0e4eef4f3300f3855922deb6", + "size": 16116 }, { "url": "https://platform.claude.com/docs/en/manage-claude/rate-limits-api", "status": "success", "path": "en/manage-claude/rate-limits-api.md", - "sha256": "310ed3c11981075bb7a119a9ea176f9ebc74fcea3d0682047b6fbb6f7a40a8d8", - "size": 9340 + "sha256": "f8badd0e8b7474a670b80d0a5581af48f5faf45a11ea6b94b4e67f28b3f2daab", + "size": 27138 }, { "url": "https://platform.claude.com/docs/en/manage-claude/analytics-api", @@ -940,7 +940,7 @@ "url": "https://platform.claude.com/docs/en/manage-claude/api-and-data-retention", "status": "success", "path": "en/manage-claude/api-and-data-retention.md", - "sha256": "3f877d3fb2cfcaf996464093df16054a3bc3bbbda4c4b05afcf0ee1beecf2a01", + "sha256": "7ca331145e18f84ebb4f24f86f921ae7aca30c377d25e34f852be37be5f63715", "size": 57303 }, { @@ -954,29 +954,29 @@ "url": "https://platform.claude.com/docs/en/manage-claude/cmek", "status": "success", "path": "en/manage-claude/cmek.md", - "sha256": "15c8ec736a4b7a523fd16b678cb86781d5e180ebecdb194bc2e88e47adc05efa", - "size": 15150 + "sha256": "22a7206e26f0156e4877881a30317e9432cd80f8417b5bdcb36ffa9ead26fbe5", + "size": 15644 }, { "url": "https://platform.claude.com/docs/en/manage-claude/cmek-aws-kms", "status": "success", "path": "en/manage-claude/cmek-aws-kms.md", - "sha256": "ac2ebe33e1776000f0ea58c2adb499c200576866cf6a8720e85141552da8ced4", - "size": 12938 + "sha256": "afc31be898d9a06bc09e7195f46bc1b299f07d6e0eaddd51f893260faaf5097e", + "size": 23185 }, { "url": "https://platform.claude.com/docs/en/manage-claude/cmek-google-cloud-kms", "status": "success", "path": "en/manage-claude/cmek-google-cloud-kms.md", - "sha256": "e9286ec4fa8a20b2bf2853a0b349031185c09a5b20f58db51ac533a221e3e35b", - "size": 10653 + "sha256": "6b39fe756aef5b8c7d8b09c27da1e1ecf68397dac0784a0a084a8ab513f80907", + "size": 21217 }, { "url": "https://platform.claude.com/docs/en/manage-claude/cmek-azure-key-vault", "status": "success", "path": "en/manage-claude/cmek-azure-key-vault.md", - "sha256": "4e7feb68773ee3d6b0daa0d618cbed212ffbc057d73f4eebec9aaac4fc2a32b9", - "size": 12709 + "sha256": "b4ea1ccd17fa1f3caab264bc9b8ba6a7d2a46357cec870e109f3dd7f4ecfdf9d", + "size": 23695 }, { "url": "https://platform.claude.com/docs/en/manage-claude/inference-hooks", @@ -1003,8 +1003,8 @@ "url": "https://platform.claude.com/docs/en/manage-claude/compliance-api", "status": "success", "path": "en/manage-claude/compliance-api.md", - "sha256": "e65ee6e825b1490845f2340d0ac4d9df7298dab7b8847d1b9b0e8fe750e2e3f2", - "size": 9567 + "sha256": "a27184f1b9b4d912ec3520101a36153be028904c3056c365802dc4523f9ad559", + "size": 9653 }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-api-access", @@ -1024,15 +1024,15 @@ "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "status": "success", "path": "en/manage-claude/compliance-content-data.md", - "sha256": "d79b3923e2387a5ad42381ee45dfb3c35e7fac433035d5b283235c8dd6e3e530", - "size": 22124 + "sha256": "28ebb6413b724bc4a5ce9eefe610c382a9eb9636ae84e8383b3d2af3a79e777d", + "size": 23726 }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-sessions", "status": "success", "path": "en/manage-claude/compliance-sessions.md", - "sha256": "627a9f7f61cc56ead28e4969504bb4c48ea60f6bee6ee55c77a3c68f37cb8f16", - "size": 45463 + "sha256": "c956f02aaf2d5e117a3745d98a7a9c6f510f05de1c19855686c6af8ba38c4d5b", + "size": 49023 }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", @@ -1045,22 +1045,22 @@ "url": "https://platform.claude.com/docs/en/manage-claude/compliance-integration-patterns", "status": "success", "path": "en/manage-claude/compliance-integration-patterns.md", - "sha256": "21bf90e136076c73f2889d01cf5f6c251cf4a2d5c08ad7ae72d702c1c1a585f1", - "size": 16508 + "sha256": "4bd825abdfcd883bcc225fe1b4adb58d06bee30737e631859c5cf8c31b1a9be7", + "size": 17266 }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-errors", "status": "success", "path": "en/manage-claude/compliance-errors.md", - "sha256": "ed621e326249d1a2d1b61037a6e7541e160f9be53c6768066c18127d24ad168f", - "size": 38694 + "sha256": "f7b3e6c64493eb2a465d760af5fa8bc7e29e502daf0b96a7b13b7ebb2b545f4a", + "size": 40121 }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-faq", "status": "success", "path": "en/manage-claude/compliance-faq.md", - "sha256": "1d512bc8029a1daf05d67868232bd51ee6ecdfc2d2003c6b836eef9a1ff43af8", - "size": 24446 + "sha256": "54c82cc1ef7bb523bdc8ced309bafb8dbdcb031d23efed5aea3ef8778444139f", + "size": 25161 }, { "url": "https://platform.claude.com/docs/en/about-claude/use-case-guides/overview", @@ -1129,15 +1129,15 @@ "url": "https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/prompting-claude-opus-4-8", "status": "success", "path": "en/build-with-claude/prompt-engineering/prompting-claude-opus-4-8.md", - "sha256": "9e8bec84126acaf2cdf0ecbcf1b39938646ba124a1c61d5773d75658ebe7149d", - "size": 16542 + "sha256": "56b8a940ef2263d52266a609f00a876ec6388643d7bc2181b5d26cf9c0c43ec1", + "size": 16560 }, { "url": "https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/prompting-claude-sonnet-5", "status": "success", "path": "en/build-with-claude/prompt-engineering/prompting-claude-sonnet-5.md", - "sha256": "d3ae70e7e04d6d308a3de2abcbeeb437850c76ef4b8e0ef0c44bc303748d96f0", - "size": 16426 + "sha256": "c0f4ddfed167b16f8e103dbf7d86bd926a2886b8a30ad307cb5dec6954677453", + "size": 16444 }, { "url": "https://platform.claude.com/docs/en/test-and-evaluate/develop-tests", @@ -1241,8 +1241,8 @@ "url": "https://platform.claude.com/docs/en/models/opus-5/migration-guide", "status": "success", "path": "en/models/opus-5/migration-guide.md", - "sha256": "daa378f6231b7e899febf15773d526386cfcb9a4b1b920b2a405aa046525068b", - "size": 86531 + "sha256": "bba8dd9d5bab05ccbaec99cdcee4dff35204d50b937de700f88b247b37e407d4", + "size": 86565 }, { "url": "https://platform.claude.com/docs/en/models/sonnet-5/overview", @@ -1255,15 +1255,15 @@ "url": "https://platform.claude.com/docs/en/models/sonnet-5/whats-new-sonnet-5", "status": "success", "path": "en/models/sonnet-5/whats-new-sonnet-5.md", - "sha256": "adca866a05f3ca8cd3bf402d9a21941cc67cef992c7d3b637f4c447c47147692", - "size": 13178 + "sha256": "02f0df53f8780f93ca88c9691f530f07032ebd5d41c88ec838fc0f9aa85007db", + "size": 13195 }, { "url": "https://platform.claude.com/docs/en/models/sonnet-5/migration-guide", "status": "success", "path": "en/models/sonnet-5/migration-guide.md", - "sha256": "fc0572dd8c16d0da642a3c61cdf78a9e8b14ee9675a03c0a479aa0e0345b2a98", - "size": 34558 + "sha256": "319844cc38694e9426c68bab3a6720c3ca0526b749d346208e9d097a9997c1b2", + "size": 34575 }, { "url": "https://platform.claude.com/docs/en/models/haiku-4-5/overview", @@ -1612,7 +1612,7 @@ "url": "https://platform.claude.com/docs/en/api/overview", "status": "success", "path": "en/api/overview.md", - "sha256": "813ac771c0ceb63d13b1876338b1a79310326e7f200b6925eaa3c8ef5dfff2e0", + "sha256": "eaee208df97b7e2eca5a37ab100a12e7c3dc1d4f2d9cd99b514e28f7062d9b9f", "size": 19546 }, { @@ -1689,22 +1689,22 @@ "url": "https://platform.claude.com/docs/en/release-notes/overview", "status": "success", "path": "en/release-notes/overview.md", - "sha256": "60332e0a005c94b7a30dc729176292a896b3183529bb4dd349c5c2d7797f059f", - "size": 93253 + "sha256": "b216ad765b853119b602a3fdd93ecb345ac8f6556938277e50a400549eed7539", + "size": 95328 }, { "url": "https://platform.claude.com/docs/en/api/completions", "status": "success", "path": "en/api/completions.md", - "sha256": "63d96bee9305f057c4a829256bb5a914dd2586c26d39049e612438e93503fc7a", - "size": 13001 + "sha256": "22f365b48564434e0f7a9f1f393b44048102d8d1d3b75fb68afeb3bdbfa99774", + "size": 13264 }, { "url": "https://platform.claude.com/docs/en/api/completions/create", "status": "success", "path": "en/api/completions/create.md", - "sha256": "8888ecf090d0648dd73d724504bd52f9e65f01f19683bc14982722f7fe99b686", - "size": 10398 + "sha256": "cd9ca573e4f2b083eacc3e03521621e0af0e8c3b3edf64361cf0076a7878d50c", + "size": 10661 }, { "url": "https://platform.claude.com/docs/en/api/messages", @@ -1780,22 +1780,22 @@ "url": "https://platform.claude.com/docs/en/api/models", "status": "success", "path": "en/api/models.md", - "sha256": "161dbdf8d3cbcdcd5c1a3d9f0e95643dd413d3de548bebd3e7fe1478bb660172", - "size": 21774 + "sha256": "410e806cbac71d88b172021f058f2a4e8098ce1e74f0e8d70b8b58eae932ab4b", + "size": 22300 }, { "url": "https://platform.claude.com/docs/en/api/models/list", "status": "success", "path": "en/api/models/list.md", - "sha256": "46e73cc0befdbb61e84f53af00c360ec6db60c8c9456cf22509a75f873ad8326", - "size": 7488 + "sha256": "4f4933230f01febc0a7374d0400c6e91e8fd88158c1de7c6533fe8fee4223b77", + "size": 7751 }, { "url": "https://platform.claude.com/docs/en/api/models/retrieve", "status": "success", "path": "en/api/models/retrieve.md", - "sha256": "c7eeb61a5318c29156399cebb873a8502eea0900cb57776de034f52ccfa68a82", - "size": 6366 + "sha256": "6ba36e6a33be24a05aef968d4d28092dc513aca5e43980d082bb9aedf0296f44", + "size": 6629 }, { "url": "https://platform.claude.com/docs/en/api/files", @@ -1843,8 +1843,8 @@ "url": "https://platform.claude.com/docs/en/api/skills", "status": "success", "path": "en/api/skills.md", - "sha256": "acde27c92c4be09bc34bd380db4389a044371eab3e7887e140ec9cf1a6eaef7c", - "size": 18571 + "sha256": "d30631d95c4d969cd4f1ef29d0b123613ad76e03966fc9d1aaca8a182a56444b", + "size": 18438 }, { "url": "https://platform.claude.com/docs/en/api/skills/create", @@ -1878,8 +1878,8 @@ "url": "https://platform.claude.com/docs/en/api/skills/versions", "status": "success", "path": "en/api/skills/versions.md", - "sha256": "c78d7bcb752e5fdd48eff3901562ed90ae91281e0151acdb5768b936aaf6b67e", - "size": 8560 + "sha256": "88c0eb8d0489af58246c3deeed02d535ee54256c4671501448d49f20d15fffc6", + "size": 8427 }, { "url": "https://platform.claude.com/docs/en/api/skills/versions/create", @@ -1899,1044 +1899,1548 @@ "url": "https://platform.claude.com/docs/en/api/skills/versions/retrieve", "status": "success", "path": "en/api/skills/versions/retrieve.md", - "sha256": "0db72420d3aa5a8f1c5c226a3319546bd40d0dd228242bb1e657b189354e0c78", - "size": 1916 + "sha256": "b09f2f9bddf2e87cf35f280ef554a067e23db33c3efe4e641f3f0102be2c6633", + "size": 1878 }, { "url": "https://platform.claude.com/docs/en/api/skills/versions/delete", "status": "success", "path": "en/api/skills/versions/delete.md", - "sha256": "7dea0ecc3fbc4063b62801db8b11d083eb2ab82e846523752c6aa21ad7b906a8", - "size": 1160 + "sha256": "cd7760fda0ed620b52017aa2a567ba7aa206511c821953920d87258dec533984", + "size": 1065 }, { "url": "https://platform.claude.com/docs/en/api/beta", "status": "success", "path": "en/api/beta.md", - "sha256": "2c319a666f96b13216bd027dd338c4730b1a594e729eb21706e759142c353337", - "size": 1786942 + "sha256": "eba0e5d593c95d542b1216f2807530e8370071bf037a440681cbb67d36cd3116", + "size": 2072483 }, { "url": "https://platform.claude.com/docs/en/api/beta/models", "status": "success", "path": "en/api/beta/models.md", - "sha256": "5b412eb04a384cc17b874f3af4623b3bbff50db832f28386919dc842ccb5c660", - "size": 23014 + "sha256": "0112b63e12047445f069ccbc95b904715035b4772e5297ba13f427563b1afd57", + "size": 23540 }, { "url": "https://platform.claude.com/docs/en/api/beta/models/list", "status": "success", "path": "en/api/beta/models/list.md", - "sha256": "10405373610d5db64db15dd982e81e84caf97d2ca1be01b22e415437c88884fc", - "size": 7862 + "sha256": "5c99b9e67021c76f494ca1a327407b2052a3e7a79f57c20c82ba2298e9eccab6", + "size": 8125 }, { "url": "https://platform.claude.com/docs/en/api/beta/models/retrieve", "status": "success", "path": "en/api/beta/models/retrieve.md", - "sha256": "ccb92b551a017f9ee5cf8e72d1e1765b09a183f614eabdc4194cca0a9af610fe", - "size": 6728 + "sha256": "f22816c98fc6e58aa2418c99bd2d23cdccd90d641b17f2fc44e8b9758a339d7a", + "size": 6991 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages", "status": "success", "path": "en/api/beta/messages.md", - "sha256": "8870e3b75cc0692ec71dec8f318d7bbbc25f12b63524633680086cc9949926fe", - "size": 1290006 + "sha256": "b142d5509e6b294a40da4abfd77e48d2ff7a0d26827352b68899a1b3c9f1095d", + "size": 1303109 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/create", "status": "success", "path": "en/api/beta/messages/create.md", - "sha256": "9346fc904819b2e368d497344ad7fc730d9d68844e0156a64fc6e195fd0dbd8d", - "size": 184638 + "sha256": "af7660172cb21c51aef854876cb91213cb438097c41c396f9195ef7801c162b1", + "size": 186885 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/count_tokens", "status": "success", "path": "en/api/beta/messages/count_tokens.md", - "sha256": "dcae7fa3ba638166069ef54b6610c84a88a3d5b45c02d4cc44957a1dbdee1b5d", - "size": 118224 + "sha256": "54834836b3e6d4d2b92c78178a84e5c409ef0b341d04ad1c84011317ab89885a", + "size": 118555 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches", "status": "success", "path": "en/api/beta/messages/batches.md", - "sha256": "a80ae942c3b00ccc813e1eca7b145cb22e618034d5c8da3c18dd3961e5834958", - "size": 381799 + "sha256": "41f57319e354681806aaf672c4e95403a23531ae9283b817ac7efa4a33de7719", + "size": 387291 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/create", "status": "success", "path": "en/api/beta/messages/batches/create.md", - "sha256": "499c612557c0736f8a729d2bc7c6c2bd12d0c3cf0694975d166607102c00412a", - "size": 138933 + "sha256": "f152272a15c6a19ff0e18a9858930b67500235826394d96f9832f3342dcf4463", + "size": 139280 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/retrieve", "status": "success", "path": "en/api/beta/messages/batches/retrieve.md", - "sha256": "7757ccd39b3fbb01730401e0cca958433527bda29cc5327b739d8d89ac882c25", - "size": 5866 + "sha256": "68ce51bfd2fe3a7b5107e149e1ce2c3e978f0689c2202dd47bc04a826fe9bdba", + "size": 6129 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/list", "status": "success", "path": "en/api/beta/messages/batches/list.md", - "sha256": "72019d8e58edd8f0bd59722452ba4c0ab9ce95990b0b4f7b935a9ee84ba60cbd", - "size": 6649 + "sha256": "94ea88cc7ef470128b251f7e5b05fa5e8324cc6d48124bdd970915876c85b23d", + "size": 6912 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/cancel", "status": "success", "path": "en/api/beta/messages/batches/cancel.md", - "sha256": "355702ed1157a3335a7f8fce6fb9496ac8e39c0bf67dd8544aa36628b7928891", - "size": 6203 + "sha256": "6690bd666d3c3b7f0fcca395de0f74bb93198dc5f3bb8fe700ed0d74f7726bc1", + "size": 6466 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/delete", "status": "success", "path": "en/api/beta/messages/batches/delete.md", - "sha256": "766ccab02f2b7fb096f74b2a4127d01b40928a29a6ad730f604cf437e6c25c6f", - "size": 2611 + "sha256": "cc52df006079820d3da43a02a9977c29c33e161d2a3c18ad8a49a34bb8a0363e", + "size": 2874 }, { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/results", "status": "success", "path": "en/api/beta/messages/batches/results.md", - "sha256": "45ab18826ecc14779e0836c1bb4a0be4c22fabe91866b54a434afec50faed4a3", - "size": 57652 + "sha256": "62ca01f0bcf2decb208aa16b4e4952c61214847c796ad4a3c6e83f59f6299004", + "size": 58874 }, { "url": "https://platform.claude.com/docs/en/api/beta/agents", "status": "success", "path": "en/api/beta/agents.md", - "sha256": "7c5928eec51170589613edfe7c88de17d7a2b1a1e57028d721ff82ac5efecee2", - "size": 246743 + "sha256": "57863b614b25c6459590dc53a75be9d38efd3216840d0e17ae54345bf9307408", + "size": 248321 }, { "url": "https://platform.claude.com/docs/en/api/beta/agents/create", "status": "success", "path": "en/api/beta/agents/create.md", - "sha256": "90889b09da5e838ce08fe7fd64dcac776accd8e6be9db16a7994a1288b4b566a", - "size": 38252 + "sha256": "2dafc53332b8daf0fe590fd3e1a4a68a96bdd1dcb985136822da56cd18c0307e", + "size": 38515 }, { "url": "https://platform.claude.com/docs/en/api/beta/agents/list", "status": "success", "path": "en/api/beta/agents/list.md", - "sha256": "527d1851c91f2e7016c9159139ca9298a77d60ee81bf4c991ae9d5db6dd2bed7", - "size": 18017 + "sha256": "2a763002a2287edf4c587f1a4066047269cd9b35586ccd422259a906f5515a84", + "size": 18280 }, { "url": "https://platform.claude.com/docs/en/api/beta/agents/retrieve", "status": "success", "path": "en/api/beta/agents/retrieve.md", - "sha256": "c4f694594bc53eaec62f1d0c8039caf6f76599d3b120e5042279b3e701ac371c", - "size": 17250 + "sha256": "10db5a8eb0350e3dd94e3d20a11ccd2cf4ca406907b8f39597789477774f4818", + "size": 17513 }, { "url": "https://platform.claude.com/docs/en/api/beta/agents/update", "status": "success", "path": "en/api/beta/agents/update.md", - "sha256": "ba8ec71b7938cea9afba87e0113f0e78f8f783b29bdc68954a7eea2cbe0d2610", - "size": 38863 + "sha256": "38a4aa3fc2770108a9fbe8004e5029fc1cc1a101d6b28989b6430ca73d55f045", + "size": 39126 }, { "url": "https://platform.claude.com/docs/en/api/beta/agents/archive", "status": "success", "path": "en/api/beta/agents/archive.md", - "sha256": "cf3791c21e8b4fd8c2b994ad156bda6a9a13f79b7f603bfd97097243c0c49b87", - "size": 17136 + "sha256": "d79864c2b2c78c14c8f53f74d280d22a2a09173572864db5b5d3f11c2b8063bf", + "size": 17399 }, { "url": "https://platform.claude.com/docs/en/api/beta/agents/versions", "status": "success", "path": "en/api/beta/agents/versions.md", - "sha256": "7e5fab63582a9af9999751c7409d4cd734703125493fd9579e0d096d5728a0b5", - "size": 17767 + "sha256": "28e8f4e7f701f6ec3ead7ad6e1cd18e5b2643c66c773656c3c6f9efbe6d660a9", + "size": 18030 }, { "url": "https://platform.claude.com/docs/en/api/beta/agents/versions/list", "status": "success", "path": "en/api/beta/agents/versions/list.md", - "sha256": "8be63017f04204ceb9a1a54f40f6318bfbba1814f1177539978405d9700480c5", - "size": 17748 + "sha256": "25e857df4a182bd75a7f6a7250f847ca222e0fce3e537410362d6bba3f15817b", + "size": 18011 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments", "status": "success", "path": "en/api/beta/environments.md", - "sha256": "bc68465287b37fce8338057911a231f37f63591039110450ddf782c8b7d02b32", - "size": 83753 + "sha256": "82a83dd40fac5b3546d94da525e6d0d497e8a82a215efc607e8337adebaab675", + "size": 88037 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/create", "status": "success", "path": "en/api/beta/environments/create.md", - "sha256": "8a0f360f5a2cc1b897a2e05e98e2e9846abffcf42f710369cde3f50b454295d7", - "size": 9452 + "sha256": "e40d3cf6a686ddac29faa457c6a971a109b3140c97bc2c75134ca0c8a9ec37cc", + "size": 9867 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/list", "status": "success", "path": "en/api/beta/environments/list.md", - "sha256": "0cde47b4073317df53fb6c5c5ba40e79eab23b468fd9148c2e686fcfb87a003d", - "size": 6393 + "sha256": "502a1d34635247ca18a889ddffbe768eb947b7430d0749843a4b7e91132f5618", + "size": 6656 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/retrieve", "status": "success", "path": "en/api/beta/environments/retrieve.md", - "sha256": "9c3fe8d633d58b7cf7a9d17e20c69bb0ed0132e4af938960ba76bef27720d901", - "size": 5696 + "sha256": "6c8d854cfef202ca9a1259f14e5838a27d106c56346ba68639644e79165c60ec", + "size": 5959 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/update", "status": "success", "path": "en/api/beta/environments/update.md", - "sha256": "16aa2ce845bf0dae74e44be4cfb3024ea770d3bd76ed90af2bb75b28c6847144", - "size": 9140 + "sha256": "1fe6df4fa3626acb124c5e6fe938613ac9ed3f4679b615dd4622576d384912f6", + "size": 9555 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/delete", "status": "success", "path": "en/api/beta/environments/delete.md", - "sha256": "6642445c148de39dbfee857205b5b66feb2631a7c6b4ca49552054a5b7d65831", - "size": 2300 + "sha256": "11acb92ae33934f002649f8091b21619633222ec23f3381dd456faccec871bb4", + "size": 2563 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/archive", "status": "success", "path": "en/api/beta/environments/archive.md", - "sha256": "ff605c0dbc3ecbb668f4c88a79898c9de5b936efb75722bf1f194fbb8a0c11fc", - "size": 5783 + "sha256": "1c29283860c0ad6cf7be42e269c907097c32ad32dd9eff488ae0412840cd902c", + "size": 6046 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work", "status": "success", "path": "en/api/beta/environments/work.md", - "sha256": "80d38c2eea7f517f517317e3cbf18bd8350428b344cd5747c0e1e544d59b76af", - "size": 40683 + "sha256": "dc7f0799752f4d7ee36bee985495cded147cb09524c4abf18d10d7671ad07fdd", + "size": 42787 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/retrieve", "status": "success", "path": "en/api/beta/environments/work/retrieve.md", - "sha256": "f5958e959b81ed1fb14653b3dfd5d9e42ee3259ce32ab4dea68a8d920cdebeae", - "size": 4464 + "sha256": "a8c741fa5fd362773caf6f73128bda0297d50b7615b2ff523da89cceda753078", + "size": 4727 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/poll", "status": "success", "path": "en/api/beta/environments/work/poll.md", - "sha256": "ee447b5702596e44425119abec3a209a163006c29a4ac096ba16522a1dcc9384", - "size": 4975 + "sha256": "a524f01a61da639e64668dc90622a6671019f9e4b52054026c2fa82675889bd3", + "size": 5238 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/ack", "status": "success", "path": "en/api/beta/environments/work/ack.md", - "sha256": "46163c01e0a10b358b1ec692dd41347e124821c941706c1db9d753dd702b8b17", - "size": 4545 + "sha256": "420643fc21a5ace41b8bba31ef554804ab03c1215444ad174f2d27177ea5ac49", + "size": 4808 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/heartbeat", "status": "success", "path": "en/api/beta/environments/work/heartbeat.md", - "sha256": "c832516c56140bff1e21a241875eda509a3e113fe3f48689bfbd280bdedca3e2", - "size": 3533 + "sha256": "44773e8dc09e9a27ae940f739f5a4b1a734742eaa2c3a0547b242c6870242b60", + "size": 3796 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/stop", "status": "success", "path": "en/api/beta/environments/work/stop.md", - "sha256": "906db0cf67bfc79b9a20c09591a6f7fa6ffff07d74b9a6e61672f7819a2cd103", - "size": 4654 + "sha256": "d80e92a144b6d62205fc5ee0e6c660f73426cab6d8d30da1f9b0505907373ed5", + "size": 4917 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/list", "status": "success", "path": "en/api/beta/environments/work/list.md", - "sha256": "a256aea5c3a3b876f413a45cf30136c6c3ff28fe48c944bcf1a9cf9abbeb08fd", - "size": 4794 + "sha256": "98d3735f4442dc57821a179a8c611166d3ca4e122fad6d8f30ac18ed00187bba", + "size": 5057 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/update", "status": "success", "path": "en/api/beta/environments/work/update.md", - "sha256": "dfa4f08382ad511001062c7298377fcfac296deda8502f0ab0847786deffd7c2", - "size": 4760 + "sha256": "40de75b48ea94f7cd18d5a7ff064ed43ce4a98fb862840a87a4af976fd7fda8c", + "size": 5023 }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/stats", "status": "success", "path": "en/api/beta/environments/work/stats.md", - "sha256": "c9bc76253c437f6338aef45c08d5ee2d60893c6918d29dfe7471313b56793b8e", - "size": 2895 + "sha256": "ee5d55d129efb617fb0478e0e2934dc2043be07c064737d165a3d1958ed234da", + "size": 3158 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions", "status": "success", "path": "en/api/beta/sessions.md", - "sha256": "48a913d266da98403dbf41cffc61b925297021448e9840f593b2dcf9e8579f2c", - "size": 709347 + "sha256": "d9ac5362487cc14733dd1283b875dbf1735dc58c5309ce5940d07a199c85a8f2", + "size": 714641 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/create", "status": "success", "path": "en/api/beta/sessions/create.md", - "sha256": "6dc90a6b25733a43b18fe890611924e50efb144396c269bf1901096be774fda6", - "size": 59774 + "sha256": "88bdd56f18b845dd6b56c31c2238b6744f3fe0677b22b6b58e7d9260fc3b7d4b", + "size": 60037 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/list", "status": "success", "path": "en/api/beta/sessions/list.md", - "sha256": "c9edf6fbf07e723dccdd6c9fedf196fd73a07f1de56321efec490c3f79e054f7", - "size": 32778 + "sha256": "f13884581af59a3c8545467d93c10b12f0fd5fe6b4fc4ad034502ead4bb4c3b9", + "size": 33041 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/retrieve", "status": "success", "path": "en/api/beta/sessions/retrieve.md", - "sha256": "da803d80c23693c6d06f87fa29551092c31924fd465c9da6e20f9d5adc7f09ef", - "size": 30105 + "sha256": "a0d0af0205d3044c5cbb42d7f4036d595e33014601cbdf25e1ce6bb972a2b63d", + "size": 30368 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/update", "status": "success", "path": "en/api/beta/sessions/update.md", - "sha256": "d775ef7bb936b5f8911a7b43963332ab0c3cb47c17f7e1e93f072f147d7d2d99", - "size": 45236 + "sha256": "c2789678220be5a23e2421f37e06f7175126d4dc3c168cbc067c2623bb5d55e4", + "size": 45499 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/delete", "status": "success", "path": "en/api/beta/sessions/delete.md", - "sha256": "ce73abbc5f2fd8a4369cd90e0467e16a00a393bfe01d0468c1fc77de424f50f4", - "size": 2149 + "sha256": "e17074689dcf118c75bb74a33799efaf1af46686d34b2b266316471245d61df0", + "size": 2412 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/archive", "status": "success", "path": "en/api/beta/sessions/archive.md", - "sha256": "cbba0a413835dc62c7ff00412edaa2565f0f622d481b43baa6d9b77376dd6bae", - "size": 30144 + "sha256": "c59ba605bb4cf3768d4248c49b2adda23c326c307cc3ee686798e7e589632bc8", + "size": 30407 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/events", "status": "success", "path": "en/api/beta/sessions/events.md", - "sha256": "54ee5196642af638cc22ab0cb6fcd99e45f136927df5d1f2f0db3d91a46a67b9", - "size": 404221 + "sha256": "99855359220b1ef4de0e54ca6e52f3731a3061d05c704c31eaeedb5cbf62ebfd", + "size": 405010 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/list", "status": "success", "path": "en/api/beta/sessions/events/list.md", - "sha256": "d5e385536967f5cb0b1132937cc53cca93de99e9282c0a86189522bf43fe87d3", - "size": 66377 + "sha256": "3c36addb20e9c16942499c7f20d6c7959c1f183551b429f2a47a12062855bac7", + "size": 66640 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/send", "status": "success", "path": "en/api/beta/sessions/events/send.md", - "sha256": "fe559f9bfdded9d4921cee28420df967dd41c2aae65cacc26c77e204a278a529", - "size": 25057 + "sha256": "a1ccb3a964c8623cbb09928ae31f419fdf2c2563ad18d305df00202de3c99ecc", + "size": 25320 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/stream", "status": "success", "path": "en/api/beta/sessions/events/stream.md", - "sha256": "c0854969e4f1e351729de4fac769d9fbfe62e081ac736e11e4c6543714a5af8a", - "size": 68490 + "sha256": "73aa967aee0cb02934bf4a9bc61ff000b995998c26f67d65a12840e70f0c70e9", + "size": 68753 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources", "status": "success", "path": "en/api/beta/sessions/resources.md", - "sha256": "8774c07aeecc84e4caa6489199a7a692ff0662ea57ec5f4f5a582064711b1d4c", - "size": 30299 + "sha256": "3cfd29d8b541348f2bf701611522d2dc4161727494e6d618ba26325c408894a5", + "size": 31614 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/add", "status": "success", "path": "en/api/beta/sessions/resources/add.md", - "sha256": "454bc6c4ef86c91044c3c7395aaece0da3182fc37ca89fcbff164306655029a2", - "size": 2935 + "sha256": "fcb3c0b2e87f022c6bda07a5d9de856d63605ebb96d1a5a604801249e7960e31", + "size": 3198 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/list", "status": "success", "path": "en/api/beta/sessions/resources/list.md", - "sha256": "9532b3c7f3f9e014d94f1a299409b7b68450c4a813a6485a6cecfe8d80e49f64", - "size": 5433 + "sha256": "3df6b3d94ab28f165ef9a3221f7dff7c01ddea8f36943deb4c7c8ec91c387b73", + "size": 5696 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/retrieve", "status": "success", "path": "en/api/beta/sessions/resources/retrieve.md", - "sha256": "04cba94e9e4d54c52411b02d1a8722171499b7a37f1f894a54be067835d48460", - "size": 4534 + "sha256": "f26498999a086416bee18eec3513563247d03add29c8e15d58d39475c3291825", + "size": 4797 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/update", "status": "success", "path": "en/api/beta/sessions/resources/update.md", - "sha256": "301faf92060a3a048ed9253717a44b656b3cdf9c9a6c9747a2dbc51be1840c07", - "size": 4858 + "sha256": "8a092cee0ad834340fe602077a8debc5569457540b3096b31116dfa671562546", + "size": 5121 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/delete", "status": "success", "path": "en/api/beta/sessions/resources/delete.md", - "sha256": "a26dee1bac2c106b2095f332203485a7528d5b1a0eb45ebc3d4f081073c63ef3", - "size": 2241 + "sha256": "fa87b496f584cfb3b1e1fda08565617bbb0d80919cfd7879a4777effbeef5637", + "size": 2504 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads", "status": "success", "path": "en/api/beta/sessions/threads.md", - "sha256": "487fc7a962035eb4615602afedc38e70205065e35f370a9b7912d600d95c591b", - "size": 284620 + "sha256": "d6bb60beeb37a52fd6c567352e2706c8e368cf528c5fca99ba35107e19e543f3", + "size": 286331 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/list", "status": "success", "path": "en/api/beta/sessions/threads/list.md", - "sha256": "bf4f710bc20ec7071235c029f53aa317bc6ed04c1c432e82833ba8b5a26db1d8", - "size": 22073 + "sha256": "41ad5c8f7b216485dc0a45401ba102f4148df62edf3334e60af29018c68a2673", + "size": 22435 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/beta/sessions/threads/retrieve.md", - "sha256": "e64b897408fb7e388ff9225a2332f38e998c1b43e34a457ba561c32f4750506a", - "size": 21435 + "sha256": "f5dc6750597cc7b7a7b4f78b08c964ff5592ff6a44d5237bffd7f013c124ab5d", + "size": 21797 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/archive", "status": "success", "path": "en/api/beta/sessions/threads/archive.md", - "sha256": "d69814dde334212f903bf849310eda571c45e2a5627f8ae67c76f5c5e06c0f1d", - "size": 21474 + "sha256": "5ddeb30542a959b7272d95511e5ab3fea79c75a7d8516223e128b8a9a032d567", + "size": 21836 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events", "status": "success", "path": "en/api/beta/sessions/threads/events.md", - "sha256": "c198056541a8e314cdd15d460950ed181f3fd12b95fab5ea6b672a73f96ba44b", - "size": 133721 + "sha256": "63d79c8baacb366ee72930f586b0ecf0240a84b8a139e7e7e4361a3107265816", + "size": 134247 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/list", "status": "success", "path": "en/api/beta/sessions/threads/events/list.md", - "sha256": "86cfe2cb8d5116b113a7424fb611e42ba6d4e858cd07d175e7b9e51cf415093f", - "size": 65104 + "sha256": "a6a70cdd96e4ba69c2e25cc709ed12ca01a6bc1d500ba8e5e0631ea4d30717f5", + "size": 65367 }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/stream", "status": "success", "path": "en/api/beta/sessions/threads/events/stream.md", - "sha256": "7705217bc21d3a3a534dc859c4f761ceb97cc98143f60b2a327edb28a3915560", - "size": 68592 + "sha256": "2caea13ee2f9eec89a84bd3e5cc9c3ce3f2f8370094aaee99060d1ea3e7eb775", + "size": 68855 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments", "status": "success", "path": "en/api/beta/deployments.md", - "sha256": "3b66c9b375db9b35c79d9770c0e7337e825210e62989613f7249b94050076ca0", - "size": 206610 + "sha256": "13d1fea3a2ccf1f4e2dc8e1dc2599e23df654036d2f4aa19b229532c8b7efa8a", + "size": 208714 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments/create", "status": "success", "path": "en/api/beta/deployments/create.md", - "sha256": "f682cdde8e5f8c7c3383841cf10a329ed4e3c49521605462af887c19840d744b", - "size": 28745 + "sha256": "61e8a3f55481b4c20e3f2a728a4ef148e1531700f356f20a8aed1fef64f246d8", + "size": 29008 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments/list", "status": "success", "path": "en/api/beta/deployments/list.md", - "sha256": "c1e77843ef8847f33c1dc6217a5750ad949cbe74da22187cb820134e876f9c88", - "size": 18583 + "sha256": "99bf6c743bd20a1142e05d7b63b95ab85a67e7c846cddcbb10f513c95c4251f0", + "size": 18846 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments/retrieve", "status": "success", "path": "en/api/beta/deployments/retrieve.md", - "sha256": "5a883442e3c57977eb0aabbdf7ffeebeeeb92868309368788f92f9c6a911542c", - "size": 17558 + "sha256": "5d1454b1847932db7491942cd00bd6c84724b804226af3b3f88c2abba82473d3", + "size": 17821 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments/update", "status": "success", "path": "en/api/beta/deployments/update.md", - "sha256": "97a15f4b8fc12a3f8d56b0727b24fc1fdfbf210ec5c4d02955a8301d79bd66e8", - "size": 28638 + "sha256": "d0977388cc2a9999639e58e07af777851ba0a0c757341356e526da01eaf7a2cd", + "size": 28901 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments/archive", "status": "success", "path": "en/api/beta/deployments/archive.md", - "sha256": "42bd762cc134d0f05200bcbbef2687264bbcbd6adbda27e750c0ce79dfbab599", - "size": 17597 + "sha256": "92b1c3a1e5e45f4daf40b0415f5d9903a739b67c6c33336cb199097aadf2be9e", + "size": 17860 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments/run", "status": "success", "path": "en/api/beta/deployments/run.md", - "sha256": "0c10aa504144ee1db86fd9bf1efa98acbb6c4b2e0a2194d48e240d0eebf1311a", - "size": 7993 + "sha256": "b5133e1bc7d9f4d7f5e2da47a76fa59a25a7735f3778af3eeeb33fb3b4a41eb1", + "size": 8256 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments/pause", "status": "success", "path": "en/api/beta/deployments/pause.md", - "sha256": "7a0bb36cf01dab12f1e51479f216d285241880d8a7e106d1478d481eb9623349", - "size": 17589 + "sha256": "acdae576894933057a075e03699119f39aa9f6f0b6e2b399ad7cfdc0da431151", + "size": 17852 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployments/unpause", "status": "success", "path": "en/api/beta/deployments/unpause.md", - "sha256": "e8aa45a70db135b73a7ac1dc2b5c594d928fbc5f2ec33c0b05373e7640403b33", - "size": 17597 + "sha256": "5fc399bbe2e9ed585f87f19b79332ef01b4886ce90e49e0e6ba892136a62e53d", + "size": 17860 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployment_runs", "status": "success", "path": "en/api/beta/deployment_runs.md", - "sha256": "da839577acf4e879ccee088cee317bc37e8aae29d688642453c9a3f7c81629be", - "size": 28767 + "sha256": "67468199538097eb3e7225df12a6e7599f351e36e1eb47fde48fa9b6c332e162", + "size": 29293 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list", "status": "success", "path": "en/api/beta/deployment_runs/list.md", - "sha256": "9f3db59c27f27bcae7880f36db2fb3e305b13f519cf6ad7e204e98affdc1a099", - "size": 9249 + "sha256": "3d94af2663d6db18485b4e9f824cf758dc3adb2fc5feecc9e7b66609f0b54c52", + "size": 9512 }, { "url": "https://platform.claude.com/docs/en/api/beta/deployment_runs/retrieve", "status": "success", "path": "en/api/beta/deployment_runs/retrieve.md", - "sha256": "72ee3b57bc45d3b54eecc0e1e14c58aa48c03bed527501be7159711f62840477", - "size": 7990 + "sha256": "ddd8e9ef6015c16c52ad34e673b0606607c64da8858ed0419ab691557c4556fe", + "size": 8253 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults", "status": "success", "path": "en/api/beta/vaults.md", - "sha256": "03d5d6d94b82d73b11eb794bc18bdb39421b5e43121e8b28867a927451726dab", - "size": 68514 + "sha256": "eb370ffdc89e6a1b12fcd44d72b3f5c9fcf65c35d7a21487d4ad28ed914c3502", + "size": 71933 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/create", "status": "success", "path": "en/api/beta/vaults/create.md", - "sha256": "c59228e09f1d5add97a156eb506a7038a3268dcdb0c27ff04a9b58a45aa55c3a", - "size": 3151 + "sha256": "0ac53df8d40c8d1640db84cd86779412f701e5532f352afffc7db950beae70bb", + "size": 3414 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/list", "status": "success", "path": "en/api/beta/vaults/list.md", - "sha256": "fc0bae32e05cbbad9715c0c39214ba31f362c33de7716a0b8184bee634442f32", - "size": 3195 + "sha256": "3abacb82eb2d32eeea614689800aa55d6c94cde177a86b630666ff7ce07acd81", + "size": 3458 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/retrieve", "status": "success", "path": "en/api/beta/vaults/retrieve.md", - "sha256": "89b92916707f84a0ae764b903d0904418ce4c0fb83a9d7ab96c35e29bc21d329", - "size": 2734 + "sha256": "be10f99d487a4490f20baa1cd71cd28a1705a48b17ce0bd792af5fdc3dc6a531", + "size": 2997 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/update", "status": "success", "path": "en/api/beta/vaults/update.md", - "sha256": "2c5bb608ef42828e086547d960c4fcf463dfa862a7cbda517a61c05a9391787f", - "size": 3236 + "sha256": "98d4b9c672066c145ae6ff6109e5a286d1bf6311b5abddbf9d2fd9e3d4d3aebd", + "size": 3499 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/delete", "status": "success", "path": "en/api/beta/vaults/delete.md", - "sha256": "e5da8f5a8f2fdba505e05a5c192153de8285e59a26a058d722c4c32ae017695b", - "size": 2146 + "sha256": "773128e05b7e891e21818d5275923d6bbc794bf2618e799d5401ef28cc797208", + "size": 2409 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/archive", "status": "success", "path": "en/api/beta/vaults/archive.md", - "sha256": "da15511f4b959e8a47c9bdeb6a6be34b42cc8aefcb5d6f4185dd4d875d76e62e", - "size": 2773 + "sha256": "e29effe7ce3867a01b2999ded34ab43b5410ddb08db1d551c92920449250b651", + "size": 3036 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials", "status": "success", "path": "en/api/beta/vaults/credentials.md", - "sha256": "c266dc6a4bcfe898e5fc49b590dc44db6d0dac472b82c0cf61cb297866266e9e", - "size": 80233 + "sha256": "325c5151f6ab14186d6c7b75073676faba917ce081287d268bc85f8251fdac02", + "size": 82074 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create", "status": "success", "path": "en/api/beta/vaults/credentials/create.md", - "sha256": "d60d6d6ecf49ce36f7e30ee5e979da03106a131d3af3dcf700657880439f2fa6", - "size": 11813 + "sha256": "ceb78abdbb53707977e4f01c87401811c84da217bdee2009dbe57670734657b3", + "size": 12076 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/list", "status": "success", "path": "en/api/beta/vaults/credentials/list.md", - "sha256": "ef430b4d42f925f4491bb47058ee6f62b792b35473b4193dcff58ecfca914869", - "size": 7196 + "sha256": "d4d795a2d133db3e35ca32d2cffc482b245c51e70140af01da93eef6b74a298d", + "size": 7459 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/retrieve", "status": "success", "path": "en/api/beta/vaults/credentials/retrieve.md", - "sha256": "17f8c39a9775b52b4982db9d2effc91227c4976d0e66f7e70fe3c110025744d9", - "size": 6705 + "sha256": "555ea36af79a5baba0670010b943a47dd6ecca189bfc0780f26e0d2315063347", + "size": 6968 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update", "status": "success", "path": "en/api/beta/vaults/credentials/update.md", - "sha256": "a3c14145dc0ebd495bf311f035c7161bfd969a2471020955428210759fe773a2", - "size": 10952 + "sha256": "eca9754b8788864d7cf694188f8432947b8f17a3472b42203e3382c74be20b18", + "size": 11215 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/delete", "status": "success", "path": "en/api/beta/vaults/credentials/delete.md", - "sha256": "1fc686869349252d5b23d025cc3b484a0464698699678cf6c43cab86caa23fdb", - "size": 2276 + "sha256": "e16a938fecd62bc222a2007264292c539704f39442a09a13e29f5238752fcb6c", + "size": 2539 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/archive", "status": "success", "path": "en/api/beta/vaults/credentials/archive.md", - "sha256": "55fb769b4b607cb20716a691beaf6bee17d90dea21ff540310589ff1cae4dc48", - "size": 6744 + "sha256": "0c47c0dc7c56cd31fc1a6163e069cfa3738c17f1587da52e404105eca93b41b7", + "size": 7007 }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/mcp_oauth_validate", "status": "success", "path": "en/api/beta/vaults/credentials/mcp_oauth_validate.md", - "sha256": "8b1cef4fdf7340e082a4deec105b02af3484cb047410af252dcff92f520d23b7", - "size": 4560 + "sha256": "fe7f00927eeefdd17222fcdb2bb08ba70f920f08e47590fc8877b5ce13592436", + "size": 4823 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores", "status": "success", "path": "en/api/beta/memory_stores.md", - "sha256": "90d7d82f06b8f64467ae70b9c15e6d89c78f3bff4fd5a808b89a7b70de2c8595", - "size": 71706 + "sha256": "94bc551aeb803da9acc052f3e96633b55302340bbf4e21fda4a89e43a04fad55", + "size": 75881 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/create", "status": "success", "path": "en/api/beta/memory_stores/create.md", - "sha256": "9e3b8b74821c678fe012315e0df82776a6c9580c176fa29ced43d3d41f3770c7", - "size": 4384 + "sha256": "063898aff386d8459e080790562832aa015897521d2a1f12b0496623ca55f54f", + "size": 4647 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/list", "status": "success", "path": "en/api/beta/memory_stores/list.md", - "sha256": "4dacbb5ce607fca7f85a3a733f4636073442e8e811d1f6546fe79b878899b37c", - "size": 4556 + "sha256": "441abbc7523b3b9c37830138cc20277810f6094726d7b661d7815f113082e8a4", + "size": 4819 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/retrieve", "status": "success", "path": "en/api/beta/memory_stores/retrieve.md", - "sha256": "a9b8cb2b895bcccaf00b4e457f5d5c6397a9ef1f02768fb4be526f26c184103a", - "size": 3592 + "sha256": "4b459f4aad4a16298eb6ac4b43762d265bb42ce64c1df9a078033e50651c0f8f", + "size": 3855 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/update", "status": "success", "path": "en/api/beta/memory_stores/update.md", - "sha256": "d464362701627e8c603e9d0ce4fd805fc92974c0b265eb2d83a3a3857bdad8ba", - "size": 4307 + "sha256": "6875f800093326844779c881d4bad83c615f6adeb5ec4eb2ce1d708d477268b2", + "size": 4570 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/delete", "status": "success", "path": "en/api/beta/memory_stores/delete.md", - "sha256": "3356bacb5902062c2ff0bbb4fe5c580f6076fc3ae3c911478f58beec2d6283a6", - "size": 2299 + "sha256": "8442e1bff6d102b992ab301d44522c72e1718ace6445a52c492eeadf6b51787f", + "size": 2562 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/archive", "status": "success", "path": "en/api/beta/memory_stores/archive.md", - "sha256": "644ab7914dbe2ffb94e2ba26f5a386ef5c1ecdaa3738cae81cd153c310f8cb9d", - "size": 3621 + "sha256": "57780de8f54b521a662e81eacbf8dfcec98e4fa3a29ecf1d1c0db8a26c796cde", + "size": 3884 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories", "status": "success", "path": "en/api/beta/memory_stores/memories.md", - "sha256": "05f415892a78c3a227e5676f2a1e9da516e0df1c592a9611990898f4b1b0b198", - "size": 36538 + "sha256": "aaa17c3fb1ec61136e7df4220ab09c833cc1a72943d79985c2dabd6c641c862b", + "size": 38095 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/create", "status": "success", "path": "en/api/beta/memory_stores/memories/create.md", - "sha256": "76929419422b185486f1266e952af3c8de8d4462e129b891d853c714807a817f", - "size": 5160 + "sha256": "44668474d331456c54d08bdcc08683f4d04d0c806689da1db4ce34a5573f7bc6", + "size": 5418 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list", "status": "success", "path": "en/api/beta/memory_stores/memories/list.md", - "sha256": "f990f8a75b1ecb9aa17e75597e50cf7483280d6cd179ed79112aa259d25bc32c", - "size": 6814 + "sha256": "cee259c1796a8f18a2e4735f23686cd613079d98273c7b50169f6eb07399ac3c", + "size": 7072 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/beta/memory_stores/memories/retrieve.md", - "sha256": "709a292ee3c1e22b98a1699a4d466b49fe70f6e808bd99bea15d08eb858847c8", - "size": 4557 + "sha256": "f52d03958bdf1c9f0446d219fb9e58a9b5001c0c5e47304d6dc06f4c19b134b0", + "size": 4815 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update", "status": "success", "path": "en/api/beta/memory_stores/memories/update.md", - "sha256": "777e9780991ad7bae3034201b60c0ff4b9cb704d5920960998eb35deba6d1858", - "size": 6061 + "sha256": "fe71c675eb0736df259a73368b846f2dc51cb4063ea5c26f3135f1b805658404", + "size": 6319 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/delete", "status": "success", "path": "en/api/beta/memory_stores/memories/delete.md", - "sha256": "84abe378baf4df98195536e39833ab895e897be735dc41e4996fbd26f503255d", - "size": 2578 + "sha256": "28b894e117202b8ec5656b2aab37a1caf21095429e10de1cac1113791c45308a", + "size": 2977 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/beta/memory_stores/memory_versions.md", - "sha256": "e5659fd3a8f9340488110d2f5d74344b87e7cf9bb26d46967a0bdb3f64b32d45", - "size": 29854 + "sha256": "11c094fe87c2ee7375d1d57206a3db14a515a9fe1cc59199d1c469623973abfb", + "size": 31186 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/beta/memory_stores/memory_versions/list.md", - "sha256": "b5ec217723d16e9d0ceec0dd68cc910984d5d44cfbd6e4d857020a2a99f1d8d6", - "size": 7781 + "sha256": "44eebe661245d814f25edb005246eee5b00c8d07aa6dc4bb1602df7ad60416f5", + "size": 8089 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "ec7f2f87a9a960caccafa13e76741ccdb14681402d8d217ba7d851a7311584b6", - "size": 7036 + "sha256": "ab3b8d20668fd66e9ed04859bccea4e85512c1d10f21de7260a6a6027b603df0", + "size": 7465 }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/beta/memory_stores/memory_versions/redact.md", - "sha256": "cd9591e21e79d4879b972715965cd6526bddb0daebd2f3cf9678d42c77865863", - "size": 6935 + "sha256": "e49e005aeb4830a141c529989ee6440c1519c4ed599cf4ba3c162f44d903862a", + "size": 7364 }, { "url": "https://platform.claude.com/docs/en/api/beta/files", "status": "success", "path": "en/api/beta/files.md", - "sha256": "35694404507c9d8213dfd34be7a47356dfd47f114bd47c472d54d7f902f98e62", - "size": 16207 + "sha256": "9510101981039872d1f7a9533575579f80031c52579f8982ec4944653f3f1614", + "size": 17522 }, { "url": "https://platform.claude.com/docs/en/api/beta/files/upload", "status": "success", "path": "en/api/beta/files/upload.md", - "sha256": "d178a57aa7709547d9c2d4b2cee410436119c19468d5ca1b1a21989d74663c60", - "size": 3248 + "sha256": "7d33ad33003bdee3ef32622fe87a0fa7a4dcba4b482b42bef525750aaa5ef4e1", + "size": 3511 }, { "url": "https://platform.claude.com/docs/en/api/beta/files/list", "status": "success", "path": "en/api/beta/files/list.md", - "sha256": "21cf0668e64de11dc93d0401ccebb2255f9f5db81db1cfcf8cd3f41949acb1e4", - "size": 4206 + "sha256": "8a4aab9d498f4691d7036e7cf975eca45dfd9555a8f2d59435e811f8757a7d47", + "size": 4469 }, { "url": "https://platform.claude.com/docs/en/api/beta/files/download", "status": "success", "path": "en/api/beta/files/download.md", - "sha256": "4290baff8a5696a0c2bb9491ed7977f0222755bd13a7f50cfe1cc6f79a250cda", - "size": 1869 + "sha256": "9aaed7df63e48df322f1133368de6b9ff722ebb94914f0de4025fb77531f33cd", + "size": 2132 }, { "url": "https://platform.claude.com/docs/en/api/beta/files/retrieve_metadata", "status": "success", "path": "en/api/beta/files/retrieve_metadata.md", - "sha256": "e9b78d9c429103098daddcff409b920131d3bf0acb54f789561cbf6e7be917a4", - "size": 3172 + "sha256": "3a020ad263a183d66cd095ea5c6b80908bdbcf653670d6c12d784a22a78df696", + "size": 3435 }, { "url": "https://platform.claude.com/docs/en/api/beta/files/delete", "status": "success", "path": "en/api/beta/files/delete.md", - "sha256": "336458e1cd4f10e22e293271557054d81427d8509eb86801b4f6b3ac0e4f52fb", - "size": 2205 + "sha256": "b6c0e1319cc7855ebaccba3eb9142fb6c76dbc666f9ddcc66314c3bafcf3c76c", + "size": 2468 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills", "status": "success", "path": "en/api/beta/skills.md", - "sha256": "71596c94ddd0bf0534acaed91d2f82d5f941076bafd1e0ddefbe224fe5feff37", - "size": 31778 + "sha256": "e69aad4cea407d69d5f7b51c865cc66a295f582147f6a6530c48fcd129084941", + "size": 34145 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/create", "status": "success", "path": "en/api/beta/skills/create.md", - "sha256": "62f9af48e976ec4b8b95394f2ebef98af73b6e0a07a959cc3cf1fca826793617", - "size": 3397 + "sha256": "579b671408536efe6cc8876e91e646c05a17ebd5c08d498d02e7786093bbd019", + "size": 3660 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/list", "status": "success", "path": "en/api/beta/skills/list.md", - "sha256": "ed9ecffdbabb8c60c1badf429da44f4dcdb52ee8e7d9780db2f7621c14ed1100", - "size": 4094 + "sha256": "94017d75537d1475f25d5b6d0eb2f12cc5d5ff13db7aab3bd8ecb4bbbc6faf26", + "size": 4357 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/retrieve", "status": "success", "path": "en/api/beta/skills/retrieve.md", - "sha256": "9c327cc226419c20bcbd198c826a57fa97fd071f848f8e38280ea5df432ddced", - "size": 3089 + "sha256": "1406efad115e997b6505130440151ced33aa07e904ae5933e0471a35c2567f8b", + "size": 3352 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/delete", "status": "success", "path": "en/api/beta/skills/delete.md", - "sha256": "cd25e912126014e717c083109807206576e93e76539de2d0d931bedec0d653c3", - "size": 2276 + "sha256": "3eb276123041c0b7b4ac54a068fbf6e788fe3a6dbe74f0acc43ba75c88e21625", + "size": 2539 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions", "status": "success", "path": "en/api/beta/skills/versions.md", - "sha256": "4c8f5a62950bb32a6114fdd6b01b01a75653df0859d750ecb272b30777a018f5", - "size": 19138 + "sha256": "7afed34fbe70ae0feac0c957b7b4a99e0418f8aeebf2f095171671f76ec6eca8", + "size": 20453 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/create", "status": "success", "path": "en/api/beta/skills/versions/create.md", - "sha256": "ab8cff1e55f718c0240c8acae62f7cb2a6402b42a8dda9bddc920c5d986fb8bd", - "size": 3543 + "sha256": "dbaa98aa6f6244cabce10a96a77b9d890bd7823f3e25ba8ab217410bc7e46ece", + "size": 3806 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/list", "status": "success", "path": "en/api/beta/skills/versions/list.md", - "sha256": "a4fd09b9a711c3c6cf55d4bcca066e6d35d6117764e59f176692b59ce4157433", - "size": 3936 + "sha256": "b22dd445a850af5a4f4a64bf4e9683126c01b7bf79cdad2870af78d46b5a6898", + "size": 4199 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/download", "status": "success", "path": "en/api/beta/skills/versions/download.md", - "sha256": "c3aad4bbc1987d1e298fc46822c7294ccc30940c2f6e8d5bfc2059d83df8660a", - "size": 2177 + "sha256": "195d494525d5ee2cb3619062143ce62b53039af4e26de2d738b326dca93a16f2", + "size": 2440 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/retrieve", "status": "success", "path": "en/api/beta/skills/versions/retrieve.md", - "sha256": "445a5e4d2017af9b8c6a55a9f2714512b32f8c917e33b935c534d59a48d24047", - "size": 3407 + "sha256": "b016b71d7f6f8325dff6a08748ac47d31d9e0132ff8fcc7ae7a7ae7d6169448f", + "size": 3670 }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/delete", "status": "success", "path": "en/api/beta/skills/versions/delete.md", - "sha256": "51323817a7eea3ca56e2ca5b40572547a46604e6bf740b29f9d14e70fb856b4f", - "size": 2510 + "sha256": "952d98722e74a0b733d201de40dc9fe1851a399a0ebef22db05daf2d6b862ff5", + "size": 2773 }, { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles", "status": "success", "path": "en/api/beta/user_profiles.md", - "sha256": "ce8ac024559accbeb0954fe8597918c3bdbc005044747d461f8b362f672801f7", - "size": 25630 + "sha256": "327e6d25649c987082a1ce703f93024319d26b1b3b40d9d7b7598a245474fdad", + "size": 26945 }, { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/create", "status": "success", "path": "en/api/beta/user_profiles/create.md", - "sha256": "8ad954b4db0f091544d126dc0a44519f90e22b95652b6cb8e04d17416b0c8029", - "size": 5806 + "sha256": "9728f36dab62babc0b99eed9e07cbd8fab4729522744f2a47afa84b2be6da14b", + "size": 6069 }, { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/list", "status": "success", "path": "en/api/beta/user_profiles/list.md", - "sha256": "997d7f0bdf83777268145fe5a6dc52ccd6615016fecab3de0e5423f2963c49b3", - "size": 4703 + "sha256": "897bf139a4def3b8a924647ba2c155c2affc1cec8b1d81e7f58aef2d5ae0c3d3", + "size": 4966 }, { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/retrieve", "status": "success", "path": "en/api/beta/user_profiles/retrieve.md", - "sha256": "e8e9075447a7cab5536fae07ebb91b14b521819937c8cafdfb04f6c18719ab68", - "size": 4263 + "sha256": "f351bf7a99878c2178288c6870ea21e67c5f7b76f973dd94546afde82b51f5db", + "size": 4526 }, { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/update", "status": "success", "path": "en/api/beta/user_profiles/update.md", - "sha256": "943f0940c75971ab29d2b2557bcc3b50dd1c54cc0b9ac53b04473152366b06ba", - "size": 5821 + "sha256": "eb2a8495405d89c76a2fbdefdb4eb81bef106da1d19228c6b4f6d305f6833765", + "size": 6084 }, { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url", "status": "success", "path": "en/api/beta/user_profiles/create_enrollment_url.md", - "sha256": "03e7567b456802098138dfe0812e8081a1813e6cdc23ed4e8d36ad1af4909299", - "size": 2430 + "sha256": "e3d0b51b0385b0b6ea5127d2ff4581920d311480b1ee87f50bcc91086f6365ae", + "size": 2693 }, { "url": "https://platform.claude.com/docs/en/api/beta/dreams", "status": "success", "path": "en/api/beta/dreams.md", - "sha256": "53d0e3db2f1230799fa0a6e6adb89aa7f795f4e6c03d8928dd257affc8f148e1", - "size": 44107 + "sha256": "6e51c9e1aaa2043f53a5840c73455ca01ea862e9421e1c7e95a741e0cd865387", + "size": 45422 }, { "url": "https://platform.claude.com/docs/en/api/beta/dreams/create", "status": "success", "path": "en/api/beta/dreams/create.md", - "sha256": "ce1c7449a0013b810bcff386384875dc21b3cd571eec3ccd8cd50ce32c826d06", - "size": 8672 + "sha256": "d5aa8fe5a754aa7820b7bb034f7527da40d6656945114d5fbddba065e3d2bc98", + "size": 8935 }, { "url": "https://platform.claude.com/docs/en/api/beta/dreams/list", "status": "success", "path": "en/api/beta/dreams/list.md", - "sha256": "6cd53175d78d61e9bcfc2ba35a2e2e631a842ef2aacae7f762adf2dad9b362f5", - "size": 7024 + "sha256": "7da3eede58f15d871d1fcce645ea8954b47733eb5a2f0ddb5a102cf1801df26b", + "size": 7287 }, { "url": "https://platform.claude.com/docs/en/api/beta/dreams/retrieve", "status": "success", "path": "en/api/beta/dreams/retrieve.md", - "sha256": "3199992d74f0d7858702057af8d7af85bc0adffdef3e673b2977cda143f6d85b", - "size": 6397 + "sha256": "9eca5f46fa2e94dfaeb9b815246878f3bc3fecf72e936b581638a1b2edf22328", + "size": 6660 }, { "url": "https://platform.claude.com/docs/en/api/beta/dreams/cancel", "status": "success", "path": "en/api/beta/dreams/cancel.md", - "sha256": "021fe2813299d9c51309433c7a8815849b9746a071ba3ef5311c483156c62408", - "size": 6432 + "sha256": "87e73cf4a003d76fb1e77073fc060d7f3af05a735f539edae36db839f6353282", + "size": 6695 }, { "url": "https://platform.claude.com/docs/en/api/beta/dreams/archive", "status": "success", "path": "en/api/beta/dreams/archive.md", - "sha256": "5e371367d4cb33e1223c898fc2f39ed558540b5ff23de9f3ae14839c8251535a", - "size": 6436 + "sha256": "e4724ff124d8b067d5132f0b437c56ef3a36bb3e29084ef0c669b41c521903fe", + "size": 6699 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels", "status": "success", "path": "en/api/beta/tunnels.md", - "sha256": "d594e7d0d1587328ffe2aae47df003e56d5f8a85d2b0389ba6816b965760a231", - "size": 34172 + "sha256": "2da61e7ec7933ccafb9d959d5f212623d415e008fb022b1e2b6ea1ffd7551b3f", + "size": 36802 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/create", "status": "success", "path": "en/api/beta/tunnels/create.md", - "sha256": "c66c243d7958aadbba8f7f030bb7031e7512f99c4701b083ad83034af290fa66", - "size": 3323 + "sha256": "ecc2b37758927a795376a37d8736a2d6cf2a6598c90e373e344aef4aea736ff1", + "size": 3586 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/retrieve", "status": "success", "path": "en/api/beta/tunnels/retrieve.md", - "sha256": "3d25e6a410229ecc5e3f8665862eac8f7c46bd934998a89bb5d1313dba692047", - "size": 3009 + "sha256": "d698e9f6e1d4a21f5733b7a06f27dda3236a009f6a73bf0116c6ee6d508f3fab", + "size": 3272 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/list", "status": "success", "path": "en/api/beta/tunnels/list.md", - "sha256": "184b42c38521568a3461ed1e212e08974bb7d61ac0d49cc6aeff2012f565a241", - "size": 3628 + "sha256": "007162ff4f000fe9ac0ea2d5be3c77f5ab752fb4b59a59c7f5a1cb6c79022615", + "size": 3891 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/archive", "status": "success", "path": "en/api/beta/tunnels/archive.md", - "sha256": "debd7a9721d0a6964bb0ae2a694f6e4d2af4a6f543d7fb19fc0b6d653dba0e3c", - "size": 3313 + "sha256": "fc2a99286367ece014d506ce4634efe916d60e449b2ce8aa1986662db1caaea3", + "size": 3576 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/reveal_token", "status": "success", "path": "en/api/beta/tunnels/reveal_token.md", - "sha256": "22981771fc02b6f38a11cea46f6f415a78c49982cd3e43d5dbb6570ff629c3a7", - "size": 2807 + "sha256": "7141bf63fe197664a8c1f21de8dad3211d2846f9b20efb889691ba2661505f0b", + "size": 3070 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/rotate_token", "status": "success", "path": "en/api/beta/tunnels/rotate_token.md", - "sha256": "29fc39fd2faa2ba2839b959c8b0f45f72cceee4b63a2a3fb803f52b9505613bb", - "size": 2972 + "sha256": "4d8f524a85b3a8aeb791144d47aeebc1dd2aa3f0907e9a92c97dadb454de71c6", + "size": 3235 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates", "status": "success", "path": "en/api/beta/tunnels/certificates.md", - "sha256": "dcff2bfa5c5bcbd4172b6dff6b7f946e74051ba491fb9e60d73f0509df1b0490", - "size": 14719 + "sha256": "1ef4eefe9dbaa91a969975ed871254e5f835270b6390e8f41c05b86596a078af", + "size": 15771 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/create", "status": "success", "path": "en/api/beta/tunnels/certificates/create.md", - "sha256": "23d0c509049e9c59b4b6bc59a6eb044b4f78fe63ea92be7d02352fc4cb2d9326", - "size": 3598 + "sha256": "16d9c09ccd92cb3b55a512ef715795636d96edf4650409a3e9902e06e58379f7", + "size": 3861 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/retrieve", "status": "success", "path": "en/api/beta/tunnels/certificates/retrieve.md", - "sha256": "00d6a3ef53fc14a56694afc3c3525d89a5e2d0f82a5be23958c56848a7f930df", - "size": 3175 + "sha256": "68966fc7dad6cea356959e76abddd88c7f707e581e0fab958294ca47e1c99bdf", + "size": 3438 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list", "status": "success", "path": "en/api/beta/tunnels/certificates/list.md", - "sha256": "00e4c263ea2ce036afda3c63282a747cf15b0e804a2a5d317dc354df661fa141", - "size": 3779 + "sha256": "697a949f09f6af0cecbb4a63ddb27331668d1db57a1a6f9642109eb5aba80003", + "size": 4042 }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/archive", "status": "success", "path": "en/api/beta/tunnels/certificates/archive.md", - "sha256": "b5e172009655690a151910670a7bfb8ee6e8ed314dc9d8b2fe2510feb74e0591", - "size": 3422 + "sha256": "5333ecfda14a1e0d9ed0137d765f522f628f85f4c24c823d9c9e230ad478180d", + "size": 3685 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization", + "status": "success", + "path": "en/api/beta/organization.md", + "sha256": "164cdab2eebb0f6b54914c12cb315a47fa2aae8a1b4b13c51e4e808b4bfe127d", + "size": 249984 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/retrieve", + "status": "success", + "path": "en/api/beta/organization/retrieve.md", + "sha256": "8cf57b8e06dcc897d4439e9809e6b2fe9ec2ef89b341185dbb9f8f1007286fae", + "size": 733 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys", + "status": "success", + "path": "en/api/beta/organization/api_keys.md", + "sha256": "a0581b677fc8eb00e6633b6f4d8d18827fd4f35b1561afab46c857a987cb051f", + "size": 19321 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/list", + "status": "success", + "path": "en/api/beta/organization/api_keys/list.md", + "sha256": "f667925adbe69b48135773b0b10692d163f4906fa75d46da1446433da478c121", + "size": 5543 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/retrieve", + "status": "success", + "path": "en/api/beta/organization/api_keys/retrieve.md", + "sha256": "3af11b0f601c9dcdc08463ea2a9919ff0b8570b9be23ed9371a0f72d57a86ba3", + "size": 4295 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/update", + "status": "success", + "path": "en/api/beta/organization/api_keys/update.md", + "sha256": "8d7ece478ad46e3c425f957abfd5e0e734892585866dcd36cf88e96662572f32", + "size": 4614 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys", + "status": "success", + "path": "en/api/beta/organization/external_keys.md", + "sha256": "11002cdfa1dd0d2fcec33ae7e6fb77b99ffca506228ded6103e864e435c36780", + "size": 26146 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create", + "status": "success", + "path": "en/api/beta/organization/external_keys/create.md", + "sha256": "a83100bdd7e79c96cacb8fef66fd55a6e7f740dc587a842a2b0cb123c594748c", + "size": 5348 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/list", + "status": "success", + "path": "en/api/beta/organization/external_keys/list.md", + "sha256": "c754ccbf73fe623118850951862ba440bbd9e28eb4feada3eb785b3764d8e4a9", + "size": 3905 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/retrieve", + "status": "success", + "path": "en/api/beta/organization/external_keys/retrieve.md", + "sha256": "248368edb4c65ff5df2a8f51e999990999d25ac1e74d1fab9b4eb0c286c9140c", + "size": 3738 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update", + "status": "success", + "path": "en/api/beta/organization/external_keys/update.md", + "sha256": "6861503cb25f49746330a2af7f67936ac917b560cfce86ca01876aa211d95fec", + "size": 5539 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/delete", + "status": "success", + "path": "en/api/beta/organization/external_keys/delete.md", + "sha256": "595bd3cecaa78087eda762b04b41e156a6be69468e5631f15948c28363f43ca9", + "size": 728 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/validate", + "status": "success", + "path": "en/api/beta/organization/external_keys/validate.md", + "sha256": "3db5ab200bf25347d10a87e080d00ee871d54bc193bb7d114ed249cbec428fa0", + "size": 1179 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation", + "status": "success", + "path": "en/api/beta/organization/federation.md", + "sha256": "574cf31643c8e4b1b48f9f29ee418d65e65c1c9a06d1c1398b85382270b0c01b", + "size": 101237 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers", + "status": "success", + "path": "en/api/beta/organization/federation/issuers.md", + "sha256": "6fe787015cc1807e5443d8b03713e89e363ea13e74fba1c3d2c23652ca09f004", + "size": 46600 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create", + "status": "success", + "path": "en/api/beta/organization/federation/issuers/create.md", + "sha256": "149e0fc37ed2f12a4a6b9e1c22322e47a0be0ea4f1b71405a738af8af96f88b7", + "size": 9523 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/list", + "status": "success", + "path": "en/api/beta/organization/federation/issuers/list.md", + "sha256": "f7decc00591e9d2f1417c87c74e33f1c0c09387661112a58dc42c6a5d0047f02", + "size": 7405 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/retrieve", + "status": "success", + "path": "en/api/beta/organization/federation/issuers/retrieve.md", + "sha256": "761b799925a3b60cfbfabd29caebd0f898c376f05e6d9c20255232056feb3fe5", + "size": 7106 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update", + "status": "success", + "path": "en/api/beta/organization/federation/issuers/update.md", + "sha256": "03021a73838aac4beab2d1466f6cc371b6e939d62991183034001d8d3fe62b48", + "size": 9793 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/archive", + "status": "success", + "path": "en/api/beta/organization/federation/issuers/archive.md", + "sha256": "a9d564cf3027621b455281d2b98b297a653419be70b2727f962f44812222a303", + "size": 7400 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules", + "status": "success", + "path": "en/api/beta/organization/federation/rules.md", + "sha256": "fb373b6c6da3147f714ac3a490c7bee3f4ab69f327873b84e74e1a6bb4d854c2", + "size": 66513 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create", + "status": "success", + "path": "en/api/beta/organization/federation/rules/create.md", + "sha256": "46d612f4a64409a76ef368abf8329d2e3ee33fcb4ef937fa9c959b353b390fd0", + "size": 11920 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/list", + "status": "success", + "path": "en/api/beta/organization/federation/rules/list.md", + "sha256": "5d4d36c74e109e3f2d38c1165f3fc047d7a876d8dfca48a2d6404c1d71c48cfb", + "size": 7915 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/retrieve", + "status": "success", + "path": "en/api/beta/organization/federation/rules/retrieve.md", + "sha256": "aad26091422c2e82af976c55a3eadfc9183a0085a1fe5dfb7fd36fa2bdb880bd", + "size": 7812 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update", + "status": "success", + "path": "en/api/beta/organization/federation/rules/update.md", + "sha256": "bb0d386047c7d0f992695b43b29367decd8aac5a566333543e2bb388e8781797", + "size": 12214 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/archive", + "status": "success", + "path": "en/api/beta/organization/federation/rules/archive.md", + "sha256": "fc1e7dce1636a5b59c7bc2bfc41d27c49bc1d8bf56c33b8801309b4a7bbff84c", + "size": 8276 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces", + "status": "success", + "path": "en/api/beta/organization/federation/rules/workspaces.md", + "sha256": "dd9fecf0bb29aea1372c60707b7708739d1b9b7eb5ea1c7653e14c9d96298659", + "size": 11993 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/add", + "status": "success", + "path": "en/api/beta/organization/federation/rules/workspaces/add.md", + "sha256": "be6286d210e053850a11042e649fc3bc20c26d75b13c4bbcff545f2a90cb1d70", + "size": 4170 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/list", + "status": "success", + "path": "en/api/beta/organization/federation/rules/workspaces/list.md", + "sha256": "6a9f12b08602fa0adad589cb8c62d6bac4414a30de32d489676330ad964f48bb", + "size": 4166 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/remove", + "status": "success", + "path": "en/api/beta/organization/federation/rules/workspaces/remove.md", + "sha256": "203a4343d179ecd5068cae12001209290a77efa1f1489b6c8e4658cf3c67cb14", + "size": 3255 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/invites", + "status": "success", + "path": "en/api/beta/organization/invites.md", + "sha256": "89329dda310c70dfa08ac466073a98aa684cb808b8834eb73df336b98793aca5", + "size": 10849 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/create", + "status": "success", + "path": "en/api/beta/organization/invites/create.md", + "sha256": "bfbc4c895780b80767d2d2d6fa7b2fcfb72496667419f3a3b12a90cc0af15e1e", + "size": 3072 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/list", + "status": "success", + "path": "en/api/beta/organization/invites/list.md", + "sha256": "611d23fcf3c97614440e2864498fe6b4ddb3be18ff6b616ece147a8155385325", + "size": 3666 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/retrieve", + "status": "success", + "path": "en/api/beta/organization/invites/retrieve.md", + "sha256": "b0fe9458ac360679238f7d86ca3ddaff29c9d3c11ebc3ba141fc32e19b6621df", + "size": 1925 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/delete", + "status": "success", + "path": "en/api/beta/organization/invites/delete.md", + "sha256": "83ae545e676eea1ed6bc93f704401370a16160511ee7cf49c200d48d4e770ac4", + "size": 634 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts", + "status": "success", + "path": "en/api/beta/organization/service_accounts.md", + "sha256": "8dd91cf5b3929dd11ebfbfe9127e517749fbf49028fbbf3231b0b941374762be", + "size": 40291 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/create", + "status": "success", + "path": "en/api/beta/organization/service_accounts/create.md", + "sha256": "0d8d4380bef3b13683bbe7c196e080f1014468c82eaeff6842b356e92027c2a4", + "size": 5256 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/list", + "status": "success", + "path": "en/api/beta/organization/service_accounts/list.md", + "sha256": "694ec802dbc41f0da9f5bbfcef92fc9aa7d46f6ed54eccac0d926f4df599aa61", + "size": 4837 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/retrieve", + "status": "success", + "path": "en/api/beta/organization/service_accounts/retrieve.md", + "sha256": "4aa8fb2400e09cbb5b79f2eab10916b5beb59cebbdf0eeee3f9398bb3a91f422", + "size": 4453 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/update", + "status": "success", + "path": "en/api/beta/organization/service_accounts/update.md", + "sha256": "3efba23cacb4b0de306264abbc39a2483f975fa1fb17d5d9cd4dd03b85ea3ffc", + "size": 5151 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/archive", + "status": "success", + "path": "en/api/beta/organization/service_accounts/archive.md", + "sha256": "c2197dc5246a84090b319be84c4037b2996f949645aa2a7fcf063925bea05439", + "size": 4761 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces", + "status": "success", + "path": "en/api/beta/organization/service_accounts/workspaces.md", + "sha256": "81bac26989ee5b14e9dd25737f2e6bea6c01fa2c27aa5354a831f286b0d6fd33", + "size": 13682 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/add", + "status": "success", + "path": "en/api/beta/organization/service_accounts/workspaces/add.md", + "sha256": "d153a23c54484ecc2a3e9f75a20c8119580500d05af101cc89e0eb939d435ad2", + "size": 4586 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/list", + "status": "success", + "path": "en/api/beta/organization/service_accounts/workspaces/list.md", + "sha256": "6fa133e4d802ea408ddebfaeba93d5021b281961520a43520143c0cf73dd9b13", + "size": 4965 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/remove", + "status": "success", + "path": "en/api/beta/organization/service_accounts/workspaces/remove.md", + "sha256": "ee3c3449d8f1c7d1e20d83a6a275c75fb193ef9a2ea70ada8799d7bd38517fd0", + "size": 3609 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/users", + "status": "success", + "path": "en/api/beta/organization/users.md", + "sha256": "6b7038d800adb5fe6241eea544117ab39f1fe82840d06e913a0b2139f2c40ac4", + "size": 7072 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/users/list", + "status": "success", + "path": "en/api/beta/organization/users/list.md", + "sha256": "a68cad64ca481597d3e16f16dcd358390fecab16aa41d2c9518930fed87090f0", + "size": 2541 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/users/retrieve", + "status": "success", + "path": "en/api/beta/organization/users/retrieve.md", + "sha256": "8b4a796e1fdc4ecf71d21ef2e3413251c8d17c5a5d991e84563b3774de74661f", + "size": 1210 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/users/update", + "status": "success", + "path": "en/api/beta/organization/users/update.md", + "sha256": "f01392be981edbc85b2cfdf7b08579a5aed0873d81b8a97e5160a8ed73be2c12", + "size": 1752 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/users/remove", + "status": "success", + "path": "en/api/beta/organization/users/remove.md", + "sha256": "3d3550735db23eeb97a264918779ac5b343b87872b2780e5d2763c46ab3e823f", + "size": 620 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces", + "status": "success", + "path": "en/api/beta/organization/workspaces.md", + "sha256": "0a43fcdf9452d852169adcc5f28f9ff6270efd46ddb410c4c1d1039d398fdb9b", + "size": 61438 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/list", + "status": "success", + "path": "en/api/beta/organization/workspaces/list.md", + "sha256": "beaf0d5d6ccc3cfa00360c14404b52676dba935d2a7f5da8d77fff6c7cd64cf0", + "size": 4338 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create", + "status": "success", + "path": "en/api/beta/organization/workspaces/create.md", + "sha256": "e3a5644ed5a68442283d0b75274cf9a5f7e409cedac1341d299bc9351e92c2ce", + "size": 7315 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/retrieve", + "status": "success", + "path": "en/api/beta/organization/workspaces/retrieve.md", + "sha256": "45a6ca5fd06fc2b71a0fb7c0f4efdb4dc5b2c9fb2e643e30375b32680887cd69", + "size": 3308 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update", + "status": "success", + "path": "en/api/beta/organization/workspaces/update.md", + "sha256": "57e9c792e369c8951ece98828ed8ab54f99849260787d8472414fecaee97395c", + "size": 5186 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/archive", + "status": "success", + "path": "en/api/beta/organization/workspaces/archive.md", + "sha256": "d01d0c8d1ad24ab66045172cbb38b49d14346c6e58c96eaeefd2aa1bc18a5cc8", + "size": 3323 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits", + "status": "success", + "path": "en/api/beta/organization/workspaces/rate_limits.md", + "sha256": "451ae6ffa3c94834862ca4fb052ae4120f38a0e6ee306a7bfc555e06eedcdfa7", + "size": 5522 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/list", + "status": "success", + "path": "en/api/beta/organization/workspaces/rate_limits/list.md", + "sha256": "e11421ea7503eb2b6b4043cbcd267a67e6f20f21b5febe7df8f98c09938b00ce", + "size": 3490 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members", + "status": "success", + "path": "en/api/beta/organization/workspaces/members.md", + "sha256": "ffb12675329c74f020b08fa8fe2dcced0922768c64acb4d5143e7f656c6f1a15", + "size": 7536 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/list", + "status": "success", + "path": "en/api/beta/organization/workspaces/members/list.md", + "sha256": "0d932d6e24a202617da8106f93898643b94f95c4bc42e3f41416f9ca8cb2e203", + "size": 2035 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/add", + "status": "success", + "path": "en/api/beta/organization/workspaces/members/add.md", + "sha256": "5dcbdc6cc2c875226f521beeb9cb010737081ddb726412c5464a2a9767d8fe7e", + "size": 1555 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/retrieve", + "status": "success", + "path": "en/api/beta/organization/workspaces/members/retrieve.md", + "sha256": "abbb2bb065480fb7ffd84fc09224e6be87a6b4ccdc5e8a5ea70033daedae72d3", + "size": 1148 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/update", + "status": "success", + "path": "en/api/beta/organization/workspaces/members/update.md", + "sha256": "d9ab55219bd41e1be2694ae36327d1ab4783ac69af3c9f6de56beaa580d09efd", + "size": 1506 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/remove", + "status": "success", + "path": "en/api/beta/organization/workspaces/members/remove.md", + "sha256": "fbdb508628c802a8b00e639afa1009e5198ac08d71f1aa2038db4a8807421dd3", + "size": 895 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts", + "status": "success", + "path": "en/api/beta/organization/workspaces/service_accounts.md", + "sha256": "25d426701f5634f100dfc8348a0a906be95067824c7ae3291fa0182ac3b673f9", + "size": 21925 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/list", + "status": "success", + "path": "en/api/beta/organization/workspaces/service_accounts/list.md", + "sha256": "9be90fd518eb385e75a80cb339b7d535080083b611bb3245d057b040990f470e", + "size": 4481 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/add", + "status": "success", + "path": "en/api/beta/organization/workspaces/service_accounts/add.md", + "sha256": "4c1eec98d1f77e9b25e7ea28b3e143231dd69175c03e1837bc78e54b1c59c610", + "size": 4739 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/retrieve", + "status": "success", + "path": "en/api/beta/organization/workspaces/service_accounts/retrieve.md", + "sha256": "d7eea6b078241a54fa97c1c159b6e31bca27409cb342a7b194b4b82a75ab1aa3", + "size": 4166 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/update", + "status": "success", + "path": "en/api/beta/organization/workspaces/service_accounts/update.md", + "sha256": "eb9c656255418455659b91e39b299348833980b58a1c2bd1255507d8b8563ab7", + "size": 4500 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/remove", + "status": "success", + "path": "en/api/beta/organization/workspaces/service_accounts/remove.md", + "sha256": "4608834fd230e1d9b42bee49efb3177a4c75cfad6f3acf54fde50db6668a544e", + "size": 3485 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits", + "status": "success", + "path": "en/api/beta/organization/rate_limits.md", + "sha256": "f12f607676e539193d6a2e3d4cd6b9e3b5ee10f9c5cf0023651c9d075b7aef50", + "size": 4463 + }, + { + "url": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits/list", + "status": "success", + "path": "en/api/beta/organization/rate_limits/list.md", + "sha256": "72c26f06d70cd07c8e69310921f7c670f1d15aa2cfad8766529b61c5a5025cf7", + "size": 3023 }, { "url": "https://platform.claude.com/docs/en/api/beta/webhooks", @@ -3880,29 +4384,29 @@ "url": "https://platform.claude.com/docs/en/api/compliance", "status": "success", "path": "en/api/compliance.md", - "sha256": "777663cf1b610f80ab35702720d9949c5863d9521d747a0490c41215a69790e3", - "size": 3155231 + "sha256": "0b2da0b5654d8890815480205b8ae593d8cdea41414835e21de39f90787ca903", + "size": 3199652 }, { "url": "https://platform.claude.com/docs/en/api/compliance/activities", "status": "success", "path": "en/api/compliance/activities.md", - "sha256": "1a77fbfbecc75fd73afc4830f2e81e7b399ce4934a83494e8fe24fc3e9581adb", - "size": 5965869 + "sha256": "31ae68efee5bd2649b476705aa1da56cdc17406a265a5b5b3c6d55a1900e8f3c", + "size": 6050381 }, { "url": "https://platform.claude.com/docs/en/api/compliance/activities/list", "status": "success", "path": "en/api/compliance/activities/list.md", - "sha256": "e75f67232c162c88fcadeadac3c03943e8c39de5b7a5d770f39a00ef9728fbee", - "size": 3038633 + "sha256": "7c1cc1cad76fcc953cf621831d8ca5a5a0aa034b907ff10fdaa4a52ab2a73b90", + "size": 3081959 }, { "url": "https://platform.claude.com/docs/en/api/compliance/organizations", "status": "success", "path": "en/api/compliance/organizations.md", - "sha256": "6759531936f1aed85b0477e9d7c99648d806520921956a74292b68ce14cabfc0", - "size": 16802 + "sha256": "4d2ca393be20e478c0157c9a5fd7854b44b15d77f9849844084dfecfac9becde", + "size": 17198 }, { "url": "https://platform.claude.com/docs/en/api/compliance/organizations/list", @@ -3964,15 +4468,15 @@ "url": "https://platform.claude.com/docs/en/api/compliance/organizations/settings", "status": "success", "path": "en/api/compliance/organizations/settings.md", - "sha256": "e2f728b75c6f246b035fe29f6269f23aab0db55ca424c261a7ab7aab28b83891", - "size": 14970 + "sha256": "b620b89fb20c8918a645c552c4106d6041a9572496eb3f97c70b6caefaaa51b1", + "size": 15778 }, { "url": "https://platform.claude.com/docs/en/api/compliance/organizations/settings/retrieve", "status": "success", "path": "en/api/compliance/organizations/settings/retrieve.md", - "sha256": "4673f926511ea10130da083da6a79201d00fb260f52159b7018f01881febf24d", - "size": 7876 + "sha256": "1ad972d32124bc764bb0d5dbcf0d72ae68cfc3829317932182f891efcfad393b", + "size": 8272 }, { "url": "https://platform.claude.com/docs/en/api/compliance/groups", @@ -4013,8 +4517,8 @@ "url": "https://platform.claude.com/docs/en/api/compliance/apps", "status": "success", "path": "en/api/compliance/apps.md", - "sha256": "6927e5c7c5210c56fd1d3b1c12f6d2eb1daf139ee99e687c33cd12ac8c32bb96", - "size": 86304 + "sha256": "6b72a5136144230246ddb1841370ec2d061327952ca5a3a5b93d0b65126b2650", + "size": 87003 }, { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats", @@ -4209,43 +4713,43 @@ "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions", "status": "success", "path": "en/api/compliance/apps/sessions.md", - "sha256": "e7c3464ee1fd908cca59025f3b1846f96d928cc618741b8075125c44775def77", - "size": 37631 + "sha256": "c1531aa29c0b2b68884a94e1b87a44712ef301943fd96fdb410b5a30dfcac263", + "size": 38330 }, { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local", "status": "success", "path": "en/api/compliance/apps/sessions/local.md", - "sha256": "7a2667e80ec268fcc9a7943bf9a66c27cb0f9654eb6c4a851ee676d91bb90c9e", - "size": 28200 + "sha256": "f829dcc86fc087d2278ceaa877643244c1d2383ed2aaa6d3a795a1457aeaf8c7", + "size": 29353 }, { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list", "status": "success", "path": "en/api/compliance/apps/sessions/local/list.md", - "sha256": "5cbb85963dd298e22de439a82d449233ac9cf7ff331cf2bb90fa8e5023fdefae", - "size": 5306 + "sha256": "6ea685a88846f7a2f3518b88b7d440b383c8fe1c240260df196d5e0785dae796", + "size": 5539 }, { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/retrieve", "status": "success", "path": "en/api/compliance/apps/sessions/local/retrieve.md", - "sha256": "eff179ebf4a27e8d31841881928073cad440c3016a451f7d90a55dfb6c3dd8cc", - "size": 3625 + "sha256": "94578a677dce9a7da0d62c02507af19e03f260ff90b4ceb049ebdf20aa401595", + "size": 3858 }, { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages", "status": "success", "path": "en/api/compliance/apps/sessions/local/messages.md", - "sha256": "e71bdb70623104a75d5b2b3daa9da86fb8ba7f3b599eda5e81fe34bef02dc5fe", - "size": 21052 + "sha256": "0ad5ccbfc17417e56e1d5a096217b66206d720a9e3e364e16afea5cc96663d59", + "size": 21285 }, { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list", "status": "success", "path": "en/api/compliance/apps/sessions/local/messages/list.md", - "sha256": "f37fc02e932345e32e5245b7884fdb3421b1e6afb0a28d2bd95d578f1b4c7f5c", - "size": 13640 + "sha256": "8d1141cf6136c919a3666e5483a93f08c162ee72030faf42e9c457e79efb8484", + "size": 13873 }, { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote", @@ -4335,8 +4839,8 @@ "url": "https://code.claude.com/docs/en/changelog", "status": "success", "path": "en/docs/claude-code/changelog.md", - "sha256": "b24b366c78771f88d2eba9a696af53662ea17b88ef1127a092394e2abbc9bf50", - "size": 593597 + "sha256": "aa6069c76a939809697f995469f759ef546fe7f28a4eca04d1807d73ac09a890", + "size": 599232 }, { "url": "https://code.claude.com/docs/en/how-claude-code-works", @@ -4356,8 +4860,8 @@ "url": "https://code.claude.com/docs/en/claude-directory", "status": "success", "path": "en/docs/claude-code/claude-directory.md", - "sha256": "09b4038db64703d58fcac356f02acf4e1f20a7ebc5aeb4be696fb0f8f3005265", - "size": 95394 + "sha256": "086900d343d347daf4ef527b68cedff24b550e9f4109a0bad76fce7670db8a9d", + "size": 96031 }, { "url": "https://code.claude.com/docs/en/context-window", @@ -4405,8 +4909,8 @@ "url": "https://code.claude.com/docs/en/best-practices", "status": "success", "path": "en/docs/claude-code/best-practices.md", - "sha256": "defa65b9be8f0c7ed96824822644bdb9334a6b6b71f13684ddd6f6995eccf56c", - "size": 39871 + "sha256": "d8634f18e24cbfb1e65f967c0c99ba443c1daa68b7a3099477ecda7b31f8052c", + "size": 39879 }, { "url": "https://code.claude.com/docs/en/platforms", @@ -4426,15 +4930,15 @@ "url": "https://code.claude.com/docs/en/web-quickstart", "status": "success", "path": "en/docs/claude-code/web-quickstart.md", - "sha256": "501f7c7d800e9150167a17386e6cfcbd48e81fc8c700d9b5e6bda50614794035", - "size": 20422 + "sha256": "65a49759aaf2173e2a26a27b394634f6663147cda16b3bca973a22f726f89813", + "size": 22352 }, { "url": "https://code.claude.com/docs/en/claude-code-on-the-web", "status": "success", "path": "en/docs/claude-code/claude-code-on-the-web.md", - "sha256": "485cf406c80a907f139b5009e55247422cfe13bce7f852acb83109f18e7d2121", - "size": 36635 + "sha256": "baad6793b73afb55da5bf65278d79db2d00ac7cd4031e2c70d3f8335bd531064", + "size": 37053 }, { "url": "https://code.claude.com/docs/en/routines", @@ -4461,8 +4965,8 @@ "url": "https://code.claude.com/docs/en/desktop", "status": "success", "path": "en/docs/claude-code/desktop.md", - "sha256": "2ed26d7c1efde71300e02a5bf4c5d32fa8cb5227635ec29e418cc1532f4d2e89", - "size": 96947 + "sha256": "cebf7cc0df6add9b691e2b7153db056ead56e021271413c44c5e83e5fd438514", + "size": 97804 }, { "url": "https://code.claude.com/docs/en/desktop-linux", @@ -4503,8 +5007,8 @@ "url": "https://code.claude.com/docs/en/chrome", "status": "success", "path": "en/docs/claude-code/chrome.md", - "sha256": "273c968b59edfa09693a244cc05df619bb3a58bf6036c91862cd5dc4e41e0efb", - "size": 17990 + "sha256": "0c1a2b098eb49f06b09347359753a604c5ca23143fdf5984ff8155f53bf65321", + "size": 19645 }, { "url": "https://code.claude.com/docs/en/computer-use", @@ -4531,8 +5035,8 @@ "url": "https://code.claude.com/docs/en/security-guidance", "status": "success", "path": "en/docs/claude-code/security-guidance.md", - "sha256": "9f9a3f9899edbe67f5d53b95ada52aac8b4a719f9a5e47e1d123e3471777f6af", - "size": 20526 + "sha256": "5805edbe465de5277faa6e5972eaaf486ff9fc65695ad06d5e649f6f71105a00", + "size": 20529 }, { "url": "https://code.claude.com/docs/en/claude-security", @@ -4545,8 +5049,8 @@ "url": "https://code.claude.com/docs/en/code-review", "status": "success", "path": "en/docs/claude-code/code-review.md", - "sha256": "ca938026dbc7df33c5dadf800ddf0ef2033308e2b3a04b8b3951c302074016bf", - "size": 31537 + "sha256": "f30957a375859a6ab186f308ec4aac5ca2590d26dab4289b8298536680d4cc91", + "size": 33432 }, { "url": "https://code.claude.com/docs/en/github-actions", @@ -4580,8 +5084,8 @@ "url": "https://code.claude.com/docs/en/slack", "status": "success", "path": "en/docs/claude-code/slack.md", - "sha256": "33a34b273312ef21f34c75e8b024e85db8e2316ff553b724451d0640f6c1e4a3", - "size": 15640 + "sha256": "b47ea831ba59427cdccc99002e750ff9d6c2f7ec7c6d3b203eebcd5aad5f0407", + "size": 15675 }, { "url": "https://code.claude.com/docs/en/claude-tag", @@ -4608,8 +5112,8 @@ "url": "https://code.claude.com/docs/en/agent-view", "status": "success", "path": "en/docs/claude-code/agent-view.md", - "sha256": "f8474573ceb6f1a0b0a99e12bc548b24c18ee0fc556316a7c6bbeb468887a12b", - "size": 178486 + "sha256": "7ecdcc719a14557726f8aa22f3652a6fe0c7712472bc21fe1c870aed45a321d5", + "size": 182623 }, { "url": "https://code.claude.com/docs/en/agent-teams", @@ -4629,8 +5133,8 @@ "url": "https://code.claude.com/docs/en/workflows", "status": "success", "path": "en/docs/claude-code/workflows.md", - "sha256": "4dde50ea069671837ace96541553bc7233e2263f44bb42dd7c9c1ceadb63aa93", - "size": 33240 + "sha256": "ee2aa62cdfaab3414684267aff804f9544d877c1e39ca577497fd6b7d205d718", + "size": 33235 }, { "url": "https://code.claude.com/docs/en/worktrees", @@ -4650,29 +5154,29 @@ "url": "https://code.claude.com/docs/en/mcp", "status": "success", "path": "en/docs/claude-code/mcp.md", - "sha256": "9ea29d271dd355b4baf8d3ab06df92ddc7d05203de2d837716ac01044b3c4c34", - "size": 97153 + "sha256": "19a036f16bd0fc454dbc1505ef23ca747f8c1dd33d20b8c36290c7aaa282ce84", + "size": 100727 }, { "url": "https://code.claude.com/docs/en/skills", "status": "success", "path": "en/docs/claude-code/skills.md", - "sha256": "8635e0597dc1a135bbdadcf0389cc00d807376d8dd801a0220a4d42f39a3e57e", - "size": 96018 + "sha256": "adef846544405b16b010d6b666fd2d35b62853cec247c71e95bfe46a76ffdf5c", + "size": 96173 }, { "url": "https://code.claude.com/docs/en/discover-plugins", "status": "success", "path": "en/docs/claude-code/discover-plugins.md", - "sha256": "a6f8329be16e3a5bb2024c2d91e1b25880428e72bdbfbe3491b54b3ef5e59eb0", - "size": 32795 + "sha256": "77c22929713d286925e135c1971532b697e92107081854852ef37acb99bc235f", + "size": 32907 }, { "url": "https://code.claude.com/docs/en/plugins", "status": "success", "path": "en/docs/claude-code/plugins.md", - "sha256": "00204f950825df8a2f77a55fca98414dbcfbd1f7c5910512bffa29818eacb18a", - "size": 28868 + "sha256": "ccfb44d9b7b388a9d6166214603f6429ec3ab6dca3a6591346b0d513706c2c64", + "size": 28723 }, { "url": "https://code.claude.com/docs/en/artifacts", @@ -4685,8 +5189,8 @@ "url": "https://code.claude.com/docs/en/hooks-guide", "status": "success", "path": "en/docs/claude-code/hooks-guide.md", - "sha256": "00af0e0c868aa63634d1fba1fb7bc2f94c108fd7f0e3fd6b9c5a237c512ca8f0", - "size": 78346 + "sha256": "be224619a0e5cdae391c99aa6f8266771805c6af8a573c513ff2a2c02e12be40", + "size": 78481 }, { "url": "https://code.claude.com/docs/en/channels", @@ -4734,8 +5238,8 @@ "url": "https://code.claude.com/docs/en/troubleshoot-install", "status": "success", "path": "en/docs/claude-code/troubleshoot-install.md", - "sha256": "00ee610707c923d4014190aa678b73475c3cd442322d39d39d36843bbc63a84e", - "size": 59886 + "sha256": "1776718e5d4c21654278ba638d5457e3f0da238b338f3ba4276fb36cd4b068cc", + "size": 61795 }, { "url": "https://code.claude.com/docs/en/troubleshooting", @@ -4755,8 +5259,8 @@ "url": "https://code.claude.com/docs/en/errors", "status": "success", "path": "en/docs/claude-code/errors.md", - "sha256": "32c4fcb81f56eba9c3910380535b50066ebd24eb0eb23acd29b153b4d2c0ccb2", - "size": 277422 + "sha256": "d3b98519b17a7e4509ad703ecc2ccc164e78dbbb8f4a879a25bd7eac5011aa7e", + "size": 292649 }, { "url": "https://code.claude.com/docs/en/admin-setup", @@ -4790,8 +5294,8 @@ "url": "https://code.claude.com/docs/en/server-managed-settings", "status": "success", "path": "en/docs/claude-code/server-managed-settings.md", - "sha256": "cacf4534ccc6151ee4544237376c7665fad4dc73b371156041cd48defd3788ff", - "size": 38988 + "sha256": "a5dc7874a8267d0556e846cc6088241f92438cb69837ba3efe85c4a8b49e4c53", + "size": 39820 }, { "url": "https://code.claude.com/docs/en/managed-mcp", @@ -4853,8 +5357,8 @@ "url": "https://code.claude.com/docs/en/network-config", "status": "success", "path": "en/docs/claude-code/network-config.md", - "sha256": "f1630e2968ba58876c00da71abaa797b040b8b18eabcb3dc12a1c154a2a684c7", - "size": 32001 + "sha256": "b3fcabdfeee9fb795c9da0f2bc74c405d5b18ce810f3c45b7abf6dfa2c346038", + "size": 33417 }, { "url": "https://code.claude.com/docs/en/corporate-launcher", @@ -4993,8 +5497,8 @@ "url": "https://code.claude.com/docs/en/plugin-relevance", "status": "success", "path": "en/docs/claude-code/plugin-relevance.md", - "sha256": "e0ad4269e108a36538be65b279a2508d2452426e26c83b801844548d3836397f", - "size": 15695 + "sha256": "f3ada8f0a213276b07a5d781e3d36226920e4746949376a1c650439ef4a3e523", + "size": 15875 }, { "url": "https://code.claude.com/docs/en/security", @@ -5007,15 +5511,15 @@ "url": "https://code.claude.com/docs/en/data-usage", "status": "success", "path": "en/docs/claude-code/data-usage.md", - "sha256": "25ed5e6074dbcae2e7dab15c6567f80cbbb146dd3bfda1ac169974c51cf9b62a", - "size": 21519 + "sha256": "9ab0b5b391a7c313b4fd1221349203b93a33fd29c2e40edaed7d0ade68f132b7", + "size": 22094 }, { "url": "https://code.claude.com/docs/en/zero-data-retention", "status": "success", "path": "en/docs/claude-code/zero-data-retention.md", - "sha256": "218ed0e3c97a0f8f6f17679d701f1d1e77d844b65ebd54aef0e1f7eb929aaf95", - "size": 8826 + "sha256": "8d25777cb26c94442d949bd7d0d0c5dcb53b7523548fabcd3c905ae9edf4f81e", + "size": 8995 }, { "url": "https://code.claude.com/docs/en/communications-kit", @@ -5042,8 +5546,8 @@ "url": "https://code.claude.com/docs/en/settings-reference", "status": "success", "path": "en/docs/claude-code/settings-reference.md", - "sha256": "5698a78752ec964c722277a6cab4a272e8acc30285cd860ea99a685c40e031c3", - "size": 380320 + "sha256": "3eccaae80b178050ddbe20e3bde2c18b99b3c7405b16036cca018500c07b0d83", + "size": 387098 }, { "url": "https://code.claude.com/docs/en/settings-example", @@ -5063,8 +5567,8 @@ "url": "https://code.claude.com/docs/en/permission-modes", "status": "success", "path": "en/docs/claude-code/permission-modes.md", - "sha256": "b8ca26b4dcd5e836dcb97829ef92828a0bc21cfc1562c439dfde957ce9fc6ccc", - "size": 74983 + "sha256": "b6730978664876586667430ba1211c0c92821a41edec3fe8cb773132ada77dfb", + "size": 75000 }, { "url": "https://code.claude.com/docs/en/sandboxing", @@ -5084,8 +5588,8 @@ "url": "https://code.claude.com/docs/en/cloud-environments", "status": "success", "path": "en/docs/claude-code/cloud-environments.md", - "sha256": "72c2d776de7ba634344bd9614ba8bf5766c41d5434ded4f1e32ef1ae036dcd28", - "size": 58816 + "sha256": "81daae93ab32e8ca9c12dbe893485f2d9a6e2361c50902b0021ffcc8ff6a5829", + "size": 59018 }, { "url": "https://code.claude.com/docs/en/self-hosted-environments", @@ -5168,8 +5672,8 @@ "url": "https://code.claude.com/docs/en/terminal-config", "status": "success", "path": "en/docs/claude-code/terminal-config.md", - "sha256": "4e9fd51df62ff4ca4f688ad5e6bcfd0358de36636f671032b96d2948970a02a5", - "size": 23840 + "sha256": "cefa8ac06b77609d67777f2f7591a8b7e6f75528891a057cc9b56b03c5b66aa9", + "size": 24429 }, { "url": "https://code.claude.com/docs/en/fullscreen", @@ -5203,8 +5707,8 @@ "url": "https://code.claude.com/docs/en/keybindings", "status": "success", "path": "en/docs/claude-code/keybindings.md", - "sha256": "bf5a45c1bb93edf0c5f4fd01254735a5236e79835b42a5070fbe7cd5f06672e5", - "size": 34692 + "sha256": "90d13afcf8ccb4ea99665130bae14279788968603726dcfac54b8213a2512668", + "size": 35421 }, { "url": "https://code.claude.com/docs/en/cli-reference", @@ -5217,22 +5721,22 @@ "url": "https://code.claude.com/docs/en/commands", "status": "success", "path": "en/docs/claude-code/commands.md", - "sha256": "4cbaa03ff4d6a1a096ffc8187aa57ee8857642b3da10a1c8dd1287ad3b26e043", - "size": 160241 + "sha256": "4b744baca3f5b75496be13997ab94e45e4e610919c9fca55798c90407cb6c9b7", + "size": 160246 }, { "url": "https://code.claude.com/docs/en/env-vars", "status": "success", "path": "en/docs/claude-code/env-vars.md", - "sha256": "f5e59a5161443f12fbc34ef951e294244d1f53c9f459ae10325b9f856a4ec230", - "size": 467620 + "sha256": "dc824141c7e6306e91df33ab9aff9ac58f58bd0f40468bda1479772d157521d3", + "size": 469095 }, { "url": "https://code.claude.com/docs/en/tools-reference", "status": "success", "path": "en/docs/claude-code/tools-reference.md", - "sha256": "057f7d8c36d4e91cc7aaedde6426df16d2087cadb50fbef31253e5872b180445", - "size": 104684 + "sha256": "249471c844058c5424aa981b72055a0200c0a3c21c99ad934d3300b0875593fd", + "size": 111103 }, { "url": "https://code.claude.com/docs/en/interactive-mode", @@ -5252,15 +5756,15 @@ "url": "https://code.claude.com/docs/en/hooks", "status": "success", "path": "en/docs/claude-code/hooks.md", - "sha256": "279dd7dc054bb686426d8af376b9380f5705639bd90a5a1fde8e67cd126062eb", - "size": 291536 + "sha256": "26ca78bc9507b21fd8614fcad26fdea95ea1098464dd2afd6800287194c57fa6", + "size": 291938 }, { "url": "https://code.claude.com/docs/en/plugins-reference", "status": "success", "path": "en/docs/claude-code/plugins-reference.md", - "sha256": "74ee89d3f27de366fdfdfb17373d0f87e3ff969a6fa36feada0f8e8bc78ceaac", - "size": 112528 + "sha256": "0e29521599e531bd9cbcef8ffc14cb4079b371942ab238ac75ddfff98d019932", + "size": 113065 }, { "url": "https://code.claude.com/docs/en/channels-reference", @@ -5336,8 +5840,8 @@ "url": "https://code.claude.com/docs/en/agent-sdk/streaming-vs-single-mode", "status": "success", "path": "en/docs/claude-code/agent-sdk/streaming-vs-single-mode.md", - "sha256": "2069707484bdaf2f6b5cdf3d665fce355474b92481d903970b9e9d66a708fbff", - "size": 10385 + "sha256": "5ee9274f5fb9c379e98d68df64e87e61fd5e4a2455d20744ce00b92d3c72b6d0", + "size": 10313 }, { "url": "https://code.claude.com/docs/en/agent-sdk/user-input", @@ -5483,8 +5987,8 @@ "url": "https://code.claude.com/docs/en/agent-sdk/python", "status": "success", "path": "en/docs/claude-code/agent-sdk/python.md", - "sha256": "12836374e9bac6b2e32f14419c7d1249671c039567872c5584320f45c18b298f", - "size": 195291 + "sha256": "58a37e24bd3bfe9da9ccb2df148431f0d81b384a3b1ecf3e9a19010a9e58a0ae", + "size": 196518 }, { "url": "https://code.claude.com/docs/en/agent-sdk/migration-guide", @@ -8136,8 +8640,8 @@ "url": "https://support.claude.com/en/articles/8114491-get-started-with-claude", "status": "success", "path": "support/8114491-get-started-with-claude.md", - "sha256": "619564a17f6ed9cf43422373dbc81077fa4c7af4a3978c36b996f96a15e5dc1f", - "size": 5298 + "sha256": "51d68c5c32e4a02c12c1d50bd5d0ebc23595c0f7e1a7fc38db94aec14a945290", + "size": 5306 }, { "url": "https://support.claude.com/en/articles/8114494-how-up-to-date-is-claude-s-training-data", @@ -8213,8 +8717,8 @@ "url": "https://support.claude.com/en/articles/8230524-delete-or-rename-a-conversation", "status": "success", "path": "support/8230524-delete-or-rename-a-conversation.md", - "sha256": "60f92584805cfed4d5dd1ec56192ed97e0a24efd80c40dba58d50def36f1e140", - "size": 5897 + "sha256": "541070439d9c456116fa3873e8ad954bb3016cb230902dd7c9113e5fa098a753", + "size": 5873 }, { "url": "https://support.claude.com/en/articles/8241126-upload-files-to-claude", @@ -8283,8 +8787,8 @@ "url": "https://support.claude.com/en/articles/8325618-paid-plan-billing-faqs", "status": "success", "path": "support/8325618-paid-plan-billing-faqs.md", - "sha256": "55aeb2d3094e4753159767a90d6185bd4dceb63cb2a127ac2f18b62202b953b1", - "size": 4553 + "sha256": "9443a67ccb919cd475b18079dc2ed5977c2c915fd5ccc95fcd554184890c5663", + "size": 4551 }, { "url": "https://support.claude.com/en/articles/8325621-i-would-like-to-input-sensitive-data-into-my-chats-with-claude-who-can-view-my-conversations", @@ -8339,15 +8843,15 @@ "url": "https://support.claude.com/en/articles/8664678-change-the-model-effort-and-thinking-settings", "status": "success", "path": "support/8664678-change-the-model-effort-and-thinking-settings.md", - "sha256": "0927815a65f3b764bedc68f48b487fac8b233b0892656c461aac3c98c0d9a672", - "size": 4921 + "sha256": "2ed9aa4729b1c9873f2e0f5bc1a05e931b54008ecb7bbc8bab452804c3676ba7", + "size": 4887 }, { "url": "https://support.claude.com/en/articles/8887527-customizing-your-appearance-settings", "status": "success", "path": "support/8887527-customizing-your-appearance-settings.md", - "sha256": "5af06d3d1fa37718badaad6b2ce2063a10a123863b4b4c9e457a9fec1394ba5f", - "size": 1880 + "sha256": "5fec063c9bdb0c2280cee31caf24db81a2d253c4eb97b3e696595a883e78eb71", + "size": 1882 }, { "url": "https://support.claude.com/en/articles/8896518-does-anthropic-crawl-data-from-the-web-and-how-can-site-owners-block-the-crawler", @@ -8521,8 +9025,8 @@ "url": "https://support.claude.com/en/articles/9267400-move-your-personal-claude-account-to-a-team-or-enterprise-organization", "status": "success", "path": "support/9267400-move-your-personal-claude-account-to-a-team-or-enterprise-organization.md", - "sha256": "89ce3d93ee0edc63baef983007eac98b4bc9b39189eb12d48efb32e5e6fa2616", - "size": 9374 + "sha256": "b8b5e06c714e87fec7b2b39edf395c7e4fe654a363790a5014bbdd79dd37bec0", + "size": 9378 }, { "url": "https://support.claude.com/en/articles/9301722-updates-to-our-acceptable-use-policy-now-usage-policy-consumer-terms-of-service-and-privacy-policy", @@ -8577,8 +9081,8 @@ "url": "https://support.claude.com/en/articles/9519189-manage-project-visibility-and-sharing", "status": "success", "path": "support/9519189-manage-project-visibility-and-sharing.md", - "sha256": "91d4c8faff2593edaa1e28c599bf7e4b5a177a1fcb93f1228bae611d2a8acd0e", - "size": 8565 + "sha256": "cd13e0bd664543ca1d06c4f8348326f1620e7a47acac4629e8eef73fe3537a44", + "size": 8569 }, { "url": "https://support.claude.com/en/articles/9519291-what-is-anthropic-s-policy-for-handling-governmental-requests-for-user-information", @@ -8598,15 +9102,15 @@ "url": "https://support.claude.com/en/articles/9534590-cost-and-usage-reporting-in-the-claude-console", "status": "success", "path": "support/9534590-cost-and-usage-reporting-in-the-claude-console.md", - "sha256": "06d28e55d0b9cb8c40c83777fb4d3602529deaa000a765ae3f519ba835ac56ad", - "size": 5102 + "sha256": "0193b159f87e2d691f7dbb276b50518465363e40f195320bc48c2776e98da916", + "size": 5108 }, { "url": "https://support.claude.com/en/articles/9547008-publish-and-share-artifacts", "status": "success", "path": "support/9547008-publish-and-share-artifacts.md", - "sha256": "679c35f8d61157269219d9d85bf94653a962e85f93e713fe08c9137353a5ad77", - "size": 7336 + "sha256": "113809e0f348ac4b60647bb6ee06f96f1793efc42ce7de830cfd8ba00af9caaa", + "size": 7324 }, { "url": "https://support.claude.com/en/articles/9612887-install-claude-for-android", @@ -8682,7 +9186,7 @@ "url": "https://support.claude.com/en/articles/9927533-disable-public-projects-for-your-organization", "status": "success", "path": "support/9927533-disable-public-projects-for-your-organization.md", - "sha256": "57d5b35cf4b9394bf1e8bf27194176cbff20b6626ad9e86089153fb3bc8cb333", + "sha256": "509e30b31dc55a89fb7c84d026751e9ca384140e62e0e0f9aca06297ba52ea46", "size": 2580 }, { @@ -8822,15 +9326,15 @@ "url": "https://support.claude.com/en/articles/10310342-how-do-i-log-out-of-all-active-sessions", "status": "success", "path": "support/10310342-how-do-i-log-out-of-all-active-sessions.md", - "sha256": "784195dce01df905b3befbc0f3bd25427c2767e4573cb81a6804c0e3cb55dd71", - "size": 2496 + "sha256": "d04400595c59e10637ee67709b06721dcaed58a3c3b58b0924c5a9bf52b80873", + "size": 2494 }, { "url": "https://support.claude.com/en/articles/10366376-how-can-i-delete-my-claude-console-account", "status": "success", "path": "support/10366376-how-can-i-delete-my-claude-console-account.md", - "sha256": "73bf075a460f8e3f5b95b0280d23e1fd80ef79ab184af00372228325efd269e7", - "size": 3167 + "sha256": "8a3155402d1857c7903b4552efe33f748db16e0a4ef2535d0eb75d9b57125450", + "size": 3163 }, { "url": "https://support.claude.com/en/articles/10366389-how-can-i-get-higher-rate-limits-on-the-claude-api", @@ -8871,15 +9375,15 @@ "url": "https://support.claude.com/en/articles/10504844-manage-user-feedback-settings-on-team-and-enterprise-plans", "status": "success", "path": "support/10504844-manage-user-feedback-settings-on-team-and-enterprise-plans.md", - "sha256": "cdd3ead8e4504ca0840cb357a08b8ed328b6451cc4edb2f29b56d3067d57bd0e", - "size": 1036 + "sha256": "09ea97866cdce1c3cb3b084fd30b17cf69facf7631ef0e5e30c4098ae3d2f1f8", + "size": 1034 }, { "url": "https://support.claude.com/en/articles/10504853-manage-user-feedback-settings-on-claude-console", "status": "success", "path": "support/10504853-manage-user-feedback-settings-on-claude-console.md", - "sha256": "46ece9c521037045db6a69eb853a39c9e5f4e952d075d77f7eac8dce17d83267", - "size": 1003 + "sha256": "e18e344a46db47f57481ca7b034e4b6e346c15522a493c6d959f1860d779395d", + "size": 997 }, { "url": "https://support.claude.com/en/articles/10534883-use-the-claude-widget-on-android", @@ -8892,15 +9396,15 @@ "url": "https://support.claude.com/en/articles/10593882-share-and-unshare-chats", "status": "success", "path": "support/10593882-share-and-unshare-chats.md", - "sha256": "56f4d0149729998e2d9e8ea77792b1f1f1845f2c5ac0956fc08e436d96305386", - "size": 4020 + "sha256": "bcef09b60cef193ade2b9be2b490f8d7c37808f33aba7049d315c78351fa40c1", + "size": 4026 }, { "url": "https://support.claude.com/en/articles/10684626-enable-and-use-web-search", "status": "success", "path": "support/10684626-enable-and-use-web-search.md", - "sha256": "8517eb13d82f2695b8e1ed3a7a99ba872d1d40a43fb9dd220df5758d8f742487", - "size": 6370 + "sha256": "2b72de1c47e5a19cfd3a2f449c15f94e77c42cff85f75eb36b79de5b95eb0187", + "size": 6135 }, { "url": "https://support.claude.com/en/articles/10684638-report-block-and-remove-content-from-claude", @@ -8920,8 +9424,8 @@ "url": "https://support.claude.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop", "status": "success", "path": "support/10949351-getting-started-with-local-mcp-servers-on-claude-desktop.md", - "sha256": "9566970da27372b4853c7dea167a8fb06dec6da618ff6b24377a025e471eefb9", - "size": 8269 + "sha256": "a78cb18bb375be8716558290ccb926706cd64fa9d37fbf728e5cab3ae9fd2918", + "size": 8265 }, { "url": "https://support.claude.com/en/articles/11049741-what-is-the-max-plan", @@ -8962,8 +9466,8 @@ "url": "https://support.claude.com/en/articles/11101966-use-voice-mode", "status": "success", "path": "support/11101966-use-voice-mode.md", - "sha256": "a563e42b9049bdbf21281ae42457686e6b1174eb5722e16fee15c2b30dd084c7", - "size": 10548 + "sha256": "c52bd5eec47c6bc9b2904fba21f66dec4c4b97201e9af24a8f5fcbab26c67053", + "size": 10552 }, { "url": "https://support.claude.com/en/articles/11107691-why-is-a-coupon-or-promotion-not-available-for-my-account", @@ -9095,8 +9599,8 @@ "url": "https://support.claude.com/en/articles/11725453-set-up-the-claude-lti-in-canvas-by-instructure", "status": "success", "path": "support/11725453-set-up-the-claude-lti-in-canvas-by-instructure.md", - "sha256": "bacfba8167526290e95a7da537fee8001edaffd227f2fef530c523c11cc43e8e", - "size": 2750 + "sha256": "a2af5803722cb7f96f59a0fedf1acd1de0556f321b86b9d2696b55177755e339", + "size": 2746 }, { "url": "https://support.claude.com/en/articles/11732894-who-owns-and-manages-the-data-of-my-claude-for-education-account", @@ -9116,8 +9620,8 @@ "url": "https://support.claude.com/en/articles/11818288-why-am-i-being-asked-to-verify-my-payment-method", "status": "success", "path": "support/11818288-why-am-i-being-asked-to-verify-my-payment-method.md", - "sha256": "ed532c4c154d46b20c8da29337315663737815590d747b9c952ea054b728e1b7", - "size": 814 + "sha256": "fbdd3fcafa91178db30460f09708e96fc266bb695a415e4287ad4aa318b24241", + "size": 816 }, { "url": "https://support.claude.com/en/articles/11825384-how-to-update-claude-for-ios", @@ -9186,15 +9690,15 @@ "url": "https://support.claude.com/en/articles/12005970-manage-usage-credits-for-team-and-seat-based-enterprise-plans", "status": "success", "path": "support/12005970-manage-usage-credits-for-team-and-seat-based-enterprise-plans.md", - "sha256": "30594b55e86811f2569bfe6c984c53a79519524c4d98f6ff209e8fddf2890415", - "size": 9636 + "sha256": "40a1f538daf3904bdc1ce31d038c33e440554a50f4ff11a82b6c968a17eebd6d", + "size": 9634 }, { "url": "https://support.claude.com/en/articles/12012173-get-started-with-claude-in-chrome", "status": "success", "path": "support/12012173-get-started-with-claude-in-chrome.md", - "sha256": "c1c5ea5d3bdfcbf2b8539b196ef8a636957258ff33e8fbaa7a58d017ca9cd7c4", - "size": 14335 + "sha256": "a3c7501c88e3be796edbd3651692b88b28e2defc57d080e587b3141e7a046d9d", + "size": 14863 }, { "url": "https://support.claude.com/en/articles/12053672-what-happens-to-a-user-s-data-when-they-are-removed-from-a-team-or-enterprise-organization", @@ -9207,8 +9711,8 @@ "url": "https://support.claude.com/en/articles/12083917-change-your-team-plan-from-monthly-to-annual-billing", "status": "success", "path": "support/12083917-change-your-team-plan-from-monthly-to-annual-billing.md", - "sha256": "228b2b19a0b231786cc8f039cd2cba30524371275389fc5bec3634a069a160af", - "size": 1396 + "sha256": "99856f857ed0e9c459ce31a69135e11d12326ccf023c1eb791379a2d7a661a29", + "size": 1400 }, { "url": "https://support.claude.com/en/articles/12109679-creating-a-new-account-after-deletion", @@ -9221,8 +9725,8 @@ "url": "https://support.claude.com/en/articles/12111783-create-and-edit-files-with-claude", "status": "success", "path": "support/12111783-create-and-edit-files-with-claude.md", - "sha256": "ef15ce67ef7d9518dc4a3ccf0c59009597793d22c6d2ca0ea2873b4d9bf3ddcf", - "size": 17956 + "sha256": "2ab479b46d44608b402129c4dd7817ddd544fe13f98182acca8a2c2a93665950", + "size": 17960 }, { "url": "https://support.claude.com/en/articles/12119250-model-safety-bug-bounty-program", @@ -9249,22 +9753,22 @@ "url": "https://support.claude.com/en/articles/12157520-claude-code-usage-analytics", "status": "success", "path": "support/12157520-claude-code-usage-analytics.md", - "sha256": "94b6bb6d767019d5723d6c7764e4e8cf33dd0ef9eae0e8ad53c0010d13ee6fe9", - "size": 6427 + "sha256": "43d4b17842655c20528d61ae751a5e6f4b03e3d38b2ffb72179f8e2bbcaa00a0", + "size": 6431 }, { "url": "https://support.claude.com/en/articles/12260368-use-incognito-chats", "status": "success", "path": "support/12260368-use-incognito-chats.md", - "sha256": "5339bc2d0aa973fd1cbb0e42e82bbc6717cec9fac1308e0a7f3c7f78ec11a6af", - "size": 3594 + "sha256": "3a924261c8f7aa6a281e44df40158f864412b9653264fc1b9f1933908967f68d", + "size": 3596 }, { "url": "https://support.claude.com/en/articles/12293051-use-claude-in-xcode", "status": "success", "path": "support/12293051-use-claude-in-xcode.md", - "sha256": "d3146e7acfda1f002452cb4428bbf2088d5c710ecbb4a142e2850543fbc5ed8c", - "size": 1907 + "sha256": "f1c03fbc6c2502906f507ec94922451bcb1e5a6def332649c695665bc3800f6c", + "size": 1911 }, { "url": "https://support.claude.com/en/articles/12304248-manage-api-key-environment-variables-in-claude-code", @@ -9305,14 +9809,14 @@ "url": "https://support.claude.com/en/articles/12429409-manage-usage-credits-for-paid-claude-plans", "status": "success", "path": "support/12429409-manage-usage-credits-for-paid-claude-plans.md", - "sha256": "abcc9cd68a24feffe36a7913cc2427005b2a4e7180326e79d48f903a1bbca6e7", + "sha256": "1595fc2a33660222ed1e9e8cc80538409eaf39762446f4f3a4e028525dbcc48a", "size": 6414 }, { "url": "https://support.claude.com/en/articles/12466728-troubleshoot-claude-error-messages", "status": "success", "path": "support/12466728-troubleshoot-claude-error-messages.md", - "sha256": "5f2e313f995a11c9bb9385adb81c530e638feec3cba14a1a07470f931539c926", + "sha256": "bc19ea766513254193422f6b82933dce020b7fa499f4c696b7a0c19e0da1bef0", "size": 4232 }, { @@ -9333,7 +9837,7 @@ "url": "https://support.claude.com/en/articles/12512180-use-skills-in-claude", "status": "success", "path": "support/12512180-use-skills-in-claude.md", - "sha256": "5823d03a4d48cab5024f93920de9344f76cee6c2345af36310592110a69e5546", + "sha256": "3866cf4869d4d3f3439ca70485947f479688a57908bc00563e682d46d113f871", "size": 15546 }, { @@ -9354,8 +9858,8 @@ "url": "https://support.claude.com/en/articles/12592343-enabling-and-using-the-desktop-extension-allowlist", "status": "success", "path": "support/12592343-enabling-and-using-the-desktop-extension-allowlist.md", - "sha256": "b3401991e755632d3a5b02465181b22330da0a97103ce56e3a69ca2b08309d98", - "size": 5714 + "sha256": "f5a6716085a144c541335077f0f99a394c88624ad6f7870d3fb394e7fc562c57", + "size": 5712 }, { "url": "https://support.claude.com/en/articles/12611117-deploy-claude-desktop-for-macos", @@ -9368,8 +9872,8 @@ "url": "https://support.claude.com/en/articles/12618689-claude-code-on-the-web", "status": "success", "path": "support/12618689-claude-code-on-the-web.md", - "sha256": "00263f7b086ea4890826a6a843f9cc6a486142946e3bf71e5021cfa9aea5e93b", - "size": 10970 + "sha256": "ceba7cf91a9cd28979a1d30d58a4400ca61096fc77696e5f6eaa2d6b4aaacd81", + "size": 10968 }, { "url": "https://support.claude.com/en/articles/12622667-enterprise-configuration-for-claude-desktop", @@ -9389,7 +9893,7 @@ "url": "https://support.claude.com/en/articles/12626668-use-quick-entry-with-claude-desktop-on-mac", "status": "success", "path": "support/12626668-use-quick-entry-with-claude-desktop-on-mac.md", - "sha256": "9e15892003857877bfabe21a8e252e1dcb0c379f63fc5d8ab3aaf540f5fdfeed", + "sha256": "8803c59477aba86a93ad052b2bfd56ad2bead180a634728d89c1a87fa6cf1db4", "size": 5970 }, { @@ -9424,8 +9928,8 @@ "url": "https://support.claude.com/en/articles/12883420-view-usage-analytics-for-team-and-enterprise-plans", "status": "success", "path": "support/12883420-view-usage-analytics-for-team-and-enterprise-plans.md", - "sha256": "3db7b9f003955d90c299ecd3783c1ed4aeaa009958adca32de4aa358b25662c9", - "size": 13185 + "sha256": "e3aad852c25e68ea931f456ae9124fdd994873ef3e4c902a6489774758524a4f", + "size": 13171 }, { "url": "https://support.claude.com/en/articles/12902405-claude-in-chrome-troubleshooting", @@ -9445,8 +9949,8 @@ "url": "https://support.claude.com/en/articles/12902446-claude-in-chrome-permissions-guide", "status": "success", "path": "support/12902446-claude-in-chrome-permissions-guide.md", - "sha256": "60d7d06e093c8d8625d2be3e534e1e539bf3ebe21eb4f9625c04dc1bc229aa3b", - "size": 9563 + "sha256": "aafddaf573f21747d517224334fefff552e8f19ec86e442b30a2d00e4bea9af6", + "size": 9567 }, { "url": "https://support.claude.com/en/articles/12938627-how-to-gift-a-claude-subscription", @@ -9473,15 +9977,15 @@ "url": "https://support.claude.com/en/articles/12997503-team-plan-billing-faqs", "status": "success", "path": "support/12997503-team-plan-billing-faqs.md", - "sha256": "45b6eb91ab8defcb44e450220f517dc1a8f82241eeffe7ddb2f40ccf256c7ad3", - "size": 4008 + "sha256": "d3ecb86d67c12bd343b1845aa5b986016d4b97e576452256f84f2cd44a0d077a", + "size": 4006 }, { "url": "https://support.claude.com/en/articles/13015708-access-the-compliance-api", "status": "success", "path": "support/13015708-access-the-compliance-api.md", - "sha256": "87e18a392611a3773171f4d5a8e8b567593dad913e99dd2dfc4e004dfe3d34c9", - "size": 1867 + "sha256": "49a2dab005fb27bd002dc988a484b70bbb3840279196e85d570af9027f5f3fd0", + "size": 1978 }, { "url": "https://support.claude.com/en/articles/13047024-how-to-get-support-for-claude-for-government", @@ -9494,8 +9998,8 @@ "url": "https://support.claude.com/en/articles/13065128-claude-in-chrome-admin-controls", "status": "success", "path": "support/13065128-claude-in-chrome-admin-controls.md", - "sha256": "3930039a0b18615d2f278e95c53e54eabd25818d3d6926981a54ac51c78b4827", - "size": 8541 + "sha256": "eb1af62b05211ab4de3b00d4b7c8b486c559a8da9e451952925a29e7f16ce343", + "size": 8949 }, { "url": "https://support.claude.com/en/articles/13117299-minimum-age-requirement-access-restriction", @@ -9522,14 +10026,14 @@ "url": "https://support.claude.com/en/articles/13132885-set-up-single-sign-on-sso", "status": "success", "path": "support/13132885-set-up-single-sign-on-sso.md", - "sha256": "56c675a581571dee475f3750b5e6a19d3d213d7b486bf4d9106c2583b3fc91c8", + "sha256": "998d411dd2d7f2afe88d1c48b96d1653b5aa64b8c0b689cd9efe3439b7901fe0", "size": 12319 }, { "url": "https://support.claude.com/en/articles/13133195-set-up-jit-or-scim-provisioning", "status": "success", "path": "support/13133195-set-up-jit-or-scim-provisioning.md", - "sha256": "f437f318d74cf3faceb6facab06538df63f10d5b35e5624057534738231324ce", + "sha256": "34ec5954a457d3abdfbba93480e2283a951e9dbf4e52072681851b45706cecc6", "size": 19495 }, { @@ -9557,8 +10061,8 @@ "url": "https://support.claude.com/en/articles/13163631-configuring-session-security-settings", "status": "success", "path": "support/13163631-configuring-session-security-settings.md", - "sha256": "1f5822e8ae2afd239b337a0afe1b3d538b1918669076deec9e40f124a13306dd", - "size": 3700 + "sha256": "33a1eea375f73ed86eebb474b352e6cb7d19f147f44cc382635c4771ce8a9303", + "size": 3708 }, { "url": "https://support.claude.com/en/articles/13163666-holiday-2025-usage-promotion", @@ -9578,8 +10082,8 @@ "url": "https://support.claude.com/en/articles/13189465-log-in-to-your-claude-account", "status": "success", "path": "support/13189465-log-in-to-your-claude-account.md", - "sha256": "4a78f61797bb68e21b6f994453e9e75554e2235b57bfc595c75425d1c1a66e7b", - "size": 7036 + "sha256": "55629242f8d9c9b468560a0006306fbd727461736d531e1bece4d9173a1eb59c", + "size": 7038 }, { "url": "https://support.claude.com/en/articles/13198485-enforce-network-level-access-control-with-tenant-restrictions", @@ -9606,22 +10110,22 @@ "url": "https://support.claude.com/en/articles/13325567-account-management-faqs", "status": "success", "path": "support/13325567-account-management-faqs.md", - "sha256": "cda4c7af0b91650ef3e9485b625e55c4c76c74cbe6d303689ab51b36acdf8756", - "size": 2634 + "sha256": "265f9c8c066b2dcb437fbe0ddd9951dca27354ed5ac86adf9ae2d758039555e1", + "size": 2632 }, { "url": "https://support.claude.com/en/articles/13345190-get-started-with-claude-cowork", "status": "success", "path": "support/13345190-get-started-with-claude-cowork.md", - "sha256": "f59145a2b8099e948c51f2169f8a00827ae60d4883756bcbf9f47a2ae13953b4", - "size": 20915 + "sha256": "a68fef87c235530bed1b9ded4905907ae7e2ce80a275178a75463de8a8c446e7", + "size": 21374 }, { "url": "https://support.claude.com/en/articles/13346458-customizing-your-console-appearance-settings", "status": "success", "path": "support/13346458-customizing-your-console-appearance-settings.md", - "sha256": "c77fbab4a14a63708254dd4830dd9c5b3ba8523cc1f608b63dd25053918e5ecd", - "size": 613 + "sha256": "3027303191665754be9ea98b9a00d2748de9f508e693449c17a7177c288d168e", + "size": 605 }, { "url": "https://support.claude.com/en/articles/13346720-export-your-organization-s-data", @@ -9634,15 +10138,15 @@ "url": "https://support.claude.com/en/articles/13364135-use-claude-cowork-safely", "status": "success", "path": "support/13364135-use-claude-cowork-safely.md", - "sha256": "840e0562f64bff51600fc942946d8b599f2037402abdb733d28e28638191f48a", - "size": 16485 + "sha256": "07fc5cca20d5a45a0355547eeabfa3bbd0febcd2988504f4054baac13282d321", + "size": 16729 }, { "url": "https://support.claude.com/en/articles/13371040-log-in-to-your-console-account", "status": "success", "path": "support/13371040-log-in-to-your-console-account.md", - "sha256": "e1577e88e9f7ae25592ce34b89dd75aa2d4722916580982a826214a4ce825323", - "size": 4613 + "sha256": "dce07f22918ad87a87a5a8a029d3281b160dc0f21e633d6c8b082b5b32cced14", + "size": 4611 }, { "url": "https://support.claude.com/en/articles/13393991-purchase-and-manage-seats-on-enterprise-plans", @@ -9683,8 +10187,8 @@ "url": "https://support.claude.com/en/articles/13455879-use-claude-cowork-on-team-and-enterprise-plans", "status": "success", "path": "support/13455879-use-claude-cowork-on-team-and-enterprise-plans.md", - "sha256": "6b86d5e2e2a386ef6c8d75a0ee31e06084775fcef75097f444582305be2ff165", - "size": 11469 + "sha256": "f2b38e9ce4638eeec99f7e54aaa7e3823227db6bb77ca3040f4f334159c78767", + "size": 12789 }, { "url": "https://support.claude.com/en/articles/13566435-find-and-join-a-team-or-enterprise-organization", @@ -9697,8 +10201,8 @@ "url": "https://support.claude.com/en/articles/13641943-visual-and-interactive-content", "status": "success", "path": "support/13641943-visual-and-interactive-content.md", - "sha256": "03a9daf805059e7677a8b3bfda278e181d5751828b18a53a0cc2af5a9f743dc9", - "size": 6515 + "sha256": "71c40d294a568327acd3a9655601c72729b6515421b0f293edb1d15f1ad3cf0c", + "size": 6509 }, { "url": "https://support.claude.com/en/articles/13663666-use-visual-and-interactive-content-on-team-and-enterprise-plans", @@ -9725,8 +10229,8 @@ "url": "https://support.claude.com/en/articles/13756069-public-sector-faqs", "status": "success", "path": "support/13756069-public-sector-faqs.md", - "sha256": "c850d39646acbe0df0cea40510f482570c83dc7e845722c2f5f9f0551d73ab6e", - "size": 8378 + "sha256": "aee7074b33bfeebb83e97a10148da5e2d5d6faa0e4d1fbbde957b59f97a5b126", + "size": 8380 }, { "url": "https://support.claude.com/en/articles/13776697-join-an-organization-via-invite-link", @@ -9753,22 +10257,22 @@ "url": "https://support.claude.com/en/articles/13837433-manage-plugins-for-your-organization", "status": "success", "path": "support/13837433-manage-plugins-for-your-organization.md", - "sha256": "b01a0bdfdaea6c45aaf665b0a773e3be1616fc11e4e784397fbddce776bb0039", + "sha256": "85b8662b02a98cddc8bbf9d7690a1845296d8ad2de2bdc2a2950f88fe49a6691", "size": 20825 }, { "url": "https://support.claude.com/en/articles/13837440-use-plugins-in-claude", "status": "success", "path": "support/13837440-use-plugins-in-claude.md", - "sha256": "e145fc2d9b2a3808e523a83ff080bed9575033d0f66f85d8d134ba2ca5a076c3", + "sha256": "45c45e06efec4adede65a79fd14ad0bdcdae80bc4b1f01c2932352baea41be95", "size": 6716 }, { "url": "https://support.claude.com/en/articles/13854387-schedule-recurring-tasks-in-claude-cowork", "status": "success", "path": "support/13854387-schedule-recurring-tasks-in-claude-cowork.md", - "sha256": "9ce6da151387335f8666d7cecded8df186e8bed0d7d40c9a52db5d82b0316e68", - "size": 4747 + "sha256": "1c2f8db93c94e0fa836bfbdc7b0dd623ed9dfa0116c315e5b7d413f0fccfc0b7", + "size": 4777 }, { "url": "https://support.claude.com/en/articles/13917817-google-workspace-sso-scim-email-mismatch", @@ -9858,8 +10362,8 @@ "url": "https://support.claude.com/en/articles/13947068-assign-tasks-from-anywhere-in-claude-cowork", "status": "success", "path": "support/13947068-assign-tasks-from-anywhere-in-claude-cowork.md", - "sha256": "994e629fc27aea507bc169e25f752b9ce3bad4059924a62e33a5ca6c22dcfa14", - "size": 8276 + "sha256": "c2afeea58bbf19f730458d2436c92ce6675c4ed9d999ef69eb843a95625a11d2", + "size": 8338 }, { "url": "https://support.claude.com/en/articles/13979539-custom-visuals-in-chat-and-cowork", @@ -9879,22 +10383,22 @@ "url": "https://support.claude.com/en/articles/14116274-organize-your-tasks-with-projects-in-claude-cowork", "status": "success", "path": "support/14116274-organize-your-tasks-with-projects-in-claude-cowork.md", - "sha256": "d5d558e19a16c2babdc6bc77a50defad4f6bda6075484c810662d5bb0a0df116", - "size": 5700 + "sha256": "d51f041a17c39fb2cf860dcf97250e6942487a35da15769cc5091ed3fab24174", + "size": 5758 }, { "url": "https://support.claude.com/en/articles/14128542-let-claude-use-your-computer-in-cowork", "status": "success", "path": "support/14128542-let-claude-use-your-computer-in-cowork.md", - "sha256": "02cda071443404178693d7c69ff48c7e06ac2a01b0f04a8fd0816d0fff74e313", - "size": 8776 + "sha256": "cde6fc9520a17934a332f8eef163c6605feb7c33e60a3b42f8f1c46489e5868d", + "size": 8971 }, { "url": "https://support.claude.com/en/articles/14128775-claude-code-on-console-to-enterprise-migration", "status": "success", "path": "support/14128775-claude-code-on-console-to-enterprise-migration.md", - "sha256": "d5ea98f2af10d1846df9530003972609207bfa6379f5351fbfc4c00f3e6bab95", - "size": 35104 + "sha256": "ee952e5d72df9c60a984f19cb18bc98b729caa8dccd0fb04eaac3eb7d8a44c2d", + "size": 35024 }, { "url": "https://support.claude.com/en/articles/14233555-set-up-code-review-for-claude-code", @@ -9935,8 +10439,8 @@ "url": "https://support.claude.com/en/articles/14477985-monitor-claude-cowork-activity-with-opentelemetry", "status": "success", "path": "support/14477985-monitor-claude-cowork-activity-with-opentelemetry.md", - "sha256": "db440aa9cba6a31f5a3b54ac951a567b19ecedfec9f2535adf98dffe02c07596", - "size": 4621 + "sha256": "3e58d55756ad05380cf46155e43a05ade74fb0653de1c542e926e15fafb7abfc", + "size": 4613 }, { "url": "https://support.claude.com/en/articles/14479288-claude-cowork-architecture-overview", @@ -9949,8 +10453,8 @@ "url": "https://support.claude.com/en/articles/14499648-how-scim-sync-works-for-enterprise-organizations", "status": "success", "path": "support/14499648-how-scim-sync-works-for-enterprise-organizations.md", - "sha256": "903919b62bb097217be79db07b5db881da62f81717563b68c9f1afae8015eadf", - "size": 7444 + "sha256": "7a33eb86687033fb657183c29e74118730f4e4a49fb7c2360deffc1b194fde94", + "size": 7438 }, { "url": "https://support.claude.com/en/articles/14503520-available-beta-and-research-preview-features", @@ -9970,15 +10474,15 @@ "url": "https://support.claude.com/en/articles/14503613-sso-login", "status": "success", "path": "support/14503613-sso-login.md", - "sha256": "4f704fb63c628275adfca5168d07b04cbd248ff0b0e88c661e1e40ab83417fc7", - "size": 6686 + "sha256": "9902b719d91a1e6bced891d7ac0553be3a2fd604e75d12369da6be0031dc0b9f", + "size": 6688 }, { "url": "https://support.claude.com/en/articles/14503643-set-up-scim-in-claude-for-government", "status": "success", "path": "support/14503643-set-up-scim-in-claude-for-government.md", - "sha256": "b772fa2e417deb3c6bede825960e1dfeabfa7f8155dd4d78e7932521c1a170d7", - "size": 6421 + "sha256": "225c7d784ccd2e6640680287694a2a1b67196ff198d1b7e91396293377902acc", + "size": 6419 }, { "url": "https://support.claude.com/en/articles/14503675-organization-instructions-in-claude-for-government", @@ -10005,8 +10509,8 @@ "url": "https://support.claude.com/en/articles/14503775-mcp-web-search", "status": "success", "path": "support/14503775-mcp-web-search.md", - "sha256": "e6d25158cade3298a6be2ad22c41181bd30efa5f739f29a1816c896f5d0c79f3", - "size": 4679 + "sha256": "27d42abfe13937d33a2ad78ff2982d7a80b4ca6843d25539ebf4993452651bd6", + "size": 4675 }, { "url": "https://support.claude.com/en/articles/14503794-model-availability-in-claude-for-government", @@ -10075,8 +10579,8 @@ "url": "https://support.claude.com/en/articles/14554000-claude-code-power-user-tips", "status": "success", "path": "support/14554000-claude-code-power-user-tips.md", - "sha256": "fc08c3cee03217bd5628b5ab53f5325196186cb106ceae2f7f0b080c7e594a8d", - "size": 25413 + "sha256": "26038e5799723fee49f5086d44e857e57752144d9834b34c9e2b14ff7e20ab95", + "size": 25423 }, { "url": "https://support.claude.com/en/articles/14554922-claude-code-user-faq", @@ -10103,21 +10607,21 @@ "url": "https://support.claude.com/en/articles/14604397-set-up-your-design-system-in-claude-design", "status": "success", "path": "support/14604397-set-up-your-design-system-in-claude-design.md", - "sha256": "002ea4303a386bfd80e9bc3386daa19e1f38d2df1216a05d7a6c8b94f5e12252", - "size": 4398 + "sha256": "9c5cb9305362365b780099be29b87fef46022bc34f101b28dc547b4b77b6461b", + "size": 4394 }, { "url": "https://support.claude.com/en/articles/14604406-claude-design-admin-guide-for-team-and-enterprise-plans", "status": "success", "path": "support/14604406-claude-design-admin-guide-for-team-and-enterprise-plans.md", - "sha256": "4d3eac22ba02fb4e9c963c481c71504d0bbb23e0784ec2c054238ae8ef90779c", + "sha256": "110874cbc13e930339005b39e8dfed21434e7ad322d577f1bb38e5db73515ad2", "size": 12733 }, { "url": "https://support.claude.com/en/articles/14604416-get-started-with-claude-design", "status": "success", "path": "support/14604416-get-started-with-claude-design.md", - "sha256": "21d2030f9650d11264b7afd39386226c679782c153f9422c9296101769833c01", + "sha256": "1ea9f28d07edd4490c0640ab70fc890f4be09d077e9ada6cf2886f2a4685e68b", "size": 11132 }, { @@ -10208,8 +10712,8 @@ "url": "https://support.claude.com/en/articles/15167101-get-started-with-claude-compliance-api-integrations", "status": "success", "path": "support/15167101-get-started-with-claude-compliance-api-integrations.md", - "sha256": "528393728cc73acb294f731bb24d3c2bbe53d23d064d12ff3f11adf7b923f170", - "size": 44370 + "sha256": "29b470a8fac6892e590d509a2b34f886cf2a069f5cbf462a1930bc7571001002", + "size": 44713 }, { "url": "https://support.claude.com/en/articles/15171100-age-assurance-on-claude", @@ -10243,7 +10747,7 @@ "url": "https://support.claude.com/en/articles/15330088-set-a-default-model-for-your-organization", "status": "success", "path": "support/15330088-set-a-default-model-for-your-organization.md", - "sha256": "35988b9e92d0817e6a13a1cdc59b7d562348f80d48dd4154529b88dca2cb995b", + "sha256": "3228b5ed543094a8df58f1123bf888ce842e233ef0c29d1c06701c03c4deb5b0", "size": 5740 }, { @@ -10313,8 +10817,8 @@ "url": "https://support.claude.com/en/articles/15520349-use-claude-cowork-on-web-desktop-and-mobile", "status": "success", "path": "support/15520349-use-claude-cowork-on-web-desktop-and-mobile.md", - "sha256": "f82d1820eeaf3105a410181b369930c79c41286ce8d204b0529d7eaf8017019d", - "size": 7044 + "sha256": "f0cd04c2d8ad62c20161e52eda71b8ac371954d2c6e1d707bdf59760d0eae749", + "size": 7533 }, { "url": "https://support.claude.com/en/articles/15537633-authorize-mcp-connectors-for-your-entire-organization", @@ -10355,15 +10859,15 @@ "url": "https://support.claude.com/en/articles/15694740-manage-model-access-for-your-organization", "status": "success", "path": "support/15694740-manage-model-access-for-your-organization.md", - "sha256": "6afe0b48950f8d040e2e43d390b5805600d9762880c57538dca7a6450135c5d0", + "sha256": "ff56efdced4149002185cc86e1981727867a65f2c49ec0a05e2b0a19243f98f9", "size": 8505 }, { "url": "https://support.claude.com/en/articles/15707726-using-claude-for-legal-work-privilege-confidentiality-and-how-to-think-about-configuration", "status": "success", "path": "support/15707726-using-claude-for-legal-work-privilege-confidentiality-and-how-to-think-about-configuration.md", - "sha256": "46b3959ec863d88662ab502f9f5f5ab7fea8e092c43e7f5785deff3f884995a4", - "size": 9265 + "sha256": "30bd2f279a500182656e4ac9e9281a2a19dedabbc5c2dde9b9ae7ff4ed4822b5", + "size": 9223 }, { "url": "https://support.claude.com/en/articles/15924927-use-claude-code-cli-with-a-screen-reader", @@ -10390,7 +10894,7 @@ "url": "https://support.claude.com/en/articles/15936181-get-started-with-1password-for-claude", "status": "success", "path": "support/15936181-get-started-with-1password-for-claude.md", - "sha256": "fa9b0769198d9084504341af893c885f35f22a2e9145b2e6b0f2edae9621fea6", + "sha256": "8e506db2fe1cb3602fa28b543d0789677db4fef679f976b377dc99c9459a661a", "size": 5058 }, { @@ -10425,8 +10929,8 @@ "url": "https://support.claude.com/en/articles/16607638-understanding-your-pro-or-max-plan-invoices", "status": "success", "path": "support/16607638-understanding-your-pro-or-max-plan-invoices.md", - "sha256": "d91675798f9f0b4635cc39687a93f28ab764be2229e66e88295f801bfcc0cb8a", - "size": 5447 + "sha256": "696aafe938ec2e45f2f938c004b8ee0b4e4967fa0daa5169c72e9f99f3d73aed", + "size": 5441 }, { "url": "https://support.claude.com/en/articles/16607668-understanding-your-team-plan-invoices", @@ -10649,29 +11153,29 @@ "url": "https://claude.com/docs/claude-tag/admins/add-connections", "status": "success", "path": "claude/claude-tag/admins/add-connections.md", - "sha256": "e5bcf949a05cc6207fc984fcc61a0c7f7db052bd947e50eb7795e9eaba692fb1", - "size": 31144 + "sha256": "27e180387465f2047271d3bce6d4ba323cbb3c56739d584db3680c69f1cadb8e", + "size": 30286 }, { "url": "https://claude.com/docs/claude-tag/admins/attach-to-scope", "status": "success", "path": "claude/claude-tag/admins/attach-to-scope.md", - "sha256": "8bb5c0c9c162161ee54e594ea107124f1a3c61d635452ea39803e779668ccff1", - "size": 16693 + "sha256": "84016533726e03949e1d6e7ad09fab040a1e75c5fe804bc823f2a356c83adb63", + "size": 17174 }, { "url": "https://claude.com/docs/claude-tag/admins/audit", "status": "success", "path": "claude/claude-tag/admins/audit.md", - "sha256": "8105d628c53ec78932e72ea16f3684e991860fbc077f1a5e264a4ef0b031c0c2", - "size": 4598 + "sha256": "decff742b5c2b74ad5f330f4673a75f434329da34c366d1fa9e4225a64d9c238", + "size": 4587 }, { "url": "https://claude.com/docs/claude-tag/admins/configure-github", "status": "success", "path": "claude/claude-tag/admins/configure-github.md", - "sha256": "ffdfeb454ece4e299ae8b46593978c7add1b2fb474a44ad4d8a8fe14f77dd659", - "size": 12744 + "sha256": "59c37cf2fba0ad6cd4d5aeeefce3309953b06574e9774c398effd2e12d845552", + "size": 12934 }, { "url": "https://claude.com/docs/claude-tag/admins/configure-gitlab", @@ -10810,8 +11314,8 @@ "url": "https://claude.com/docs/claude-tag/admins/customize", "status": "success", "path": "claude/claude-tag/admins/customize.md", - "sha256": "71c876d84263b0efa85bdc7578347d63df704afd8ab03bdf5b04d1b016a23362", - "size": 21171 + "sha256": "ba9586a14eb1395c1f038f89ffb627c4bd85e7c458f2e446e60e28ed1e4595df", + "size": 22523 }, { "url": "https://claude.com/docs/claude-tag/admins/for-slack-admins", @@ -10845,8 +11349,8 @@ "url": "https://claude.com/docs/claude-tag/admins/restrict-access", "status": "success", "path": "claude/claude-tag/admins/restrict-access.md", - "sha256": "0984c8cb7cf6b3d446f266df65c194a88a48418440a564b11fc5f25a6851e1ee", - "size": 41341 + "sha256": "876fda4fd6ef433c448b224ff1ff895460805a269d3ba58cb148ad8f849a3515", + "size": 44039 }, { "url": "https://claude.com/docs/claude-tag/admins/set-spend-limit", @@ -10880,14 +11384,14 @@ "url": "https://claude.com/docs/claude-tag/admins/troubleshooting", "status": "success", "path": "claude/claude-tag/admins/troubleshooting.md", - "sha256": "181b01fe9e5f2e6aabf0a6c6ff885de7094c3cbb8df5408209686dd87329da37", - "size": 43740 + "sha256": "4df0e623e07de034fddb8703bfb5a9aa4bc9f051967af883f71edbf4f4e01060", + "size": 43572 }, { "url": "https://claude.com/docs/claude-tag/admins/workspaces", "status": "success", "path": "claude/claude-tag/admins/workspaces.md", - "sha256": "dd2a4afce5afbdd0cddaff2fcd2718639c2b03b54242fb0c7122530c761b5fbc", + "sha256": "380706d1b84bb5dd22a0160c49fa09e613471ed2b5b31db205f4e407e39e3a73", "size": 8422 }, { @@ -10908,8 +11412,8 @@ "url": "https://claude.com/docs/claude-tag/concepts/for-claude-code-users", "status": "success", "path": "claude/claude-tag/concepts/for-claude-code-users.md", - "sha256": "febde1505115597fff6f0c90f88328c691297b1dcd5efb225fa64c3a182b6e73", - "size": 12330 + "sha256": "ec64d244a7aa5444b9d25376224dedbea5c857c7fb34ad4593711a922112fd38", + "size": 13465 }, { "url": "https://claude.com/docs/claude-tag/concepts/glossary", @@ -10936,7 +11440,7 @@ "url": "https://claude.com/docs/claude-tag/concepts/settings-map", "status": "success", "path": "claude/claude-tag/concepts/settings-map.md", - "sha256": "44e62970d8e8b176156cedcb8c830665bdd384a4f2eca8aa7e7769500df4b154", + "sha256": "2b53b36c19b26cc10ae15d6740e195c9f0d7b271d6ff488f47c09c0bba7ab155", "size": 11266 }, { @@ -10957,8 +11461,8 @@ "url": "https://claude.com/docs/claude-tag/users/getting-started", "status": "success", "path": "claude/claude-tag/users/getting-started.md", - "sha256": "c5089019ef81ce4e8181994c3ba8ac2feca387effdbe0a83433b902ab93ea303", - "size": 14712 + "sha256": "55e36a2db01aa6ba9389764c886b3241252f1e8c99bc6397fec7b134f46fbd4f", + "size": 14577 }, { "url": "https://claude.com/docs/claude-tag/users/good-habits", @@ -10971,15 +11475,15 @@ "url": "https://claude.com/docs/claude-tag/users/memory", "status": "success", "path": "claude/claude-tag/users/memory.md", - "sha256": "b8dfd90dad6bc96aef91c9610f28cd16e7bf70d7e2988e75e5a5e71736b28bb0", - "size": 5394 + "sha256": "c4013657061a4d21a53afb3ef8454b02af5139c97188ac4f2933a9ee0e5ccc3d", + "size": 5372 }, { "url": "https://claude.com/docs/claude-tag/users/models", "status": "success", "path": "claude/claude-tag/users/models.md", - "sha256": "3376ea102efc19776520949d687b69f9fed55520a01990e3d75861e8a2663515", - "size": 3677 + "sha256": "5dcbbabb7b37afd9c2ff0d83b4534f0c8b230b798b3cc3e68e94efc46136b8b9", + "size": 3834 }, { "url": "https://claude.com/docs/claude-tag/users/proactivity", @@ -11090,8 +11594,8 @@ "url": "https://claude.com/docs/claude-tag/users/use-cases/work-with-github", "status": "success", "path": "claude/claude-tag/users/use-cases/work-with-github.md", - "sha256": "3b727d7aae4beb93c6dbe745d7dbe0a4e39c4c2b6aff7beda6b0adce31c1d112", - "size": 10025 + "sha256": "2a4df1960b4f95d47c003b17fc968211f899c5fc4517c0a2b922330cf98f88ba", + "size": 10052 }, { "url": "https://claude.com/docs/claude-tag/users/use-cases/your-own-channel", @@ -11342,8 +11846,8 @@ "url": "https://claude.com/docs/cowork/changelog", "status": "success", "path": "claude/cowork/changelog.md", - "sha256": "5d7c339a701404937417fedb38e1e2cc6ed56d440fcb30d575b6b8e79b1dbfa6", - "size": 94867 + "sha256": "045685c854eb5131cbe8692aa0cce1d76c42d2784f4f44afed56c13a98c64a5d", + "size": 95498 }, { "url": "https://claude.com/docs/cowork/guide/dispatch", @@ -11412,8 +11916,8 @@ "url": "https://claude.com/docs/government/config/overview", "status": "success", "path": "claude/government/config/overview.md", - "sha256": "c978d07b69ad6af4a23b482f22cd9c4654f9d841d5c9b4d650230a75e8731cb7", - "size": 12584 + "sha256": "a0e28d33c79b3c3adece91fe96953f7cb99470a3bf0a7962fd275544e5b1d16c", + "size": 14354 }, { "url": "https://claude.com/docs/government/config/plugins-and-connectors", @@ -11440,8 +11944,8 @@ "url": "https://claude.com/docs/government/connectors/overview", "status": "success", "path": "claude/government/connectors/overview.md", - "sha256": "e216eb30377c7a1a08e85ff660c17e7f58e0f59e37b8c909c258a7262f5c1d2c", - "size": 6651 + "sha256": "50f52abb37b929ac0e5cd489b482289e8d58fc86cbbd516a5906e7326b26b1be", + "size": 9410 }, { "url": "https://claude.com/docs/government/deploy-desktop/configure", @@ -11510,8 +12014,8 @@ "url": "https://claude.com/docs/government/org-admin/configuration", "status": "success", "path": "claude/government/org-admin/configuration.md", - "sha256": "b47d14755269e259a5eb32102e4de0c38bc401b90f4f84c04740a93b8f5d55f5", - "size": 2635 + "sha256": "8cd0ce47290b948ac546ccb5b6dde25ea8df75bd2e1aab3577e66ebe58da4548", + "size": 2854 }, { "url": "https://claude.com/docs/government/org-admin/overview", @@ -11818,8 +12322,8 @@ "url": "https://claude.com/docs/third-party/claude-desktop/configuration-changelog", "status": "success", "path": "claude/third-party/claude-desktop/configuration-changelog.md", - "sha256": "64557a291f7294256632cf4236194e619b47e64d719a5013090d55b7aa8f6c8e", - "size": 45157 + "sha256": "0e39eb9705d3dfc44b5abef8b9796cc809ccec060b074d322b92c31eb241eefe", + "size": 45373 }, { "url": "https://claude.com/docs/third-party/claude-desktop/connectors-github", @@ -11972,15 +12476,15 @@ "url": "https://platform.claude.com/docs/en/api/csharp/models", "status": "success", "path": "en/api/csharp/models.md", - "sha256": "a5a8f392d1ad0dc0149fb99f34459c6e4307ad4b4d04066614ad2bec21ffe970", - "size": 22424 + "sha256": "26544d49161983137cca317f2d44c2fe68f1e5305e436fd42683ae0e2dcb2d2c", + "size": 22892 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta", "status": "success", "path": "en/api/csharp/beta.md", - "sha256": "423a447e4f166df0122baaf86e7aaf4c64f44e70e183de83c1c664d07635d038", - "size": 1690549 + "sha256": "7380ca6027038e1acb3be1e5e849156952240b3be4a5f31b92aeb2a194674fc8", + "size": 1970210 }, { "url": "https://platform.claude.com/docs/en/api/csharp/completions", @@ -12000,15 +12504,15 @@ "url": "https://platform.claude.com/docs/en/api/python/models", "status": "success", "path": "en/api/python/models.md", - "sha256": "c594d86b46da4533ae584c45cfa657a1346d1f1a0be2fa777c711bf2d4790990", - "size": 21741 + "sha256": "0e3cb20699464438f9b4c5d98db95cce46788cb29c7a04174ee145fa7379bb7a", + "size": 22267 }, { "url": "https://platform.claude.com/docs/en/api/python/beta", "status": "success", "path": "en/api/python/beta.md", - "sha256": "fbe29e5a7563dd41730e88b1df2d85c1118fbfb60ef3060bf194226c78f2ee54", - "size": 1791978 + "sha256": "8411f30f16352e350f62028ed329d026f1907c355dd905d0db3608541442c562", + "size": 2085336 }, { "url": "https://platform.claude.com/docs/en/api/python/completions", @@ -12028,22 +12532,22 @@ "url": "https://platform.claude.com/docs/en/api/java/models", "status": "success", "path": "en/api/java/models.md", - "sha256": "3aa1ac00b4f971ba2408ec08f76468fda26cbe720246c484512573bb7173d91e", - "size": 23810 + "sha256": "e75aad7f537d3f4b06fb69c3e82fc4400401703b65be8efa1057561604fea2fc", + "size": 24722 }, { "url": "https://platform.claude.com/docs/en/api/java/beta", "status": "success", "path": "en/api/java/beta.md", - "sha256": "e7179731bd41cb2938fe9fd6686080f6826b7f6229a544b58d195859fae846a5", - "size": 1836085 + "sha256": "53a6a403d7a478ef018ba70fccd50fe36f2422783160bea45ba2677bece3014f", + "size": 2198155 }, { "url": "https://platform.claude.com/docs/en/api/java/completions", "status": "success", "path": "en/api/java/completions.md", - "sha256": "e847d95f502b9eb572abfad60b1b4800c9e06cdc4de07fbb7c4443fa5ede0ee1", - "size": 12091 + "sha256": "9b5321f262a0255be007d8e391c09030ddcd664e50fd59c2bb0cce163068fb46", + "size": 12547 }, { "url": "https://platform.claude.com/docs/en/api/typescript/messages", @@ -12056,22 +12560,22 @@ "url": "https://platform.claude.com/docs/en/api/typescript/models", "status": "success", "path": "en/api/typescript/models.md", - "sha256": "91c516a70a18e4cd36283d75ad43f18bf9da7f1bd9994c0a4e7f8be921dc756a", - "size": 21957 + "sha256": "03b77089c1e60cc59bd6f5a964d234b4bbaa740f5f15cd504df87e113603a540", + "size": 22511 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta", "status": "success", "path": "en/api/typescript/beta.md", - "sha256": "69c0b0dcca028872353403fea704ecf4de951b4e1758fff4120ba69bd1a3bf5b", - "size": 1792188 + "sha256": "c8365c149b3bbb3f54c9bc3431e3b04027b0c3d148f3f46dcea642f63934a247", + "size": 2093860 }, { "url": "https://platform.claude.com/docs/en/api/typescript/completions", "status": "success", "path": "en/api/typescript/completions.md", - "sha256": "948426ae66c85646baedcc93f7b33baf310b83c5303a790f5ec5d0bab0f7732e", - "size": 13773 + "sha256": "389aa87f0d06a6fd3afa6af489ed5015f563fb3184d13b821f6c0eecc9699399", + "size": 14064 }, { "url": "https://platform.claude.com/docs/en/api/php/messages", @@ -12091,8 +12595,8 @@ "url": "https://platform.claude.com/docs/en/api/php/beta", "status": "success", "path": "en/api/php/beta.md", - "sha256": "c839695a0bd656ccdbc9efea1a028a55d950b7ee2a782d2874a91d9adb44489f", - "size": 451984 + "sha256": "dc529bcde700fb22d8ac85f957d6c2af33d12342ba2312e458c97ce37c56f48e", + "size": 617421 }, { "url": "https://platform.claude.com/docs/en/api/php/completions", @@ -12112,22 +12616,22 @@ "url": "https://platform.claude.com/docs/en/api/go/models", "status": "success", "path": "en/api/go/models.md", - "sha256": "afcef1c150a447aadb47ce96d0afc76897e88a0d030a28d62f751d2befbabe78", - "size": 25785 + "sha256": "547f6b544618df1e71660a27833a65c14785a2d2ee84298d7d0af17dbdedc3d4", + "size": 27171 }, { "url": "https://platform.claude.com/docs/en/api/go/beta", "status": "success", "path": "en/api/go/beta.md", - "sha256": "0fe079e574bfcc6723d7713986e499131cd32bc1555b5b6fbf2c260e85b01326", - "size": 2174156 + "sha256": "45ee433a725678102f3e5359c8ea36d28c11022d3d36ed3abee7c559de075bfe", + "size": 2609024 }, { "url": "https://platform.claude.com/docs/en/api/go/completions", "status": "success", "path": "en/api/go/completions.md", - "sha256": "e7fc4e79fcc90c343d74c74efc1721d299d37d549d2cea86d78001336df61a29", - "size": 14297 + "sha256": "927f74d14f8d508fc5e3b36c1c07eb5013d317669dd2aeb7387d4a1d6d0819c5", + "size": 14990 }, { "url": "https://platform.claude.com/docs/en/api/cli/messages", @@ -12147,8 +12651,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta", "status": "success", "path": "en/api/cli/beta.md", - "sha256": "eab2d6e394b8339221908106815dec30c21f5f75c36f9c4f7f9ad77c2279ce65", - "size": 1201537 + "sha256": "bd651bae873b62c832ffbf6a0f311c07fd9d2a939125d87ebc967582b6ac3370", + "size": 1397845 }, { "url": "https://platform.claude.com/docs/en/api/cli/completions", @@ -12168,36 +12672,36 @@ "url": "https://platform.claude.com/docs/en/api/ruby/models", "status": "success", "path": "en/api/ruby/models.md", - "sha256": "861500c8e65edb003e953dfa172001e7d8cfb36041229d8ea895b1380e0a8c42", - "size": 21196 + "sha256": "ee69c09634a1a9d5c9b5a26ee46ed37c530585fea63d98f8c93bb16b1511c8cc", + "size": 21736 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta", "status": "success", "path": "en/api/ruby/beta.md", - "sha256": "0b858f5b0aef0b37dd5480432c4c55489dbf69697f63c02ad535fb9b9925dd1b", - "size": 1730290 + "sha256": "39e2b334d510eb11de64c30b3c001bb69b86a6d6221754de248b4a3736f519ff", + "size": 2014091 }, { "url": "https://platform.claude.com/docs/en/api/ruby/completions", "status": "success", "path": "en/api/ruby/completions.md", - "sha256": "149997f6ba920e6ba50b974367c0d9cd2c2308c244e79b967f6b54e7ec60e9c8", - "size": 12873 + "sha256": "8f34ba41349f756f85584eabb0ee8311a37bed09967ff5cfd881bce95d800b49", + "size": 13143 }, { "url": "https://platform.claude.com/docs/en/api/ruby/models/list", "status": "success", "path": "en/api/ruby/models/list.md", - "sha256": "f5ba509bf21cc121cce581f6cd12df768613888a4d3f1a8499009fa35a2d52b7", - "size": 7101 + "sha256": "cd1f2ce32fdb16d2b90bbcc8c16904c3d10c2d3a7e17647a279f0379987031bc", + "size": 7371 }, { "url": "https://platform.claude.com/docs/en/api/ruby/models/retrieve", "status": "success", "path": "en/api/ruby/models/retrieve.md", - "sha256": "7acb2fa207f92991c1cb8ee84b7f0397f35acb3298f4edfe7adb7939c90d12a7", - "size": 6373 + "sha256": "5d75fae67df4fd83b6122960417ecf070f4cee9862633e82b5bc3ab1b5c544dd", + "size": 6643 }, { "url": "https://platform.claude.com/docs/en/api/ruby/messages/create", @@ -12224,22 +12728,22 @@ "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults", "status": "success", "path": "en/api/ruby/beta/vaults.md", - "sha256": "ad5c004937fa60e6b5e2749fd98f383d88b8ae5703b2eb026954e4584bc30394", - "size": 68016 + "sha256": "513405e1711ed9d2ba74156e08c8a3fdc864c98c756f09225182065c1e3f5077", + "size": 71526 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/user_profiles", "status": "success", "path": "en/api/ruby/beta/user_profiles.md", - "sha256": "de29007e29f7e90e31d81ab9f13779edefd5b5660c145de89cc15ba4631a20cb", - "size": 25193 + "sha256": "5f176e37fb411eda7cbaf05a2a1c5dc844fdcc93b5ab1b4f6f68b51716a52f77", + "size": 26543 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments", "status": "success", "path": "en/api/ruby/beta/deployments.md", - "sha256": "715503baed1dec2d585ef47b856f615063d68299c84a3cf0395e30a2ce3fb161", - "size": 203298 + "sha256": "b7ed25e8028726f00864992c9d66656e87e490a7e4dcf1e2f8d145343331d6db", + "size": 205458 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/webhooks", @@ -12252,316 +12756,316 @@ "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills", "status": "success", "path": "en/api/ruby/beta/skills.md", - "sha256": "382e3e8d70b963f1826b25612ed36f656afa11e6797ce8e6d664dcd4b9054c60", - "size": 31514 + "sha256": "f73ce3f5f765c82c1787a1679a448708ee4bc3cf5acbd5d560fb1a1a34c07013", + "size": 33944 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages", "status": "success", "path": "en/api/ruby/beta/messages.md", - "sha256": "56d9050fd6536d680ab59dddee5335bd7e900f3eb072ef96cbf0eaf62365eacb", - "size": 1206802 + "sha256": "57fc92c244439dc664b333d335e92700f286f198cca7bc23385f43d58afa8485", + "size": 1219919 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/models", "status": "success", "path": "en/api/ruby/beta/models.md", - "sha256": "76835a7f714c906bab2ebf9e402dfce8ff9b53f9b17a5592da9e0e767f1bc1c6", - "size": 22444 + "sha256": "e7ce4e001d1c58c43e1ca3daef7fa87b4d5577e71f72b5d3865774d1c413b98c", + "size": 22984 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/agents", "status": "success", "path": "en/api/ruby/beta/agents.md", - "sha256": "52e6f9d2d30ad22b814521b9bebfd995aa6f7b5b6d7d6600f035ae8150a5493a", - "size": 238573 + "sha256": "68d52157078244c775d327bfa04824c7a4d53d63f2112395f77c5944ba62f544", + "size": 240193 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/files", "status": "success", "path": "en/api/ruby/beta/files.md", - "sha256": "f04f7bfde47cbd293cfa4f6e3d6577ecc053a8753b609219aeb3cbebf52f00de", - "size": 15830 + "sha256": "40b0b1d9d5fe6462d34712beb6aa21369effbace6cf7ed2a3cf9cb1d0e2f3e26", + "size": 17180 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions", "status": "success", "path": "en/api/ruby/beta/sessions.md", - "sha256": "35cfee06d56629f4eab0bb610434c823beeae8565309a1fcc07d7337628c4392", - "size": 694032 + "sha256": "a9aae31a97f1ab348749e1a5e43d22ce63c7744cc405b1b6780664b7f404070a", + "size": 699459 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployment_runs", "status": "success", "path": "en/api/ruby/beta/deployment_runs.md", - "sha256": "7db568e84ed004d8b578a0cd99fb158f4f63174e428c11a3bef6cfd4e1efc159", - "size": 28641 + "sha256": "56b252561c94283fb3bcf21444ae83b08a40c4baff9b2cc038198cd17c2703bd", + "size": 29181 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores", "status": "success", "path": "en/api/ruby/beta/memory_stores.md", - "sha256": "8f0eba8690ebb1a393cd9ee7ee4a19abd3fe1e7d83f4fcc12ae50b71fe66eaf8", - "size": 71769 + "sha256": "9ea37b6047011456085d91eb27fe107d123fe6e5beafd9358f796e03a37cc940", + "size": 76163 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels", "status": "success", "path": "en/api/ruby/beta/tunnels.md", - "sha256": "b186b68243321588628a3660bf7ec1e73fe86099589f5e4ecf6bc66fabd73c92", - "size": 34064 + "sha256": "e7109849b9fcff58d6847412f4ac7d171566fe35b0c2a3a58751d670385eee96", + "size": 36764 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments", "status": "success", "path": "en/api/ruby/beta/environments.md", - "sha256": "3128c98c84795c3727d1c0bfac9368c37cf0eb2fe57e102eaba4dade518ed0c3", - "size": 81332 + "sha256": "5512dc14ad3e2c7478e23f8debcc98d02fd07adefffb91f05308f0655a4e45a8", + "size": 85714 }, { "url": "https://platform.claude.com/docs/en/api/ruby/completions/create", "status": "success", "path": "en/api/ruby/completions/create.md", - "sha256": "9aca56f020d11cb2a33a01632fe074a13f7054b8468d36b785fba1526a5574bc", - "size": 10274 + "sha256": "1a068275aec461d0a31c8baec854bbf3ac610a635371deca482c3eac2d9d758e", + "size": 10544 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/threads", "status": "success", "path": "en/api/ruby/beta/sessions/threads.md", - "sha256": "ff0779816ada364e58ab22cc0ff60325e0e117621e17621112b0b0601256e76f", - "size": 279437 + "sha256": "fc5abbbae04acc8d2ade31e33eb6d1b32f9b38b199d619bd24aeeeb8a5b24b76", + "size": 281183 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/events", "status": "success", "path": "en/api/ruby/beta/sessions/events.md", - "sha256": "049169c3a9926d335d53b75cec020bcae628f555dfe9b91d9d7caa82a0518a17", - "size": 396489 + "sha256": "7469a2bd09fe294bb644dc2e5c66bdf1d1bfb53fb32e60cc65241b07684119c0", + "size": 397299 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/resources", "status": "success", "path": "en/api/ruby/beta/sessions/resources.md", - "sha256": "b1f76c0a16ee8cc896a8d918398922e9f8b67df7166a6f90ae6718e46b53b140", - "size": 30420 + "sha256": "8cbea218a48d1688f669e6e12a4f04b5b4386fbf474d2b2e8357a199ba5dc74e", + "size": 31770 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/create", "status": "success", "path": "en/api/ruby/beta/sessions/create.md", - "sha256": "0aeef006d7322b8e53ae38b9358627191eb844e8e2cf1015adf6f8edc3869b4b", - "size": 57890 + "sha256": "7c862f89e9d1e87303e248faf12668cc6465f6448b4f1cb98977652b37a2dba7", + "size": 58160 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/update", "status": "success", "path": "en/api/ruby/beta/sessions/update.md", - "sha256": "d7df590c438fc5f83462f60f6c8729bd71cf129b8f49686eb66bd2caa67c1a2f", - "size": 43699 + "sha256": "4d86daea91461070af882aefa9e683dc2073f73620a2464da56100d602665168", + "size": 43969 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/archive", "status": "success", "path": "en/api/ruby/beta/sessions/archive.md", - "sha256": "ea1712edf54582599deaa0d411d2520b775fa776c5b528e930950a99645b95ce", - "size": 29575 + "sha256": "7c48aa44ba5e036e119895cd57ec9804f81a54bb48abc1d78995eeeab2bded62", + "size": 29845 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/list", "status": "success", "path": "en/api/ruby/beta/sessions/list.md", - "sha256": "c6161f27a748552a57a8bffd83f085905a24ed82bea265044aace957e9e841cc", - "size": 31744 + "sha256": "17694a3fd4169e14980164420e04c96e886d2448b5160ecdf487e19c19276511", + "size": 32014 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/delete", "status": "success", "path": "en/api/ruby/beta/sessions/delete.md", - "sha256": "f813aead402652f36496e06e53f0740859ea06daa000f67f8f4cca3334e10f13", - "size": 2276 + "sha256": "85d0ba8d018ddf0dd199e04fe2fce5ceece46998409aa88282f09976d4c694b6", + "size": 2546 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/retrieve", "status": "success", "path": "en/api/ruby/beta/sessions/retrieve.md", - "sha256": "9dbcf86a348a910449ca04f4af7d133f795dbb85ad5b392904e92f80be826916", - "size": 29560 + "sha256": "c8c151abf76f6434c65401ecf694d305d5b6dde50a7bcfe574dba9d38da2a191", + "size": 29830 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/agents/create", "status": "success", "path": "en/api/ruby/beta/agents/create.md", - "sha256": "a6808057160a7f34da0c263b5ef08747316a702ce48300ad4158ba47c742dfd2", - "size": 36619 + "sha256": "482b0633dce42dd1be46ef74530dc824e44fb09e99417bf9882e6ecf5e4db179", + "size": 36889 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/agents/versions", "status": "success", "path": "en/api/ruby/beta/agents/versions.md", - "sha256": "a9fe83378d22e5bacc9fc31e549728333b034cbe8a10a544b92d807d5a2b5b96", - "size": 17392 + "sha256": "df619edf307a54f60d29d8da9548b2ff5e6a37f3e50fce4d464f78d42903157c", + "size": 17662 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/agents/update", "status": "success", "path": "en/api/ruby/beta/agents/update.md", - "sha256": "1bfb99233c0728616b8f136691bfd2580b3634d72aaf336dd89fe61c92f94ebb", - "size": 37337 + "sha256": "efdac1062f20a41f3c6b9f5197aaa6397a4d1b29c0674dec446040b062738c88", + "size": 37607 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/agents/archive", "status": "success", "path": "en/api/ruby/beta/agents/archive.md", - "sha256": "7e26135b1a9c00ece2846e9dc97ae29c54c75c37c7bce2f515686e2823d03384", - "size": 16907 + "sha256": "9fa9eb9eff8f7e8a9f2853239a90a9cea42c52f140e34c96dd45a9868a436d1a", + "size": 17177 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/agents/list", "status": "success", "path": "en/api/ruby/beta/agents/list.md", - "sha256": "6f436a58121919d7f510d97077f61ad7fd51d8483766fbceb4c8c79278c1238d", - "size": 17581 + "sha256": "42025f3a040ff67c7a588b47b568e6a4859f1b721300754d2791e4da9387b9be", + "size": 17851 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/agents/retrieve", "status": "success", "path": "en/api/ruby/beta/agents/retrieve.md", - "sha256": "9416a4a9c569ffe818f1eb359330b46a01ffb2d1e9c1b2f4a3004802b0172413", - "size": 17016 + "sha256": "215a816e617c19720af9007570cca2e5a54ad4d3490526db11c39e807ffbd74e", + "size": 17286 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work", "status": "success", "path": "en/api/ruby/beta/environments/work.md", - "sha256": "629c944e08aba938efe77459c8f73c00a8d56afcf10d76ffa75637818ab74692", - "size": 40397 + "sha256": "6ca76a04332261360dd90f2e724958dc855a45d74995d3ba0587d23f1744f3d5", + "size": 42557 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/create", "status": "success", "path": "en/api/ruby/beta/environments/create.md", - "sha256": "4135af813a9a7146eb73b8113208defd097308895a2f46c6fb9c08ba9175d9af", - "size": 8538 + "sha256": "f63648e1406f90e851f2aa5e5b166a6c1a57c5c88b92e5b799d7e4bfb090036c", + "size": 8960 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/update", "status": "success", "path": "en/api/ruby/beta/environments/update.md", - "sha256": "1aa150be03672e49a2cbec3c02a83c5976cd578779be2a7f7df9e747724c52f6", - "size": 8631 + "sha256": "907d713776b652dc2bc5caae4c6c17010fa8a717d87bb237c0895bfcea70bbd3", + "size": 9053 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/archive", "status": "success", "path": "en/api/ruby/beta/environments/archive.md", - "sha256": "fc49808b6245f2fcf3b5ff2526d9f708026fc061afa4c6a2e75513c07aee3126", - "size": 5740 + "sha256": "6b37193ce8a0c699e152ad681770a0e9a722b8984054f90c5e5a499d38f4a4fc", + "size": 6010 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/list", "status": "success", "path": "en/api/ruby/beta/environments/list.md", - "sha256": "93d2ec7d2e0be329dc11bf8f0c40338c7ad80a7e0ae24e461226a700303faaa2", - "size": 6117 + "sha256": "1ef9d19c68acaebb73f9106841f8e63f76a32ff81fe59bf4140e58563f1d3f42", + "size": 6387 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/delete", "status": "success", "path": "en/api/ruby/beta/environments/delete.md", - "sha256": "55f13bbe936e1bb420bcdf058e791c9b672b0cc77f2a1999c83a86d618fb0196", - "size": 2388 + "sha256": "47ab170c1855ae9ec885c266d47224ef763fd47afc49d57ef394f2d25e91d7e0", + "size": 2658 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/retrieve", "status": "success", "path": "en/api/ruby/beta/environments/retrieve.md", - "sha256": "dc19b7eedcd6257ed686bb00ded653b661d649caecaeaee3a2ae0449c01efba6", - "size": 5677 + "sha256": "c08382b1d0c6e910a5f07bc63bcced5cc955a31602f07a959bf19f19846c6ec8", + "size": 5947 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/models/list", "status": "success", "path": "en/api/ruby/beta/models/list.md", - "sha256": "4d40ac3624685b62ec2182a5825c8dd96ac3f2ef4ecc90550b801de56c814a20", - "size": 7479 + "sha256": "d35743552b35590d175093ec86d1c04d737e9d205197b2f3704ae8b56ebbb421", + "size": 7749 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/models/retrieve", "status": "success", "path": "en/api/ruby/beta/models/retrieve.md", - "sha256": "311bf9c5e92bdb05bb5fc5b3eda656326a4f1ebcd68b82540730a627dc8f031f", - "size": 6749 + "sha256": "d7b97a6bbc26f1c740283552d3bddacdd67bf3c962340478e2a495908de2f572", + "size": 7019 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/reveal_token", "status": "success", "path": "en/api/ruby/beta/tunnels/reveal_token.md", - "sha256": "0aa21f68a0633e1282b536a5c2a4e0613f2677cacbcbd7b2d285f677fab8c78a", - "size": 2865 + "sha256": "04e3f2abbe3ab78b87e2834cf82c7b4b274f3be5981e5651256cff18dd7e680f", + "size": 3135 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/create", "status": "success", "path": "en/api/ruby/beta/tunnels/create.md", - "sha256": "3a8fef45e8580e49eb2353218613d2ebe508865bf2e9a574e3912f46e1eb4d66", - "size": 3273 + "sha256": "d66c89608c1c29d6c3ab637333518af5fb73e76a7352c89e12736fdf5720287e", + "size": 3543 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/rotate_token", "status": "success", "path": "en/api/ruby/beta/tunnels/rotate_token.md", - "sha256": "0d92da8a8d9b556f98a3babc35133715fdd5f379bb90854f787bd98856ea75e9", - "size": 2951 + "sha256": "bfb82592f541268b24ce510e45e4172de7eeaccb85f45f74b47946b2593dfb2c", + "size": 3221 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/archive", "status": "success", "path": "en/api/ruby/beta/tunnels/archive.md", - "sha256": "621eec32f7d1b874978d6d3e0fc593208b66313ef10953b394c52d8ccab14b35", - "size": 3329 + "sha256": "d100080d6dca63d0928d09ff3d30ad4760a972d3841d03c645c4225a07f80005", + "size": 3599 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/list", "status": "success", "path": "en/api/ruby/beta/tunnels/list.md", - "sha256": "23b96e78797161bcd76b5e77e833139115a3ce65578e9db009c0ae5442d048c2", - "size": 3472 + "sha256": "bae360abc00fc8e1f4b12c9a293cd0052de734f5fe2e4776afcd091fd30dfcc1", + "size": 3742 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/retrieve", "status": "success", "path": "en/api/ruby/beta/tunnels/retrieve.md", - "sha256": "61a5504ab46d5b2e620e946dadbd64dd7b17a0c98839cb528a137802db04f297", - "size": 3049 + "sha256": "d1c19ea121a12f021c0485a88cc4707418f8a76a57f8a8b8951ce466687c8b6e", + "size": 3319 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/certificates", "status": "success", "path": "en/api/ruby/beta/tunnels/certificates.md", - "sha256": "28dcb3e502d3371d7a2ec28a8582ce4839f5f5353844b63ec2e424906646dda1", - "size": 14737 + "sha256": "6956fc45a5cd6ee8da846072427cfa81aa3e52f22b6bb8e6f5d3ab5536f0fb38", + "size": 15817 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/create", "status": "success", "path": "en/api/ruby/beta/messages/create.md", - "sha256": "3cade728ff2c813fca210fe53a4e83603d589c8b45b9848e819ebe9fd9e4cf06", - "size": 172167 + "sha256": "c31f54f4c34d7c05e18ddb89135800f6d12f223a05afb1109c9bdee4228554d1", + "size": 174415 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/count_tokens", "status": "success", "path": "en/api/ruby/beta/messages/count_tokens.md", - "sha256": "b7065e41a00c91228f40c979ff1242491c87f5d9e92ddc9c256d99ea1b8caa92", - "size": 110333 + "sha256": "e29019383c072060082dcee6991584a75d03bcfc795edb9d5fab8890eda53ae2", + "size": 110665 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/batches", "status": "success", "path": "en/api/ruby/beta/messages/batches.md", - "sha256": "507c3bd978e409189388264071968c43a5e9b78977baf650ded386f63ae5352a", - "size": 354297 + "sha256": "543d67ec25962c7e3805fdfe50b0257958966e65f2c1642daf58c8af93180782", + "size": 359825 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/webhooks/unwrap", @@ -12574,645 +13078,652 @@ "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployment_runs/list", "status": "success", "path": "en/api/ruby/beta/deployment_runs/list.md", - "sha256": "a940a85e6e2acdc843ff5cf347ab906983772f8cc836d4521c2a1c019cb556e0", - "size": 9156 + "sha256": "8a33336cf0c360bc943606c613b1ad7513c447c1c841aecf3e69358c1d52cb45", + "size": 9426 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployment_runs/retrieve", "status": "success", "path": "en/api/ruby/beta/deployment_runs/retrieve.md", - "sha256": "8a57fba53edf98e8b6236b8f3ff827cde307bc2afddb725814bbb3cd9309b4aa", - "size": 8070 + "sha256": "5da9b734b6372f6e88ac012fce5461d32e061bd0cfa16b4c591358bae4cf945d", + "size": 8340 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memories", "status": "success", "path": "en/api/ruby/beta/memory_stores/memories.md", - "sha256": "5f640cd7798b6f57e4bcd904dc2da109355bbe53e623d18122825bb33cf59b02", - "size": 35705 + "sha256": "b465f26aaf921d0f50b6e9c0fa989df12bf2162d1069ebda5a48599aaba8470d", + "size": 37297 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/create", "status": "success", "path": "en/api/ruby/beta/memory_stores/create.md", - "sha256": "2917c2fd91a1706b752c1b9f9ed205662199f5354dc0c292912bf41b8b4ba3be", - "size": 4375 + "sha256": "fbb4a4ac5d912c81b0064ac1dbf58571cd03a2586b26d7c09db80444d0794944", + "size": 4645 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/ruby/beta/memory_stores/memory_versions.md", - "sha256": "8653172a9190bd4ea40cc688f93bea700cf77314d37669309bdedf728851f5b5", - "size": 29742 + "sha256": "4e5d4e2e29e28dcdef8532f32fdfc9e3cb60fa43bf9cd096a87f53a677bb430d", + "size": 31216 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/update", "status": "success", "path": "en/api/ruby/beta/memory_stores/update.md", - "sha256": "9eeeed6d5c1369ef0611a35f0b89870e64788d1fabff67a45bb9b11059efb908", - "size": 4284 + "sha256": "852e8c0bcbeb29086eaefdc42792f89d362c5f1e76a7274223a28b8faee8b5d2", + "size": 4554 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/archive", "status": "success", "path": "en/api/ruby/beta/memory_stores/archive.md", - "sha256": "8e77f1a10a2c6235de3eb06878839f273121cc61042b2b7a388f546211f5cf07", - "size": 3696 + "sha256": "f00ac67e64a8fe2bf3d4b329763c69563cc1a07fa4255091825bfea8afc238a4", + "size": 3966 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/list", "status": "success", "path": "en/api/ruby/beta/memory_stores/list.md", - "sha256": "3ebdc3ccba5e122891c58ce76d20fa4bc19766faa7fb6f4af154398a6fe12e6f", - "size": 4424 + "sha256": "1b2699c49c5ab29d4318734be0acf20d3ee5b859ffc21f9ef30ab4b0316c222f", + "size": 4694 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/delete", "status": "success", "path": "en/api/ruby/beta/memory_stores/delete.md", - "sha256": "178fe1b59cee440f2ef627c4607c2f756e7001c24b1875d38ffd86e004765362", - "size": 2433 + "sha256": "a02ba698f01f19671b8f122479e90e58752807d37b087d20695f4bd7f842bb6c", + "size": 2703 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/retrieve", "status": "success", "path": "en/api/ruby/beta/memory_stores/retrieve.md", - "sha256": "c5df4c09e1354318f242ae45671a80527a25c22d70d2447bc88da84ae123a583", - "size": 3691 + "sha256": "5bb309639a6dd10b256042aeaca1fcfa1b94e508bd1ea4b7d006595664b4ac9b", + "size": 3961 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/user_profiles/create_enrollment_url", "status": "success", "path": "en/api/ruby/beta/user_profiles/create_enrollment_url.md", - "sha256": "21fd32a8e980b51e42c83fe6ab10b37cb0545d2a67cc7b51231e0f5bc6264be8", - "size": 2570 + "sha256": "d5ae63a398d343c632b900a2995ec4a25a4a1c78cf16f7ce3a25767055851b07", + "size": 2840 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/user_profiles/create", "status": "success", "path": "en/api/ruby/beta/user_profiles/create.md", - "sha256": "79dc3f959121c75f23b12346bf7d9651eeab62696d5f748bd247a017bd446355", - "size": 5617 + "sha256": "4963814177456354de3ab23b920d98dd0c9772548b7f91d460dba19c4f1dd7ab", + "size": 5887 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/user_profiles/update", "status": "success", "path": "en/api/ruby/beta/user_profiles/update.md", - "sha256": "6b8b83327a1b1b16876917d3a65dc0499547f12e7046742fee9ec62ead17a352", - "size": 5656 + "sha256": "d93c91234902a128def8190b2aea139a85bb2e0ce022983120a475ee23b02d3d", + "size": 5926 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/user_profiles/list", "status": "success", "path": "en/api/ruby/beta/user_profiles/list.md", - "sha256": "e8aaf7368c82e53f81e7984bc76b41746987f525d6756a5627b01694ac95fb9f", - "size": 4517 + "sha256": "81a7ae5247c048a6462c41cefe60e91528641a7ce393d432acfce829952e013a", + "size": 4787 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/user_profiles/retrieve", "status": "success", "path": "en/api/ruby/beta/user_profiles/retrieve.md", - "sha256": "b9630e2858c60a99c7b556257111cba0f688eed9f728974cf2bcbb5a9213b93d", - "size": 4306 + "sha256": "c93f911c09685434df72ce1c4601b3e78b54170b0ddfc2b63e4fe2fd317ca5d0", + "size": 4576 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/create", "status": "success", "path": "en/api/ruby/beta/vaults/create.md", - "sha256": "fd437ff05a8514f6919ee6d9e3ff0443ddf3e880d7bcb7d17760f404c02a052f", - "size": 3072 + "sha256": "7c76b690778ebb1acd8ac0cda7ac32aae07402af3015ce5f01f26091e733ee74", + "size": 3342 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/update", "status": "success", "path": "en/api/ruby/beta/vaults/update.md", - "sha256": "73bd4e4d4d8f0e365ed2fe31da69a6f1cc50761d5d394ba20d24769fd7d8c9fc", - "size": 3113 + "sha256": "f624792af43427b75a8100e311b8b3fa902f20e1d152f3e0703bd1f5fa31db2f", + "size": 3383 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/credentials", "status": "success", "path": "en/api/ruby/beta/vaults/credentials.md", - "sha256": "aa1a05623eb70fbb42b6e5f8a6506c817290ccd29b0c366e049743f982a253f6", - "size": 78744 + "sha256": "2405dbb9919772f6888c8c52060997ff6c7c5e5abf83b13f20159491686d202d", + "size": 80634 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/archive", "status": "success", "path": "en/api/ruby/beta/vaults/archive.md", - "sha256": "3a8035c580f305d4165242a1bd994224c5e77f00e3d18e7a0c8d4ce5daa37760", - "size": 2859 + "sha256": "34db2a6d73247bf4c363598f55c941ada186545b98a1b5c15ceeb67a30052534", + "size": 3129 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/list", "status": "success", "path": "en/api/ruby/beta/vaults/list.md", - "sha256": "a7660c9d171f801bebe90ca19974cef59d891d34b3a502849b2fd4dbe7f0c356", - "size": 3132 + "sha256": "f83e3964edd0d92d78fcb081929fe96e5a14f58fbaf747d02a525537339c006b", + "size": 3402 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/delete", "status": "success", "path": "en/api/ruby/beta/vaults/delete.md", - "sha256": "482dfa1db8a632ce651b3e4b5ec5b41ef7cc1cee29801eee031127d2fd80ab33", - "size": 2264 + "sha256": "155ac7a5e56237056bcb176ce97268a7c4d5bf3c7e7ba00d38095053f56f6cac", + "size": 2534 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/retrieve", "status": "success", "path": "en/api/ruby/beta/vaults/retrieve.md", - "sha256": "aef4e0abe20c072c582d0ba7b832069567a65fdbc6bff39ebba496e8d8262d1d", - "size": 2844 + "sha256": "e7ecb17cfa6aacbd7e8737bffe1e3003b5f2067c2a3a15832698ab166a8a32ae", + "size": 3114 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/files/retrieve_metadata", "status": "success", "path": "en/api/ruby/beta/files/retrieve_metadata.md", - "sha256": "8785bca036baaae25b50b662c3c920d51364971bc61c33fc942887762c24f9cb", - "size": 3217 + "sha256": "d39a5e1e6388e54a22c386918c97b13b78b2c7870c48ad2b55d2d7cd3df432ea", + "size": 3487 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/files/list", "status": "success", "path": "en/api/ruby/beta/files/list.md", - "sha256": "b93f1222665b8c8bbb6369145d9f90eaf283962b6c64e49b35e5afe4bcd0c850", - "size": 3832 + "sha256": "c0c8c1c2c83c4e3dca0d33ec868e5cb94a59857b4175d23d71af71a267b5f14e", + "size": 4102 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/files/delete", "status": "success", "path": "en/api/ruby/beta/files/delete.md", - "sha256": "9efd042f6b7f9e669a34fc31b445cf9c8d5e134460e06304c3e6239f9c4e5af8", - "size": 2224 + "sha256": "242b5c95c6bf2797a612acbb17fe5eb4d4dc17ee2a29beae9ab4f4b628f1a2d0", + "size": 2494 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/files/upload", "status": "success", "path": "en/api/ruby/beta/files/upload.md", - "sha256": "1ba52d687c2bf6d91637944b0d4f0c0c3b9cb963fd79c88fe6a210472acb4b8b", - "size": 3208 + "sha256": "3525f1b1f3cfd6572364ce36ac0ede4e73765f265961d2972d7ec32121213945", + "size": 3478 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/files/download", "status": "success", "path": "en/api/ruby/beta/files/download.md", - "sha256": "9efc02705acca556f43673b729e2ad960c83ba87ce1c15a8c7f080e9f61616f9", - "size": 1939 + "sha256": "f101596e6a3d2f3b3ae5941784868671e6ebbf3f5c66b880cc1b7c35c2c852c2", + "size": 2209 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/create", "status": "success", "path": "en/api/ruby/beta/skills/create.md", - "sha256": "f3af9f6ced5fe851a4b163f59e10d7344e95958a47244b634641ade381bbc88a", - "size": 3411 + "sha256": "2c87d0e72fc604e735c3952e7d07bd3dd8620f515c5f5515e1ff401b06088890", + "size": 3681 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/versions", "status": "success", "path": "en/api/ruby/beta/skills/versions.md", - "sha256": "9a2cbaba82e95d868d72e0ff60087e4ab2619068482f0d3296eece0e3d15c4b6", - "size": 19139 + "sha256": "44bb036c4e4668a876adc75f6542e887dde7d7130c7049253357852daaa41035", + "size": 20489 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/list", "status": "success", "path": "en/api/ruby/beta/skills/list.md", - "sha256": "d90cb9702df2de0c10046fc1c0bf7be756abcf70d34780d76a2ea7a633482882", - "size": 3677 + "sha256": "39b65ef76f920a0e577b6050fd3a58b91854e171d156a8fda111016e2292acfa", + "size": 3947 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/delete", "status": "success", "path": "en/api/ruby/beta/skills/delete.md", - "sha256": "bb613772ca719a0150da365054b8420bba68493e280eab2938f63b1e2e1f7948", - "size": 2335 + "sha256": "21c5873119d463eeb7c8cc5deda87c44a474712402927e2f296b7a83a5081b94", + "size": 2605 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/retrieve", "status": "success", "path": "en/api/ruby/beta/skills/retrieve.md", - "sha256": "65789379c54a4666abf509a22f486f2dd61f68de6ca17c90f9f7c2f230a4f8a0", - "size": 3194 + "sha256": "cd38a09232b9c3ab40e8d777080b0fe13cfd187d1019fb905185daa5e8091380", + "size": 3464 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments/pause", "status": "success", "path": "en/api/ruby/beta/deployments/pause.md", - "sha256": "bb7d0250bab4e71b7171c05b013c43240f7b788532d9dbbee21b876c1c79b08c", - "size": 17389 + "sha256": "6543bc8a9c663584c92d0810ab9b06fde2b2b4ac7a050152ab74bb3da5c6bdb2", + "size": 17659 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments/create", "status": "success", "path": "en/api/ruby/beta/deployments/create.md", - "sha256": "e13e533bed821a20745964dd1b79e5df993ea713543e619061c92d66a35ee1af", - "size": 28001 + "sha256": "88eb10b5c345c3e144035ad63cc2e877da19f85c604d444161ec1da9529566d7", + "size": 28271 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments/update", "status": "success", "path": "en/api/ruby/beta/deployments/update.md", - "sha256": "fb0d0d94aa6bf1ce4e1f7941cd48c6ff7f52d7d873e6cc7d24b1d8931839cfd5", - "size": 28053 + "sha256": "ea0d7e628ee06579dbe28978198976118db535a8262bf5b2f58f8bc60eb64338", + "size": 28323 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments/archive", "status": "success", "path": "en/api/ruby/beta/deployments/archive.md", - "sha256": "ae641903dfe912392a7b422a09fecb460e2d62d88a033ec4d5e3c9f59bb31898", - "size": 17399 + "sha256": "7a4995c23aed9af20f6eabff3167d231701e4db9d53bbd917df61e57d84eb2e0", + "size": 17669 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments/list", "status": "success", "path": "en/api/ruby/beta/deployments/list.md", - "sha256": "fffea2d60ed7920b25b6370b0fbbe0a439702ef1d5283eb560e2ecd67a1e4c45", - "size": 18307 + "sha256": "d3aa11cc9d0fdb1afd55a26cb62a3267bdb979b203164c8b245972157ba3170e", + "size": 18577 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments/retrieve", "status": "success", "path": "en/api/ruby/beta/deployments/retrieve.md", - "sha256": "be04509287aeb994ff6871fe1f3cfbbae5a63939e0b6844c565c8bc1f0fa6aac", - "size": 17384 + "sha256": "2741711a04581f85bc84b94aad253f41193b990d35011b880f81f0222d267f6d", + "size": 17654 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments/run", "status": "success", "path": "en/api/ruby/beta/deployments/run.md", - "sha256": "f0a8d312841a12826f5aca90a41ec828101d10d5d474eee16c494f66c3258afe", - "size": 8053 + "sha256": "602eb75f1dd580371197a0ba9a318b2f03ad5e3c06fd17a756d1b2a4f230b67d", + "size": 8323 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/deployments/unpause", "status": "success", "path": "en/api/ruby/beta/deployments/unpause.md", - "sha256": "62898b910d287d94f9bac1a402a51a8f13d0402159ed6061db4d036dd7fbb027", - "size": 17399 + "sha256": "dd938b3cd5828f68ace575a7c179fc8bbae97b82e0c27b34165be80152b446ac", + "size": 17669 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/versions/create", "status": "success", "path": "en/api/ruby/beta/skills/versions/create.md", - "sha256": "eae38ec64b3bcf9f88166fca8d660efbc7725470958708c27dbc20d79f9b8932", - "size": 3593 + "sha256": "c083629fae98f5b39534024d86fc12025ab2c5b3556356953c95c19c561b9f79", + "size": 3863 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/versions/list", "status": "success", "path": "en/api/ruby/beta/skills/versions/list.md", - "sha256": "66478d35f23f96e549f1279bcf59fce0015c7720e7b3d81903282ac80edd2fc5", - "size": 3700 + "sha256": "862e54680ed9bcf57dbeddf36120e017171488eb2237db41f6c7c95f33b55ba6", + "size": 3970 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/versions/delete", "status": "success", "path": "en/api/ruby/beta/skills/versions/delete.md", - "sha256": "26c3992b08bd070bfc362878de79beeac62f98ea09b0f0a08a24b98fede86d8c", - "size": 2589 + "sha256": "1d2e75b078dbbcc9e3b6f5c060df46fb7d093c42d9ffff792dfdb4cf4bcda86a", + "size": 2859 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/versions/retrieve", "status": "success", "path": "en/api/ruby/beta/skills/versions/retrieve.md", - "sha256": "5d6edc51dcb405b3d6f524cb6a3a033db255cc78a2a9f0881674094e45084088", - "size": 3550 + "sha256": "73816525fab093b12c92f5e90832372a4932b00be82ee33ccc08cb1a4b58d21c", + "size": 3820 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/skills/versions/download", "status": "success", "path": "en/api/ruby/beta/skills/versions/download.md", - "sha256": "5ccdf7b68b4c2585518c9f2e7a2f21edf6b7adc99184606330c4fe2a3620e507", - "size": 2272 + "sha256": "a2d253b9d9d429c1c9ddbdb1731fc0cbe066da6ea0ec791335c130856fff65dd", + "size": 2542 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/credentials/create", "status": "success", "path": "en/api/ruby/beta/vaults/credentials/create.md", - "sha256": "e53e8b73702ea1c3d1f0997f6833a1f27a6f78fdbb37bee757aae1e5c212d75c", - "size": 11434 + "sha256": "59c779c57ee35b0fd06f80b14c8edc019c90e6b11814d8f1828dc160d317384a", + "size": 11704 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/credentials/update", "status": "success", "path": "en/api/ruby/beta/vaults/credentials/update.md", - "sha256": "a56981a22623d4036cafa998660b8fa63104dab027779b46d8668fb94c1e786d", - "size": 10532 + "sha256": "64b63abeac2e4ad8a2dc31f1ae0ce1edce9f894e0df5dc4d811127dd6ae28f9f", + "size": 10802 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/credentials/archive", "status": "success", "path": "en/api/ruby/beta/vaults/credentials/archive.md", - "sha256": "cd2c0fd9675088e980c1897fa6f06436f287854a1b5eedbd0d617407f18cf1c0", - "size": 6780 + "sha256": "a38fd22e32f8ecbbfc03ca26455e89333fe9e4f7eae572c4df163b8d9f8241bb", + "size": 7050 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/credentials/list", "status": "success", "path": "en/api/ruby/beta/vaults/credentials/list.md", - "sha256": "e197de0b4499189ea32632ac4716cb4cf5baf71de804064e4e824560f8e43a49", - "size": 7056 + "sha256": "bc3e210892358a847dc3feda800a152df8eeb016577d469c6548f394dff3dc77", + "size": 7326 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/credentials/delete", "status": "success", "path": "en/api/ruby/beta/vaults/credentials/delete.md", - "sha256": "df921f924e4b6b15f3360d7ea423feb0a3ca9a83b37b96c69e980fe3a19a257e", - "size": 2460 + "sha256": "0d540a0f1f53b279f812761e9e26f5d290d5ff22b8a010d8875ba9a8332fa795", + "size": 2730 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/credentials/retrieve", "status": "success", "path": "en/api/ruby/beta/vaults/credentials/retrieve.md", - "sha256": "d2f2677922b6972d3e723cd7e406a18b369a1febc13d8a7159b71f5a37a30413", - "size": 6765 + "sha256": "6f91d674cc27ae7467e21638828946bbeac7c7db093aad78a1312ed0e28a0fc8", + "size": 7035 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/vaults/credentials/mcp_oauth_validate", "status": "success", "path": "en/api/ruby/beta/vaults/credentials/mcp_oauth_validate.md", - "sha256": "dae8e53a27ba484cbf7ed76605fdc75f8546a6c0df87b981cd21d58d0ca60ece", - "size": 4708 + "sha256": "0e183f10188fda5baf538a94997f00478b90688c6624c0c96db62a1f297ee81b", + "size": 4978 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memories/create", "status": "success", "path": "en/api/ruby/beta/memory_stores/memories/create.md", - "sha256": "b0835ad47d77a5e367913ca2efb18ce0d4f376b0e3ba51e0e33268527c01a5a0", - "size": 5111 + "sha256": "0d22a591434961c1568f59e1f54d44e5e66b8ab9081361743a5d3c8ba56a5667", + "size": 5376 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memories/update", "status": "success", "path": "en/api/ruby/beta/memory_stores/memories/update.md", - "sha256": "e11c1e96d6544b60246b1b8287b1b80573337fd75e710093b5c501d6b79c9406", - "size": 6012 + "sha256": "84c849dead11728d383b2365ea2a6a101a64ca87ad18e665dbe2e5993654380c", + "size": 6277 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memories/list", "status": "success", "path": "en/api/ruby/beta/memory_stores/memories/list.md", - "sha256": "0053dced986f6d3d9811f8de02a0f357649e55bfc0d8ea1a5afbfdb62f00186b", - "size": 6676 + "sha256": "0963ecf2db3ac9dbfb637ff4c0197f243bd86a33b211f3980dd9e0fadd4748e0", + "size": 6941 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memories/delete", "status": "success", "path": "en/api/ruby/beta/memory_stores/memories/delete.md", - "sha256": "2a301edf13baafac0e004002312054b298a8acf937ead7ef77452cd8e8d710c8", - "size": 2687 + "sha256": "ac13f68f34796d6bc7545bd5d37f683aac78d0b8e93e2cc309a3a494238e4faf", + "size": 3093 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/ruby/beta/memory_stores/memories/retrieve.md", - "sha256": "dcdb3a7ae358e39ddf48bac4681147e69e0f3f7345d37857d06ac4ea2a0c2e76", - "size": 4641 + "sha256": "e2102f3240dde01478ad0dc3745bfedfb5bbdd23095d3bb785c1afb6e5f945a5", + "size": 4906 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/ruby/beta/memory_stores/memory_versions/redact.md", - "sha256": "aa477c580255edfffd00a7e1966009cb647a1c03137498874257fc93d13200f0", - "size": 6973 + "sha256": "1394904cfb368ce396e6fefe363181cc6b79775f1bb662b62742e4b84fa1e69e", + "size": 7409 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/ruby/beta/memory_stores/memory_versions/list.md", - "sha256": "fb252ee94a3c25483232da15205e6c0760c62966f5b7324ec3d57074b91ad8c5", - "size": 7751 + "sha256": "a34d56d05f0bb94e84550f736aa1b411079802e03ca8e3974a8b5d96f230111d", + "size": 8187 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/ruby/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "048ac3d76e54f12a7a76bf8309ad7e765b2bf7dab0f053bf90b4dc36fa6c05ec", - "size": 7067 + "sha256": "ff484415e53884d8ce54910d148d6e9315d3ab95cd5cd4939771f20f5c5df5a9", + "size": 7503 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/batches/results", "status": "success", "path": "en/api/ruby/beta/messages/batches/results.md", - "sha256": "8af40b3c2d27921490e19b8fff9ce83ba9ad5f588b794e6edc3ed279faa77793", - "size": 52959 + "sha256": "739bdd917e9a2e593e98bf61aa49614701d2baa9ca6bd8456e6326fd31d9b845", + "size": 54188 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/batches/cancel", "status": "success", "path": "en/api/ruby/beta/messages/batches/cancel.md", - "sha256": "6e3b05a35500f9a13187a92e1aae661ae433580e56b237042b71620358e33c4c", - "size": 6107 + "sha256": "b9d1443494595aa618bef81f8301314323b7e6a09873bbc97f2539f29251646b", + "size": 6377 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/batches/create", "status": "success", "path": "en/api/ruby/beta/messages/batches/create.md", - "sha256": "52d47a01275d0445e1305b8c46e074cdc9440ad2eca127993efbf2381ba91220", - "size": 130978 + "sha256": "9e3de919c790494e9c33735036d55c1f38f6844c28b4ccce859bbb429745e010", + "size": 131326 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/batches/list", "status": "success", "path": "en/api/ruby/beta/messages/batches/list.md", - "sha256": "b8bc028903df70e4bf43a830d87d22736161ceb2e89d6eefd8bed1115a482295", - "size": 6160 + "sha256": "ec2f519e310c33ee7ba6f89a6934258102ea1ef15b2a0a770db9d17f114e4487", + "size": 6430 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/batches/delete", "status": "success", "path": "en/api/ruby/beta/messages/batches/delete.md", - "sha256": "fca33d12dc0ddbfa7e128315838647ea760c1161c07f88665e8dc01f3d21f84f", - "size": 2670 + "sha256": "aaf97bce06a743e7f4dadd104ea31b0504219593e7c77ecc0296e90e2c2b6d45", + "size": 2940 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/messages/batches/retrieve", "status": "success", "path": "en/api/ruby/beta/messages/batches/retrieve.md", - "sha256": "5fd74f6cdf4a907315b2f5782064efc917f13fa5ba49ac96078a2099dd766131", - "size": 5795 + "sha256": "f2fe3c840d61e781aa600ae75ace29802ce50ee804ab77c57d3c2aa84744d879", + "size": 6065 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/certificates/create", "status": "success", "path": "en/api/ruby/beta/tunnels/certificates/create.md", - "sha256": "2b286ed3b3b6323dae6693956f71d488e577c658a524edd27099a5f7f44bffa0", - "size": 3584 + "sha256": "9a3b2090bdf6e313aa0665703bb7649022ce6eaef6c1c6de8d6b4fb954cb46f0", + "size": 3854 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/certificates/archive", "status": "success", "path": "en/api/ruby/beta/tunnels/certificates/archive.md", - "sha256": "e45d99bbb9604adbc6cfd3458b776e54cca8acb31d4921732df4e8e83963062c", - "size": 3502 + "sha256": "43b71e006ff58af911ac01f3b93ca753f4adb89ebefccea7e11b7dc95b6edc37", + "size": 3772 + }, + { + "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/certificates/list", + "status": "success", + "path": "en/api/ruby/beta/tunnels/certificates/list.md", + "sha256": "b43496daff31d95fe0ecac852fc946055fdbc3d4a005be3eaf540f4f99568aed", + "size": 3927 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/certificates/retrieve", "status": "success", "path": "en/api/ruby/beta/tunnels/certificates/retrieve.md", - "sha256": "afe95e08880ecc934431a7524b6f4c44db0d3480ff3d81de46daa5a0416149cf", - "size": 3279 + "sha256": "465a8608e5a637757a3f2067dcb31064d07f387eb528186ca9113c901e25d28b", + "size": 3549 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work/ack", "status": "success", "path": "en/api/ruby/beta/environments/work/ack.md", - "sha256": "9ab10f8371b0bf133665a9b24b1189ed3a50498936730ac8851fa2e8d0e95854", - "size": 4572 + "sha256": "f49291bf555d163304bf9c2d539998f2ff7b9996b4dda1a3299f6f6c1f59cfdd", + "size": 4842 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work/stats", "status": "success", "path": "en/api/ruby/beta/environments/work/stats.md", - "sha256": "d0dece524d6b3f3d4b7f2518d88befadbcfaa0aa7ff6512fd7ff6c041faa172f", - "size": 2971 + "sha256": "537dbe1605791f885006ce29473363001581fc3e65964046ce55ea1cf5426353", + "size": 3241 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work/poll", "status": "success", "path": "en/api/ruby/beta/environments/work/poll.md", - "sha256": "9123cc42a02140212b7e846abc054aa8372f6e3fdc7752495ff3a4892d3b71f5", - "size": 4958 + "sha256": "ca4f85bc1627dea5259308fba349e47659c3e7bffe449f13f64343a8576b3eb1", + "size": 5228 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work/stop", "status": "success", "path": "en/api/ruby/beta/environments/work/stop.md", - "sha256": "88812f2ab1bf897b0aa8c56b28b0232aececdb3ece69ba3dedb74677570947d3", - "size": 4590 + "sha256": "ea9349dcfe868e38ad51e8275bc9c7b3abcf51fbbeee01482757660e1270d0bf", + "size": 4860 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work/update", "status": "success", "path": "en/api/ruby/beta/environments/work/update.md", - "sha256": "2bfb69a9bcbb102a7584a00476030713ffc85119bf62518835071fd368d93ceb", - "size": 4706 + "sha256": "3fb7bb83208ef8260d57f248f18de7af66a29a2e07163f48d6370342ce281852", + "size": 4976 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work/list", "status": "success", "path": "en/api/ruby/beta/environments/work/list.md", - "sha256": "be42bb249586103d7c57c09a31b572fd2585691185471a6c3a09336843cc77d4", - "size": 4709 + "sha256": "02ac2eaadb90f6ced2e9eb260b10f131cf163196b1270b4f9b65818795d9c3e6", + "size": 4979 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work/heartbeat", "status": "success", "path": "en/api/ruby/beta/environments/work/heartbeat.md", - "sha256": "6a3b45662a92842dc3ee6462447b8bea5e77d7321b8b611e09e3cfc5abd4a30e", - "size": 3611 + "sha256": "0924de8659893cc619cd7b845cc45932121695f5042f02c63813b113e8ab74ee", + "size": 3881 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/environments/work/retrieve", "status": "success", "path": "en/api/ruby/beta/environments/work/retrieve.md", - "sha256": "d452420d43d07e7fcc7ca9d17eb007947bd733448d5efb3788e85447cd028212", - "size": 4519 + "sha256": "fbea14966886fa1da4af96a5ccc2d31ccca23726bbe2fc5af1130b0795d72e88", + "size": 4789 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/agents/versions/list", "status": "success", "path": "en/api/ruby/beta/agents/versions/list.md", - "sha256": "cc3a2a22751279dd4684123f3fc809d6e8729ee212fe02987534ffa5d9963e0a", - "size": 17375 + "sha256": "42fd6fb24c258c321fc314075fa64d38bbbbd6a02601bd55677ec4dd94c1dd8d", + "size": 17645 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/events/send", "status": "success", "path": "en/api/ruby/beta/sessions/events/send.md", - "sha256": "f25dd0919b62f2492b3d789860350cbf55c766d596a499a52576e6a3795d155a", - "size": 24371 + "sha256": "44dc83bd9ab00e030551ad79275657e2c1656871dd7e14a2f8ba9b88f9ff2b0c", + "size": 24641 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/events/stream", "status": "success", "path": "en/api/ruby/beta/sessions/events/stream.md", - "sha256": "6f9f096b527ea48b6c5506a76aff2e9891fd3b773b05abcb6596b4d36b501ed8", - "size": 67369 + "sha256": "fd20a9931d231bfb4778b3fc35a49be4487732e7f3cc10e9e5000dd24b04e437", + "size": 67639 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/events/list", "status": "success", "path": "en/api/ruby/beta/sessions/events/list.md", - "sha256": "0268eb9ba03d3d66347a3ffbe13bb908c7721b2af52921124752877a58bdd83a", - "size": 65116 + "sha256": "2b9a8fe30dcfa680f6a7c108490e1bf84c537f26b1fb42ee2a497424c13e7d38", + "size": 65386 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/resources/add", "status": "success", "path": "en/api/ruby/beta/sessions/resources/add.md", - "sha256": "b2cfadfffad688966b22fe3d8211348185638513bbf900ae2e90f44c8ccd19c3", - "size": 2905 + "sha256": "64aed8f49de42f91e6ab1c12d8ce894d81ae78a491f42e0570caec4d6e4736cc", + "size": 3175 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/resources/update", "status": "success", "path": "en/api/ruby/beta/sessions/resources/update.md", - "sha256": "0bea39196ce36f98ba568f63e8f79c3c86e184f5c00734ef4f31b630052c69f1", - "size": 5057 + "sha256": "8cb7bd8ee1d7d1c33062575eafb237a256a5f4dc9f245afd8d7d2ab6b3ae30ca", + "size": 5327 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/resources/list", "status": "success", "path": "en/api/ruby/beta/sessions/resources/list.md", - "sha256": "8f47e356ce1e3f49fec15f2ceaa6d139e715efab7801e12736bdf648bee53f24", - "size": 5369 + "sha256": "4a42a0f06e0d8cecd07334b3723e518b252b3c75dc93610e3fbbdec950a6f5dd", + "size": 5639 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/resources/delete", "status": "success", "path": "en/api/ruby/beta/sessions/resources/delete.md", - "sha256": "1cf37ea1339bd2bbb960d3c97b8b2b641a64bf3c3b386befe259b6927e9c7690", - "size": 2442 + "sha256": "a6f640dcc2d86cbd3ca836b16e9b43d7bca30e1d930436173c0d41c5f8d43188", + "size": 2712 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/resources/retrieve", "status": "success", "path": "en/api/ruby/beta/sessions/resources/retrieve.md", - "sha256": "a3b856b8cbfb9fb369f5abcd7ce410179f88487f6cdb41d55bfa7c2c0418899c", - "size": 4837 + "sha256": "c59bd7659582cf94cce1deda16208836c983fbf8d0c8470599973dbadc4a310a", + "size": 5107 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/threads/events", "status": "success", "path": "en/api/ruby/beta/sessions/threads/events.md", - "sha256": "d4b6bb9654f4b772350a519ae954b5205fc64e2d50d71b8fab5311dcac354db9", - "size": 131538 + "sha256": "98f7e686c9e150a5512fda13e63065e2cb9f1f85bc962bffcbd0cc64b396161a", + "size": 132078 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/threads/archive", "status": "success", "path": "en/api/ruby/beta/sessions/threads/archive.md", - "sha256": "4efec56408783247e9b5635ecda75d6afa5b2c0e524d1c3028b5971ddd67b179", - "size": 21153 + "sha256": "beeb56fe567e60b3a0f43c496e291a50f7ec31670ed1ae01d50d79ecea6a1958", + "size": 21522 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/threads/list", "status": "success", "path": "en/api/ruby/beta/sessions/threads/list.md", - "sha256": "fba70a81fe0e0a1a7f6040e3a40bc33b80c0276e182ee77c7e1f4f129f5f6c14", - "size": 21591 + "sha256": "e7809665fec3b4caa2e3c2218226f7df41890c0f6fb9a2d17680a772e4fcfa84", + "size": 21960 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/ruby/beta/sessions/threads/retrieve.md", - "sha256": "12c95225378a03f5d99a9b1721f028d04654b296d905953e24107b926556c2b2", - "size": 21138 + "sha256": "fff0f9395ee647655dfd8c78d41c7d8e5cc5dc93a1f000a7c2c57ed0e44b63e3", + "size": 21507 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/threads/events/stream", "status": "success", "path": "en/api/ruby/beta/sessions/threads/events/stream.md", - "sha256": "ec64ed5db6eff36e4c1a3aa539c0f4e0d30e83354c7b7caf82cf34b40012160d", - "size": 67545 + "sha256": "f81ae81fb261ba76f950212ff1f5dd72d3099fb56d116010a7b773aac83c7de6", + "size": 67815 }, { "url": "https://platform.claude.com/docs/en/api/ruby/beta/sessions/threads/events/list", "status": "success", "path": "en/api/ruby/beta/sessions/threads/events/list.md", - "sha256": "5401afa6473d71acccc258ea5a886a33747613277ec9210b33387790489aa090", - "size": 63972 + "sha256": "5b324f7e6fe66d16b90af188453cac98ca8e4f0cceafccd4d9c0092d0432e7c1", + "size": 64242 }, { "url": "https://platform.claude.com/docs/en/api/ruby/messages/batches/results", @@ -13330,8 +13841,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/messages", "status": "success", "path": "en/api/cli/beta/messages.md", - "sha256": "a91897203f0d7ea7d529f838aa10d0f795241c5e8f44a9061496d0f9f2ecc199", - "size": 1013173 + "sha256": "d01ffa68664df9b08408cab112ec3b574cbda8fa9eada96d125ba7acb80f5493", + "size": 1023944 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/models", @@ -13358,8 +13869,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/sessions", "status": "success", "path": "en/api/cli/beta/sessions.md", - "sha256": "e2429cb35d89b6f8d9644fee68f5070a95e7598ed948c2866c997ec4b6411277", - "size": 663901 + "sha256": "636efb7d29acb91f9593ac71b57c08487044bccba77f7c47efccfce6857a2391", + "size": 664198 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/deployment_runs", @@ -13372,8 +13883,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores", "status": "success", "path": "en/api/cli/beta/memory_stores.md", - "sha256": "47962e3437cc75c182424abf43551e274809d5d29ee4927827a4352677ab8a17", - "size": 54347 + "sha256": "1acb03c4a04a1574ac5511cd80b0b10f5dc5314029ac072139591dc1feec50c6", + "size": 54840 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/tunnels", @@ -13386,8 +13897,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/environments", "status": "success", "path": "en/api/cli/beta/environments.md", - "sha256": "c9489f6f47f3bdc8be56dab0a4e009808bc743352948297372f07919edc831c3", - "size": 56803 + "sha256": "a8435b2494d9e872ffceaab4a27cbb6f6d05fc793595c580d342d867c70bd751", + "size": 57101 }, { "url": "https://platform.claude.com/docs/en/api/cli/completions/create", @@ -13400,8 +13911,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/sessions/threads", "status": "success", "path": "en/api/cli/beta/sessions/threads.md", - "sha256": "ddf95bb65d8c6dab6f26e8143de3ee081c2fd6fc3060c2307023ecae0ecde66f", - "size": 292901 + "sha256": "b715a0b5937fc4d67d3d2022b3afa76f6138647f2c4b6d2116d01d34c36b3d32", + "size": 293297 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/sessions/events", @@ -13617,8 +14128,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/messages/create", "status": "success", "path": "en/api/cli/beta/messages/create.md", - "sha256": "86a5f299383c3b0e8f12d399b0fa52a48d0199e3e3034dee22f079aa9a468ccd", - "size": 95273 + "sha256": "d4f931246cfdf379a98d0891aed083dc1783b8ce53522c1b525d18c0d483d797", + "size": 97181 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/messages/count_tokens", @@ -13631,8 +14142,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/messages/batches", "status": "success", "path": "en/api/cli/beta/messages/batches.md", - "sha256": "fc93fd9cf959ea10689c62e6492f3b2637f583930420577f6280136d27d826b7", - "size": 257488 + "sha256": "39cddf805251d1f70322e964cdb131c6068b58b0d5bbdfff12c8eb9399b4ee22", + "size": 261318 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/deployment_runs/list", @@ -13652,8 +14163,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memories", "status": "success", "path": "en/api/cli/beta/memory_stores/memories.md", - "sha256": "f290e1707bbba8886396df6b2983071c896081141a46dea2eb88958d18f560d9", - "size": 28696 + "sha256": "8f377cab077635b9b20cf1b046fe0184231ba5abf06546f874048bd1913266c4", + "size": 28938 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/create", @@ -13666,8 +14177,8 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/cli/beta/memory_stores/memory_versions.md", - "sha256": "15a55831eb8fe8eea55046737ba6e6208a69063de51060a9ea48d4515f63b581", - "size": 29362 + "sha256": "f4183cd17e5b264aceb1bdda2ac70412f5c873dbe0e19a757d50a709ea0d31bf", + "size": 29905 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/update", @@ -14002,64 +14513,64 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memories/create", "status": "success", "path": "en/api/cli/beta/memory_stores/memories/create.md", - "sha256": "0a36199c5a16242df6c4081ac66c7fdcb1a50c3d6bcfa58e536e60930d527d7c", - "size": 3618 + "sha256": "800b82d0408f3235846787793a88597b776c10d54ffd29f38e9fb8446ce972a4", + "size": 3613 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memories/update", "status": "success", "path": "en/api/cli/beta/memory_stores/memories/update.md", - "sha256": "ee8d3a13b5ee61dd97fc18c13a5f8f4dfbbbb542729b725f6a8a35b88616dc19", - "size": 4223 + "sha256": "ef6cc38946df1c76bfa3d31713f4eaddecda138c53c768d09c66a0b275d097d2", + "size": 4218 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memories/list", "status": "success", "path": "en/api/cli/beta/memory_stores/memories/list.md", - "sha256": "e1f25f5ee63367a86a7f05a050f8d7f896cb8075b53bc8449670246671438258", - "size": 5612 + "sha256": "6fbeb476e2ca3a8b6d2b489340945170e54dcac0497b1cceccb569ee43da09f9", + "size": 5607 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memories/delete", "status": "success", "path": "en/api/cli/beta/memory_stores/memories/delete.md", - "sha256": "2f27b50034d5cf2235b9bed5fb38bb41a7d0895eb89463bffb9dcbd569647a1d", - "size": 1209 + "sha256": "9389a39267797a977101394fc8527ff95ae1d086eab08828ffcd12efef480743", + "size": 1345 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/cli/beta/memory_stores/memories/retrieve.md", - "sha256": "e0214ed27896a3f86b60971cdec29a43c5ebca70ac7f04b48bae5cfdae5e570a", - "size": 3160 + "sha256": "d335393e4a95e3b0c6f18376c5797f9bcca5a7ac51f6181e3621f58097f2b519", + "size": 3155 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/cli/beta/memory_stores/memory_versions/redact.md", - "sha256": "3d51be754e0c58ae5b5745644ec82abd357c505af19701bed5b91d01ffe7322e", - "size": 6406 + "sha256": "1704c777273e1d963b85838634bb7bab6fd7bfdacd9c58206e273a3ab51700d8", + "size": 6572 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/cli/beta/memory_stores/memory_versions/list.md", - "sha256": "342d572832c8e49ab431d2745ac183f16a1f1c1c3d7291470248b91c5f257188", - "size": 7503 + "sha256": "6a6adcd72caac5ee0625b6f075d67c3fe9167e604cac3e90391610f35ad059fc", + "size": 7548 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/cli/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "7e6324a05b6b43cfd4593c5a9d09f2f6e0069945ce796a948fd4420f7a4bc59e", - "size": 6487 + "sha256": "e029eb1b053c401524433f8cb40f8bd6ef0ab824cc558ce2cdf475daced9809e", + "size": 6653 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/messages/batches/results", "status": "success", "path": "en/api/cli/beta/messages/batches/results.md", - "sha256": "057f09417e2ca87cc457a534c545388c525422c83777fa116d1ca07b9031d8d9", - "size": 60771 + "sha256": "e9907fdc66fb9c2d7196451a46a74560646d79ffc596e1c114c67713a9ee117d", + "size": 61730 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/messages/batches/cancel", @@ -14254,22 +14765,22 @@ "url": "https://platform.claude.com/docs/en/api/cli/beta/sessions/threads/archive", "status": "success", "path": "en/api/cli/beta/sessions/threads/archive.md", - "sha256": "f6c6b0c91981516eb317f7aab29888318df9c3413ee8b54388c87260c45142dd", - "size": 19713 + "sha256": "df24fe22cfbe4cb6de2d42f7bc8f8539cf9b08b56a13d6771b362a47e668843f", + "size": 19812 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/sessions/threads/list", "status": "success", "path": "en/api/cli/beta/sessions/threads/list.md", - "sha256": "3cd607b56855ebb80de1d42dbc58e1dcd6b3f47b988752df03106f697137d1a0", - "size": 20971 + "sha256": "dd325923b37f15a0b9eb0996a036d6f5ee5c4e04c7ec7921153da24e1c8e9271", + "size": 21070 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/cli/beta/sessions/threads/retrieve.md", - "sha256": "8db2671137a467499f49f3de44f1b91edf84d2e27dcc9158b558420946a59da3", - "size": 19698 + "sha256": "8441ebf8073cd20c651e050b26ef69225791271816d9bddbc51e593047adc62e", + "size": 19797 }, { "url": "https://platform.claude.com/docs/en/api/cli/beta/sessions/threads/events/stream", @@ -14331,15 +14842,15 @@ "url": "https://platform.claude.com/docs/en/api/go/models/list", "status": "success", "path": "en/api/go/models/list.md", - "sha256": "6c536356308077220cf05cb03f637098f43a62108fa922acf72f3b6cff94120e", - "size": 9471 + "sha256": "ac5dea1ef7117c760ca2ce49fcb18e1b371cd49df86a5a2150c84dc471618c5d", + "size": 10164 }, { "url": "https://platform.claude.com/docs/en/api/go/models/retrieve", "status": "success", "path": "en/api/go/models/retrieve.md", - "sha256": "732aef94296184a8d91c8704e0786e570b4c57e22510ca893fa0e7b0d17e010e", - "size": 8609 + "sha256": "f63456db4aa2a67391e9b6f34730802b1b146282eb4573d035247f92b501811b", + "size": 9302 }, { "url": "https://platform.claude.com/docs/en/api/go/messages/create", @@ -14366,22 +14877,22 @@ "url": "https://platform.claude.com/docs/en/api/go/beta/vaults", "status": "success", "path": "en/api/go/beta/vaults.md", - "sha256": "ccd0e5fae52dc4d2bb4e6b2cc06430470d395da970b5041043e850fffe973765", - "size": 101496 + "sha256": "ed0293f0ae9f296ed61c113b94e2d2980e5ebee5a0b902f2b62637c14189a964", + "size": 110505 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/user_profiles", "status": "success", "path": "en/api/go/beta/user_profiles.md", - "sha256": "6ddae136665d864e9c1e1f5d68cd8c4db5265296d39b7721e2ab6abf922ed987", - "size": 41739 + "sha256": "55e8c14eb74c5ef80d62b7d7e9f7c4e3d3fc1f1ec7a3e64da0a61d8cc93f06c4", + "size": 45204 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments", "status": "success", "path": "en/api/go/beta/deployments.md", - "sha256": "0ff78c41a601b4baaba57a323d2bb612688088b442653310c7dd05bab586f4b9", - "size": 244853 + "sha256": "682ee5f5491ca3932c1747a2dd0f0a4b1eb7ac60e240b15fba42eff161501387", + "size": 250397 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/webhooks", @@ -14394,316 +14905,316 @@ "url": "https://platform.claude.com/docs/en/api/go/beta/skills", "status": "success", "path": "en/api/go/beta/skills.md", - "sha256": "c2176f1547441b0d1ee337d344b075c655f2571671e9b3723588581cb6eaa16a", - "size": 49920 + "sha256": "9ba9a63042190357ab9e6f7cbfc131b9c9a0cf487271637516051c588e7330c0", + "size": 56157 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages", "status": "success", "path": "en/api/go/beta/messages.md", - "sha256": "03020459d515c44e33aed6fff6c9486b75bd03349f063954818a41ed948f6c84", - "size": 1455822 + "sha256": "4597c41196ffeacad5bfc7703f20321955d7dfdeccc4f1c81e1b0f1e76735645", + "size": 1472915 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/models", "status": "success", "path": "en/api/go/beta/models.md", - "sha256": "28375d8c1ac93cc27f0095b8bac736d2406259252e6c6fd9a2c12c87c09b1679", - "size": 27023 + "sha256": "991bb63ea942f044d020ee1bbcd1bf103196ee06af67bf51665960c695482bb3", + "size": 28409 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/agents", "status": "success", "path": "en/api/go/beta/agents.md", - "sha256": "a0a344dfbb31c0a442727a70f6510af9c42f5d3492f3e58f4cde1b0b87cd8342", - "size": 277325 + "sha256": "1029fdf2cab8e9e622697e9399e36ca95036d182135d87acff4479d1317b52fc", + "size": 281483 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/files", "status": "success", "path": "en/api/go/beta/files.md", - "sha256": "17386f8cff1165bd536b8ce2501d861e5594773e8a92b3d714924a45c9dc0680", - "size": 27727 + "sha256": "8e3602ff7de99d900ff4f121c4e5e6fc61bab4658be6acd872350e1050ad9c35", + "size": 31192 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions", "status": "success", "path": "en/api/go/beta/sessions.md", - "sha256": "134b0243c2df9373471047de438d66310b04927234b80fc201308d8d0a1ea7d7", - "size": 781427 + "sha256": "80214f186c4e3e70fa45902a1f19ad14b231c1bd26518dfd34a3d181ea22dd54", + "size": 794891 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployment_runs", "status": "success", "path": "en/api/go/beta/deployment_runs.md", - "sha256": "9d0f591a9df7950f62afc8831e3bf8b16fac495b08ce4aed2b05dcfcac474d0c", - "size": 35740 + "sha256": "d6602501e6b0e0608c22f00343c893d33223136074db0903ccb1eaef2cf84cf4", + "size": 37126 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores", "status": "success", "path": "en/api/go/beta/memory_stores.md", - "sha256": "aa856038b23da32b249069d3af7ae3909949f5dddd506296ed332ba70655e131", - "size": 106856 + "sha256": "23d23a6d0944bcf890b3af6e058033d38be6f9f1c25d81532c69f9173d45266d", + "size": 117172 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels", "status": "success", "path": "en/api/go/beta/tunnels.md", - "sha256": "19d3a67a16d1a086d76c326f1545f029dcb612fce7f0546eaab66b1092a1c922", - "size": 57487 + "sha256": "4d691e856b37862f1a930412628a7b3070c3f212053937ec70535e42d56fe229", + "size": 64417 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments", "status": "success", "path": "en/api/go/beta/environments.md", - "sha256": "18e4a53ee1c6c79f1f5a7ec3a789da26a572c22cf5018085f724e1138c24ca2d", - "size": 119156 + "sha256": "7070f75e8d080dfd77993c369e15056915bd9bbd9f476d1a3108a0aaf871836d", + "size": 129464 }, { "url": "https://platform.claude.com/docs/en/api/go/completions/create", "status": "success", "path": "en/api/go/completions/create.md", - "sha256": "2f63f91ddb4fa48736347cda2c1d1eb00390a8dcff5152038e169f639e721493", - "size": 11220 + "sha256": "296d60ad1d3ee8d3ad92db2d465a6c448af9b319b210c1e8fa64fddfbe59a343", + "size": 11913 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/threads", "status": "success", "path": "en/api/go/beta/sessions/threads.md", - "sha256": "35f922d1a2168a6f17f60312702f8b2f0eff5fd79fd4a8fbff8ef8183111d1f5", - "size": 311818 + "sha256": "70138308f155d8621b1830c7bcc1ab23203114b3401a32fc4d5dd6b2320f24a2", + "size": 315679 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/events", "status": "success", "path": "en/api/go/beta/sessions/events.md", - "sha256": "52f65ac2b3794c455d670b01fd6df94be7d5f84c45e16065ef9a8972640a257c", - "size": 431745 + "sha256": "ca2d6cdccecdf631926174c04f1f7cfbeba356f0aca3b37425bec3e75c993a83", + "size": 433824 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/resources", "status": "success", "path": "en/api/go/beta/sessions/resources.md", - "sha256": "37872429bee3bbad59bca32fb0ca8b8ec973e8060bda526bcda6e979432eb869", - "size": 39372 + "sha256": "320b29469e30310ae7779916aa7530874c07add469c6aa97fd7035271341b559", + "size": 42837 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/create", "status": "success", "path": "en/api/go/beta/sessions/create.md", - "sha256": "b101c7daafdecd51f2659669b17bcbb0aaf2b4eea0678a31bb2324258aedab37", - "size": 66668 + "sha256": "aef1d732ed102cc7cad76e37b5f3246ab3cf44398f22714cc555c19257cf7021", + "size": 67361 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/update", "status": "success", "path": "en/api/go/beta/sessions/update.md", - "sha256": "7e2587fa543f08950d1511120e6df3fb21eff1ee9cd54f58f8279f04640bb9ba", - "size": 35248 + "sha256": "e8e47ffe57ea1e41d3416568103d28efa9ca2f4adb099d655e376191432eca52", + "size": 35941 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/archive", "status": "success", "path": "en/api/go/beta/sessions/archive.md", - "sha256": "17b5d4f9fd7d36519fd41a2f5406a9ad2144c079de10563f4d6430693421ccfb", - "size": 34227 + "sha256": "af6ffa4eac85d60175625f5437280876b0dab8085aa671ddeab6182d53330f3e", + "size": 34920 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/list", "status": "success", "path": "en/api/go/beta/sessions/list.md", - "sha256": "2ce561fe933e8522ba99e76ba150d888cd4970aa92b05ed23eb689acde46c631", - "size": 37299 + "sha256": "b732431a97cca54f6d7d2da717ac3e169d49b1d3ad3cc2691ff51b546034c3f1", + "size": 37992 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/delete", "status": "success", "path": "en/api/go/beta/sessions/delete.md", - "sha256": "27067309c957b5ad222362dc443a71401caea852425913f5604398201088208e", - "size": 4581 + "sha256": "179034ae5b93d4a8245dc3064dcac10bd58888d62b76679735a75df6db2359a6", + "size": 5274 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/retrieve", "status": "success", "path": "en/api/go/beta/sessions/retrieve.md", - "sha256": "44de6eb94a496dafa4baf8f76bd56b5c5aad67d7156fbdf49c18ca2d631f311d", - "size": 34196 + "sha256": "b528090ed6bad1b48d66afd80182b9b5ed27fa5a184f727f1fd5958e7abbb105", + "size": 34889 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/agents/create", "status": "success", "path": "en/api/go/beta/agents/create.md", - "sha256": "fed911d8f968dc693dfa408144c0296449b9faa1a410a266bc0c124aae93f961", - "size": 42248 + "sha256": "ae0e70cc5839e076b01291b837260232d32ee4620f2f2776de048966dcb836a7", + "size": 42941 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/agents/versions", "status": "success", "path": "en/api/go/beta/agents/versions.md", - "sha256": "22e36a307dd24158446febed8742daeeb8d84bf04e9c9a36fb2874db10044c72", - "size": 21251 + "sha256": "bfec340528648565d9e6d78d4a12ddd79862e9342319cdc38243ee3150c66638", + "size": 21944 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/agents/update", "status": "success", "path": "en/api/go/beta/agents/update.md", - "sha256": "11e6a7d6c4abd3eee170ad53e391cda97216deba539c097a66230f19187ed7f9", - "size": 43044 + "sha256": "49a3005216326d6b88f33e6e434019981229ed86bea986eb31293d457ed9f038", + "size": 43737 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/agents/archive", "status": "success", "path": "en/api/go/beta/agents/archive.md", - "sha256": "93f77e79ba12bd4510908a2f609b55dc724bd230a9386f334ad9d6fe978f2c38", - "size": 20661 + "sha256": "0d23ed6642e075875864b1add8433a5c63beb3e56104b6b7c99969ac8572e31e", + "size": 21354 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/agents/list", "status": "success", "path": "en/api/go/beta/agents/list.md", - "sha256": "1535172ba1125bccd77452cfee95ffefb1447d4ef0c5ddf53c591b547799c606", - "size": 21532 + "sha256": "a21ef712c3610a4c9da5cd8e933ec939475524e77949f4ca2e9234d69e0f08a2", + "size": 22225 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/agents/retrieve", "status": "success", "path": "en/api/go/beta/agents/retrieve.md", - "sha256": "08faa33e42f41ac3c911effd20b262d5c183c63a6b1361ca63f2547ea949224d", - "size": 20808 + "sha256": "dd81cad4708d2eb865d3165dee23c68f8eba7c80ed5eba31c6da6f89648e7284", + "size": 21501 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work", "status": "success", "path": "en/api/go/beta/environments/work.md", - "sha256": "aec435a73f8cb8047a45c4fc35516a2f76434e006250a29f1eccd7b7247ee249", - "size": 63166 + "sha256": "f099cd408bf2f03f599e2f3934db5507d9f279ece25e59b259f33d67ff216790", + "size": 68710 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/create", "status": "success", "path": "en/api/go/beta/environments/create.md", - "sha256": "e154f2a5a036445fd9112c512250e7d1ba1d1b9ee4b005c974ce5e453c70790d", - "size": 11539 + "sha256": "00f0bda15b600c4cd6b2003c3f9899484281ef295568123c406259b478beaf25", + "size": 12386 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/update", "status": "success", "path": "en/api/go/beta/environments/update.md", - "sha256": "eda088f1e1529f222838a82a8ed6f348a8cfbe2edc2b2337241296aef513cda5", - "size": 11674 + "sha256": "6b56faec4642d9544ca230bea35a86ae2d32f574be3169f0d293e10786cd242d", + "size": 12521 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/archive", "status": "success", "path": "en/api/go/beta/environments/archive.md", - "sha256": "2472e24930d3c5c0e14668495f70456a44b11ec064a755aff64c6149aeb93b0d", - "size": 8182 + "sha256": "91e04700f0d8f288dc2abef4693a82e502d795e6544c5bbca32edc2b158d4576", + "size": 8875 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/list", "status": "success", "path": "en/api/go/beta/environments/list.md", - "sha256": "809706e77c26ca041b516b64448792509a6a17eb214e1e2276d8951d54d82940", - "size": 8676 + "sha256": "327aafc8f28a221c11e4eeb98ceb643c05e2e2d7341fb3fcdaaaa9789672a1c3", + "size": 9369 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/delete", "status": "success", "path": "en/api/go/beta/environments/delete.md", - "sha256": "6cdafc4dc1720973b4be7aa2ffade298432b0ab94b9b592b111c2530dfd863f1", - "size": 4731 + "sha256": "abb324712294c4b325cd83619ea1ad9ae107999dd3efc480ae16f47795104207", + "size": 5424 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/retrieve", "status": "success", "path": "en/api/go/beta/environments/retrieve.md", - "sha256": "edc59592da001d243330dbded87bae31bbce88cf98f1515cf460049ad7259e6c", - "size": 8103 + "sha256": "d581b753f05c0b826bc9062eb455f6b2ff75a0a348e7bc0efdf9b63872fec8d9", + "size": 8796 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/models/list", "status": "success", "path": "en/api/go/beta/models/list.md", - "sha256": "031e0d9a068dcd5a039d0886ba49f206a57db28fd770891674e4d2b7dfad24a2", - "size": 9849 + "sha256": "a142e31997d4ee7317d405a347bcfa3c2d46173002ca32d3b73cc9a679db6ce0", + "size": 10542 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/models/retrieve", "status": "success", "path": "en/api/go/beta/models/retrieve.md", - "sha256": "d2ffc3a6417e8f12c5e0fc658e3fe9e1402ece9fda9f6dea838d17e0f88eb428", - "size": 8983 + "sha256": "e6e37546cc1360467a7cc039534abb58477e219632b5436c67ed8d3958235606", + "size": 9676 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/reveal_token", "status": "success", "path": "en/api/go/beta/tunnels/reveal_token.md", - "sha256": "7a2dca62fc15700fdde5ebb72a65540fe6020c5fa2e0444fe9462fc345917d08", - "size": 5157 + "sha256": "6ab9edfb5963d32109be0857235f23760d328edeee3c22e71c4241bb08966d7d", + "size": 5850 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/create", "status": "success", "path": "en/api/go/beta/tunnels/create.md", - "sha256": "a04cb970341fd3a4f985db744ba625b5fd74bffaa5595efb0bbe3764320bf751", - "size": 5592 + "sha256": "dd5c432efb0f5089e034803a6fd004dfa351d5bdc388bc480c7a8dac9d3aa9e1", + "size": 6285 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/rotate_token", "status": "success", "path": "en/api/go/beta/tunnels/rotate_token.md", - "sha256": "7ef0f6217ebed19c904fa1dbdb20647fdac774658c44075f6454c2ee8d7fbcf1", - "size": 5300 + "sha256": "4830e17e104dcce41e85c71fe53a024904395b44aa2ae25cf507c0a8c5fbc777", + "size": 5993 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/archive", "status": "success", "path": "en/api/go/beta/tunnels/archive.md", - "sha256": "7d265d59ddeeeec3b5f0213ae238ba224b4a76adb546f01de1094b202de4128d", - "size": 5613 + "sha256": "ecf96064fc46e3189e6bd5109b6192764a74a5ce6165a6e99b5d099370c94f1f", + "size": 6306 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/list", "status": "success", "path": "en/api/go/beta/tunnels/list.md", - "sha256": "48b547d2c28dad9d31f888078292a1189b6c796afbcf624e7eeada892f4721a2", - "size": 5873 + "sha256": "4c42a85b4b87bb874c2792714dea2f9d92a09770836b0b5dd9ec39b3fdb33889", + "size": 6566 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/retrieve", "status": "success", "path": "en/api/go/beta/tunnels/retrieve.md", - "sha256": "306570f9a4ed1d13ae4fae905239eca7270fff9510f9332286f3843c8ae84209", - "size": 5317 + "sha256": "d22f3a54de3ad6b98f383f61fa07d285408094253065a60104b4d7674454b9c9", + "size": 6010 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/certificates", "status": "success", "path": "en/api/go/beta/tunnels/certificates.md", - "sha256": "62af54e73716bdb2ca1ad8eb3b94373436039b0eb55f86a4cb006ab43971ea01", - "size": 24239 + "sha256": "0aa4e01a69dbcbeeb40652c616be81e01cc160749eac634435ef1a87ffaf4784", + "size": 27011 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/create", "status": "success", "path": "en/api/go/beta/messages/create.md", - "sha256": "5a0843457bd60bdde61c8f9c890e1072a8838e022f62c3aca9d41598ba6ebc5d", - "size": 201883 + "sha256": "4462758b44d166dfc03e3604f63971098d9fc3e35b27aebf9602c976fff8060f", + "size": 204484 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/count_tokens", "status": "success", "path": "en/api/go/beta/messages/count_tokens.md", - "sha256": "4545aa229cb689829296348dd64864af657e84a5ff2ce4797a2900d513d6bce1", - "size": 130061 + "sha256": "ea374a9800ed389863ff98daf0ec56c7b3efbc60d17015e15fe2a7683fbbad56", + "size": 130754 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/batches", "status": "success", "path": "en/api/go/beta/messages/batches.md", - "sha256": "7a0244227c565755290001234e710d11d0bc68d3fe1d03e1d3ba6afa64caecc8", - "size": 441076 + "sha256": "4e78b46e39ef389e494baeabc613b466bc58d197476c1ee0256cc8ca3a1f7ada", + "size": 449290 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/webhooks/unwrap", @@ -14716,652 +15227,652 @@ "url": "https://platform.claude.com/docs/en/api/go/beta/deployment_runs/list", "status": "success", "path": "en/api/go/beta/deployment_runs/list.md", - "sha256": "eb5cb65c6d3ef56a11cb934cac12ff3a5a2c1317e81b2c1f5e269d637b4cb35f", - "size": 12262 + "sha256": "5fd7f5687f23abaa8be6035c84869700e1bdd26b77b483dee70350cb3aaa8623", + "size": 12955 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployment_runs/retrieve", "status": "success", "path": "en/api/go/beta/deployment_runs/retrieve.md", - "sha256": "6f0d6716c9dcad7a1709cbebd1b9f94025365ef2e60603742079c0d836a52f88", - "size": 10841 + "sha256": "6cb493be4ba31c96ffda328db3bd9544cdaa04530f0a4fee0cc45f4fd7333d85", + "size": 11534 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memories", "status": "success", "path": "en/api/go/beta/memory_stores/memories.md", - "sha256": "700b66aadef5c6c1ca24e74800399bccbdefdf7cbd1001264445593057f677c1", - "size": 48747 + "sha256": "6c27a589a99d1e926ef17298fefdb46a4696e140a512d1cb16cd3ee258091820", + "size": 52454 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/create", "status": "success", "path": "en/api/go/beta/memory_stores/create.md", - "sha256": "0f77a4cb18a8d35c71f5aa3bcfb5363f0a6782acb53ea3872ac76a0ed1f9a62d", - "size": 6811 + "sha256": "8ff0cc8e7865ddc49f95855689a2b7e0d3d5eabeff537634f1b37cbfe7bd0144", + "size": 7504 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/go/beta/memory_stores/memory_versions.md", - "sha256": "86d2dbb8982743e26c50a401ebd90adaf04221e10cfcd6ae6aa394f87554ca8f", - "size": 39257 + "sha256": "5aacd3bff5b6945aa7e45a09aca694fb47e13ec7849c74255f2c207217df13f5", + "size": 42000 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/update", "status": "success", "path": "en/api/go/beta/memory_stores/update.md", - "sha256": "ee9c4da57bcd6672fab639c82cf52f3a3785df6a17d4a85ed4824cbe94a9dfb9", - "size": 6742 + "sha256": "d7ee984858d8b04604ace369a2fba33eac0511d02c9dd640c294f9da284f6ff2", + "size": 7435 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/archive", "status": "success", "path": "en/api/go/beta/memory_stores/archive.md", - "sha256": "27d6dba36c33938ba97a128088215310c395aeaad37d9a7b4834077bda91cbc7", - "size": 6024 + "sha256": "a3fd5422ecda25edf1b36aeb4b7894ddfa703c8f54a0b98fcbcdb5d29fd65dc5", + "size": 6717 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/list", "status": "success", "path": "en/api/go/beta/memory_stores/list.md", - "sha256": "9a873777d0492dcccf3613b9aeb8adc512e2b1156b2b493b77e17282b9900d99", - "size": 6953 + "sha256": "592412e4aa8a10e5da20b176079ac6ac11342984a5add835f34bce0c34aacb39", + "size": 7646 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/delete", "status": "success", "path": "en/api/go/beta/memory_stores/delete.md", - "sha256": "1a260d14f2137c155368d44e78413c5c86264a251955fbce46c0cfef3b36f283", - "size": 4739 + "sha256": "319bd163426b470bf62aa2ec8f828338a9f69f9bbda610d237356348811fd9ca", + "size": 5432 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/retrieve", "status": "success", "path": "en/api/go/beta/memory_stores/retrieve.md", - "sha256": "26cc1e8dc589e17ab4ff1d5a3986840e0648e5ea63145628296caa5f62f34987", - "size": 6003 + "sha256": "2a2ba0c76c2bc4de1c2f06122be37883bcf8b7c341bf65a1bd97d3e2b2b0f1b7", + "size": 6696 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/user_profiles/create_enrollment_url", "status": "success", "path": "en/api/go/beta/user_profiles/create_enrollment_url.md", - "sha256": "7c075ca4dcc740b3b1a9f6c727013931d1e9d70c8dd678bc33279a1575255dd2", - "size": 4892 + "sha256": "f152b6427ab6da70fc017913b9851963f6363b033077bdf9565d3bd77a9217dc", + "size": 5585 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/user_profiles/create", "status": "success", "path": "en/api/go/beta/user_profiles/create.md", - "sha256": "4ba8db281e398f34cfdf97b3a66ce09d8b066aa23b31a61ac26f887fd39f91f3", - "size": 9193 + "sha256": "2537d464f9f443457439ffafd51015d5c8b6381c50c86ccfdea061cddfacae4f", + "size": 9886 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/user_profiles/update", "status": "success", "path": "en/api/go/beta/user_profiles/update.md", - "sha256": "6c168cdedf44416fe70d5ac6f43e0b3c54d9312537a2d648ce6847bd297334d5", - "size": 9285 + "sha256": "268b992f093553830b1ca75578f018abd190068d28f06be8b4730bb62ecd383f", + "size": 9978 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/user_profiles/list", "status": "success", "path": "en/api/go/beta/user_profiles/list.md", - "sha256": "5df2fce2a47c56e9dab667622f2e13ec886479678fc7ec2a35ad2e230137c590", - "size": 7728 + "sha256": "e71492770fc2ef5b25237aa381671683c62b286fb4101b335f6393ae02c04c76", + "size": 8421 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/user_profiles/retrieve", "status": "success", "path": "en/api/go/beta/user_profiles/retrieve.md", - "sha256": "fbfdcc52e4c3022e806d091fd90c94950f4b606fe953ac5441a195d41b922c78", - "size": 7208 + "sha256": "360b3723b7020ca43a457e8d1f1784cb7db89ef2c2cd6c9cb8410f56afa16bbe", + "size": 7901 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/create", "status": "success", "path": "en/api/go/beta/vaults/create.md", - "sha256": "612e52cf30a33a0390dc65c39f5686c08d23dca6dfe2c72a64c2e301e79d19ba", - "size": 5433 + "sha256": "520c222ee8eea3e9f7b0610475ebf9c7373747c0d39a874a1b956853432ab13e", + "size": 6126 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/update", "status": "success", "path": "en/api/go/beta/vaults/update.md", - "sha256": "99b8ba1b9354774802c2cc257dc44f29da5c07af9eca74702ed4a1c400ab80a6", - "size": 5499 + "sha256": "6ab079458768818251f78073c3509da0aeedd5aa153db73d5ba8044ccb7b312e", + "size": 6192 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/credentials", "status": "success", "path": "en/api/go/beta/vaults/credentials.md", - "sha256": "b86e2347623ad09b1beb329854735462d2752622075cf4bdf493a36f48152909", - "size": 101648 + "sha256": "24e4bb3e245b6d1bf5215090b54154efaade9196642f1c8028f85fdb481f0266", + "size": 106499 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/archive", "status": "success", "path": "en/api/go/beta/vaults/archive.md", - "sha256": "986ded04e8eb215b9a0e881e87ecc2c4ffd660d5503240342933e3b4ccca5773", - "size": 5155 + "sha256": "b6cf88a3786a34fbbeb9783ad7a71a228fa9206dcaedce8897bd8fbe5942c7e9", + "size": 5848 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/list", "status": "success", "path": "en/api/go/beta/vaults/list.md", - "sha256": "f2af4b570ab493d1d5f2518990ded65054c650428e85c0225c233174d0b049c7", - "size": 5549 + "sha256": "3a3f9753df7d6238eb925270e6781a13aafa7afd2b680fd87ba278674c14dd6e", + "size": 6242 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/delete", "status": "success", "path": "en/api/go/beta/vaults/delete.md", - "sha256": "d318507a0aa8533bc4eebd36a94341769d3b4fc06b20322e75064e193015b1f3", - "size": 4565 + "sha256": "9695726478baf0fafa39a2f2ef394343ca567aa59682e9662c1ca3300403ae5f", + "size": 5258 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/retrieve", "status": "success", "path": "en/api/go/beta/vaults/retrieve.md", - "sha256": "4d3e573b713659f6462133d8b0044f24e8f696fd82e4151e17755e49d41690e5", - "size": 5124 + "sha256": "2840bdb6439e37469d9f23f42ea1ca8bd66272fb9b1a58a1231248a4cb223ddc", + "size": 5817 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/files/retrieve_metadata", "status": "success", "path": "en/api/go/beta/files/retrieve_metadata.md", - "sha256": "f8ca0b4761be27cbae2cd6f2fde9268909a9801c3934069bf3e9da6ef3820ec5", - "size": 5524 + "sha256": "208d9c63c28cd0daa68e5ebd3feb66f966f26000237a3aff2c721ca15664e31d", + "size": 6217 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/files/list", "status": "success", "path": "en/api/go/beta/files/list.md", - "sha256": "fef8b4c464a762b900c4382b46d0409129972c2e0f0775eb1cd834842130e2b5", - "size": 6298 + "sha256": "40792b12847a3d289ce3dd24336b9c07cb599de21d19d4f541ef4d78f128e47a", + "size": 6991 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/files/delete", "status": "success", "path": "en/api/go/beta/files/delete.md", - "sha256": "ac04babcb3e87c35e004b1e3bfdd34c96ac8e73a64e90d0c961303ff63570ee4", - "size": 4550 + "sha256": "1d6626199840b302fa98775d55141ac5f7ec804e1a6f16b5087d6eb1e10ce284", + "size": 5243 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/files/upload", "status": "success", "path": "en/api/go/beta/files/upload.md", - "sha256": "82da7e372c0c5af75472f04cca7a1503f6be14fe81807b43bdbf128e544324dd", - "size": 5597 + "sha256": "d8f3f7053e7cf0f43155a2c632292deddc5aba67255a8ae6c1082f24c1272d6d", + "size": 6290 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/files/download", "status": "success", "path": "en/api/go/beta/files/download.md", - "sha256": "eb58069c6ae1157c9b98d80ec4dbf9e0e39596cf571f5116e5f767d8b768abe1", - "size": 4257 + "sha256": "e1c33a402e08ea88e75e35fbb8e929d381fec14b8663cb40b898b1190e252b03", + "size": 4950 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/create", "status": "success", "path": "en/api/go/beta/skills/create.md", - "sha256": "ad6bf0b3c7dbfea6bc053fc15adf22814cfa7a7c3f4767281ad3e228184f5417", - "size": 5828 + "sha256": "4f274918702685abb002fafc2c45b537c8c31388a6c2fd994f64aa5efb9baf42", + "size": 6521 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/versions", "status": "success", "path": "en/api/go/beta/skills/versions.md", - "sha256": "1e38953d2f8deacc0b6d30c60b33e5dc1eab14a01fd1831e200a30019711c78a", - "size": 27770 + "sha256": "49ef46310243e352b0a6c0bca1af1441789f72a116257b85145fb0297705c847", + "size": 31235 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/list", "status": "success", "path": "en/api/go/beta/skills/list.md", - "sha256": "50afe511f86bd611d327b63b519e02a7d86da976c00b164212237234d55e0e2b", - "size": 6112 + "sha256": "41ee68b84cf1aa75ef86169b0f794208edcdda082539f1eda45a6a965653c55d", + "size": 6805 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/delete", "status": "success", "path": "en/api/go/beta/skills/delete.md", - "sha256": "d8fb5e4e157a8664d366b050af16cc56a6b5bf37d10799c2fd905165a2bc0f10", - "size": 4661 + "sha256": "a460f4e3d10da2c90fb4e89518a2852f0bca8e53b37514362c8f52478c79cbaf", + "size": 5354 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/retrieve", "status": "success", "path": "en/api/go/beta/skills/retrieve.md", - "sha256": "80d1e9de0dfd65ea221091ffe5a26f6cca983bd7c5cbb2bd9715ec79562b434c", - "size": 5479 + "sha256": "724dda5c1ead9f859ca40ec6ca8feec19ece3a9922ea15c1c08bce2f1e960abf", + "size": 6172 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments/pause", "status": "success", "path": "en/api/go/beta/deployments/pause.md", - "sha256": "e1b006104fcecb87b3cc6fda5142cc9457b8c370908ef3cdb86b230ff4710c47", - "size": 21667 + "sha256": "668a405df1049c3f7349cc6d71cb71f112fd77ccf6951245878f171a713f2414", + "size": 22360 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments/create", "status": "success", "path": "en/api/go/beta/deployments/create.md", - "sha256": "b9117663006ba8e6ee685f61f613bf2d554f39122fb6dc41bc770fc8ab83ef5a", - "size": 33308 + "sha256": "07d443f664f20b1e26874f426ed9f872456fa064afebd022d4bf230ce35897ea", + "size": 34001 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments/update", "status": "success", "path": "en/api/go/beta/deployments/update.md", - "sha256": "80da95651b84de95b42a367486894527bb49c48264cca5129a03f8f14757661d", - "size": 32835 + "sha256": "721be58fe3757d9159040b041e19a46e11cf25439ebe0fc7e67fedc3bec1657f", + "size": 33528 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments/archive", "status": "success", "path": "en/api/go/beta/deployments/archive.md", - "sha256": "396ae9753bd69e85d06afd37a2e4eb1c362709df7990f9000dba4bdacfb87c7b", - "size": 21681 + "sha256": "8937914661ce0ead7769205a25207755fde9ef019c72fb0f5ca165c9aaa6935e", + "size": 22374 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments/list", "status": "success", "path": "en/api/go/beta/deployments/list.md", - "sha256": "61a173b3c65a23ffebdb2cd136b0a053f92e12b52a12be65ca99121bbea4a2fc", - "size": 22831 + "sha256": "5d060f5a9a556153f380e2e788487ff0c3891d637e54ab921e55b88f549250e2", + "size": 23524 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments/retrieve", "status": "success", "path": "en/api/go/beta/deployments/retrieve.md", - "sha256": "14f9ae3c0cdb249b82985d02fa820c79f6dbb351b0dc6c8dc1755a51a9ffe64e", - "size": 21650 + "sha256": "e8cdd77801183923635c35ded9f5edeb0be6b23bfcc603f81940f4fd2a8ad4f9", + "size": 22343 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments/run", "status": "success", "path": "en/api/go/beta/deployments/run.md", - "sha256": "07401e8772964864de5780ac9ee3a5eb422e372dd3f251028533d63f8afa4110", - "size": 10830 + "sha256": "4bf9bcb6f11bd2cdad0bef37947512bb5ac4d65f631dc60cb422f0266627647d", + "size": 11523 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/deployments/unpause", "status": "success", "path": "en/api/go/beta/deployments/unpause.md", - "sha256": "31b126e819a96c3d3c55d33ab63a1a9ade78861b9305f841894fd59d3e52760a", - "size": 21681 + "sha256": "b24d6cd06bd5fcf67d04b231ca75c317e4973c75cca29d1a70c5cdd642b3c0d2", + "size": 22374 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/versions/create", "status": "success", "path": "en/api/go/beta/skills/versions/create.md", - "sha256": "3d35c191cec30fa4a69f5b8bb698b050ac5d91e88f4aab373f78529d7c233cab", - "size": 6014 + "sha256": "604bcc217efafe81f491872e2554de7e97b7941a762ca1011cc4173891b34781", + "size": 6707 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/versions/list", "status": "success", "path": "en/api/go/beta/skills/versions/list.md", - "sha256": "24bf5bd9c5d53e693ef80dca3c7a9e531362ce15a4af0d6d1f1c79c25aeebd83", - "size": 6129 + "sha256": "fd70d90dd4d044bcb94d1c9ca154238d99f9baeeead6fcc81483deb5bcfd1200", + "size": 6822 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/versions/delete", "status": "success", "path": "en/api/go/beta/skills/versions/delete.md", - "sha256": "2b1e36fdb72af514eeb0ea9518d724283ce2d9193b61bbd298177d18695fae96", - "size": 5001 + "sha256": "bb6f18ea1560f58af94592be4029689e7b3879964d329ce57578a61832aa21d3", + "size": 5694 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/versions/retrieve", "status": "success", "path": "en/api/go/beta/skills/versions/retrieve.md", - "sha256": "3de75958e35777d064758bb4c719378e10b2c1aaa4a58b56dab1835939b9dc73", - "size": 5920 + "sha256": "680255ebb9e893039e2405cba5145634ee32a101ddac0d1f5d4d923443b2334d", + "size": 6613 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/skills/versions/download", "status": "success", "path": "en/api/go/beta/skills/versions/download.md", - "sha256": "34318e474615b48ecc898e21b71cf44a053e1ed00a1341a76156d873e3701458", - "size": 4666 + "sha256": "102c15dc43e881cdca6531eb895ed08e0d558bb7d1b8253f68cfcfe5a6cdfa52", + "size": 5359 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/credentials/create", "status": "success", "path": "en/api/go/beta/vaults/credentials/create.md", - "sha256": "7192f1d8add7e9520eecbc5a348e0750a64af99f2d3d857ecc0fa4f4706b44fa", - "size": 14632 + "sha256": "e67c134e607ee84abc1b65d57da1f05247bb49bd0fbe70e8a6af2a55eda8a654", + "size": 15325 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/credentials/update", "status": "success", "path": "en/api/go/beta/vaults/credentials/update.md", - "sha256": "576ef5feaf24414bdb71b8194b398361bbefa399ab0138f979e26a7a9edcd37d", - "size": 13638 + "sha256": "2c96a94d5e6d9f1c02d804fa1adced137ee8414527b569cc3398b07534ec114f", + "size": 14331 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/credentials/archive", "status": "success", "path": "en/api/go/beta/vaults/credentials/archive.md", - "sha256": "9d5f88f89c47f2e6a9f6ace736deb1ab644aa064762209b012433cce91c50655", - "size": 9319 + "sha256": "10ed3762f01d45af3a9bd0cdef052d6af2891243507a33dcbe9dc49bd29d2302", + "size": 10012 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/credentials/list", "status": "success", "path": "en/api/go/beta/vaults/credentials/list.md", - "sha256": "2154d9f04ebf719c25e192821f183936aa6999832f3aef7b06e83765fc069feb", - "size": 9652 + "sha256": "91eb67cd329c94b042ee20248f06e1ffd9aed8339d4605659247015c7a907739", + "size": 10345 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/credentials/delete", "status": "success", "path": "en/api/go/beta/vaults/credentials/delete.md", - "sha256": "396cbf0bd8e8aab743265144c1cfadd55a962cf2cf9ff661edd2b3f900a9c442", - "size": 4846 + "sha256": "d3d8d9f88ac4a19c43ff20f752d91d55b44b3ca07beda48f5e6d63ecc4f742af", + "size": 5539 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/credentials/retrieve", "status": "success", "path": "en/api/go/beta/vaults/credentials/retrieve.md", - "sha256": "bb1b5193dc065ae64b0b015ba5895137c7f08b7da95cf67b2122ef58626d0058", - "size": 9286 + "sha256": "1912cd6d84f1078a23b89850a3b94f75dacd753f84a5ea22d1d70e6baea73f8f", + "size": 9979 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/vaults/credentials/mcp_oauth_validate", "status": "success", "path": "en/api/go/beta/vaults/credentials/mcp_oauth_validate.md", - "sha256": "e760829c9b0312d996728023224f87768723b1dd425b9bc0834789317407df93", - "size": 7754 + "sha256": "037c84235f3111a4657396a1db9555b823023070a699ae86ea055cbafc7eceb1", + "size": 8447 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memories/create", "status": "success", "path": "en/api/go/beta/memory_stores/memories/create.md", - "sha256": "427be441be264eaca562864bdc4c39187ad1b11a622b3c219aa97fd7195d757a", - "size": 7530 + "sha256": "eda5e7d1257f99aedd754f1a7e689a2736783f47a80a84cfce63bf814f039b24", + "size": 8218 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memories/update", "status": "success", "path": "en/api/go/beta/memory_stores/memories/update.md", - "sha256": "cafcbc4ca1ff1f7e4c065268d61873e20fecc4feb7c7800aa72acdc6d84bb3cd", - "size": 8180 + "sha256": "2e6e23cb617a39143595e099463a4c26f20f847d59b541adf81dc49a3ca48ae6", + "size": 8868 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memories/list", "status": "success", "path": "en/api/go/beta/memory_stores/memories/list.md", - "sha256": "d9dc0e4782ebb9ab602161de5dd43d398cda96640c9d375e0f0f06f0f899cd97", - "size": 9169 + "sha256": "4590d0838ee971a2ae00f060cefd163e9e0f2886c9e991167160a28ec7d5967a", + "size": 9857 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memories/delete", "status": "success", "path": "en/api/go/beta/memory_stores/memories/delete.md", - "sha256": "c4e6be04e3386fd8b241a204d1b6e8b43bbbeb3f8018b5e3a93c5b040bdc1ee0", - "size": 5128 + "sha256": "52f37232dd27ba8a5c0e46329264c83e9be8cc637ad3eee38098c304bc6cbb10", + "size": 5957 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/go/beta/memory_stores/memories/retrieve.md", - "sha256": "a148b3a29c5d4d87e432c4992c2854969546fa0a79bc59ac5a7d7ecad5e270e4", - "size": 7034 + "sha256": "d3f87acd9ec3477d91b8f7b61f66b154d58ab84722103847c60b1309f0e72cad", + "size": 7722 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/go/beta/memory_stores/memory_versions/redact.md", - "sha256": "848de8a29c658eb9c50e4366bab4e94b02f854c06604fe27a3586002920eaf03", - "size": 9805 + "sha256": "f5d102731cbdf7ebef28efc4145a7fce3c6cc5b3c57ecf419a10267148aad1a8", + "size": 10664 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/go/beta/memory_stores/memory_versions/list.md", - "sha256": "312db67dbff390b3eee41c372ffdb8a6fcc89f187b64a0fa54a98c517847f3a4", - "size": 10824 + "sha256": "6d345be62ceaa768c558359c49183f1a1caa202519e56c8d6ef269b52eea2c51", + "size": 11683 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/go/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "e8dda45f5f41844010d2fc26ccd5a0be888569de2fc418da0327c865db69df2e", - "size": 9894 + "sha256": "7e7c6d571662eb45881b353b14774e5416ebb09c9be356457f5555300cb38e9c", + "size": 10753 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/batches/results", "status": "success", "path": "en/api/go/beta/messages/batches/results.md", - "sha256": "28861db32b7cff9cf0d96b509b105a056791156dd07c59c1831532cf188b6104", - "size": 66935 + "sha256": "ea73c6ade711b7cd0e8d7cb3fa952ec75043d1697ca02cb80fd8f6a488511e0b", + "size": 68587 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/batches/cancel", "status": "success", "path": "en/api/go/beta/messages/batches/cancel.md", - "sha256": "bad5db02bb6f0931b8f3c0188e34a46002b421515cd8799f7c5851c1f9f36287", - "size": 8736 + "sha256": "a566ce7cb3eef21091ea3cd1bdf772976e78b75136cdf9d8511cdb562a75cdb5", + "size": 9429 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/batches/create", "status": "success", "path": "en/api/go/beta/messages/batches/create.md", - "sha256": "f6579dffb1627fa430fb9c64050aa448d71659aa203d9121a5dc95cb2374c044", - "size": 158605 + "sha256": "2ac50e00ed31edc1f07473298d8c987ded99f92872e96ae35e0c5853c17319ed", + "size": 159524 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/batches/list", "status": "success", "path": "en/api/go/beta/messages/batches/list.md", - "sha256": "cfc09f561b47c0bca3eee735153d2377c9c0714170790f49dd067c7d16c2623e", - "size": 8913 + "sha256": "0079db271f793c7f37f12a4b0005edbf0916c0eafd5faed1cfe854a166336cf5", + "size": 9606 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/batches/delete", "status": "success", "path": "en/api/go/beta/messages/batches/delete.md", - "sha256": "ac4761f5ba739356da06aa6140a93f780a52366330de009eabfa259bc00587cc", - "size": 4999 + "sha256": "6837060ea9133cad9dd7c2e4938a67085dddbac31b65753a5aa539abb52647ab", + "size": 5692 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/messages/batches/retrieve", "status": "success", "path": "en/api/go/beta/messages/batches/retrieve.md", - "sha256": "5fe59eb2b77f06f81d535b57146f7903211051c14d084023d7af8ec66c8424c0", - "size": 8410 + "sha256": "9a39a749b2745d75ef46785f7b9c915892a86f5568a44bc54775e7633023a9fb", + "size": 9103 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/certificates/create", "status": "success", "path": "en/api/go/beta/tunnels/certificates/create.md", - "sha256": "e28efdc3fedf094220c9399959fddc492dfed52878ffb768e4cbaf782307aca7", - "size": 5921 + "sha256": "12349805b4744023ac2ec57a6de877c8705ba2c7b3d693b1db45e5d35394fd3b", + "size": 6614 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/certificates/archive", "status": "success", "path": "en/api/go/beta/tunnels/certificates/archive.md", - "sha256": "a43319ff60f9d4f3ab7733c44512b07ff4a452c1da6980520d35e278b07f914d", - "size": 5881 + "sha256": "1378ea3a09e43574e3b0834e1d72ae898dcb236777bba037cfa6e6a0b9e47e0a", + "size": 6574 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/certificates/list", "status": "success", "path": "en/api/go/beta/tunnels/certificates/list.md", - "sha256": "6a519ca8e08eddd7a31ec957cc25a2fda8f83a1764159eb0582a9f3b949738cb", - "size": 6084 + "sha256": "f32e03868e6763525e6264c3b013a2f0be2da7fc807e306723114a8eb3371b68", + "size": 6777 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/tunnels/certificates/retrieve", "status": "success", "path": "en/api/go/beta/tunnels/certificates/retrieve.md", - "sha256": "7f22547fe8b7b9ee6db6f1642ac85115cdf08c4ddede7f9d5f0b4c1d9e80b3ef", - "size": 5640 + "sha256": "7b8750300ca4363a750b487c359f3fa1239ac41dbbc8cea12211be7c2db8dd42", + "size": 6333 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work/ack", "status": "success", "path": "en/api/go/beta/environments/work/ack.md", - "sha256": "1e290600da9dbb6814ace60b5173c363a515ab20b348e3c5dec2ff8824c9dc5e", - "size": 7221 + "sha256": "41a7dbfb295d9616d3c7262d088865898733626f3073f801c1e376f86d51e41f", + "size": 7914 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work/stats", "status": "success", "path": "en/api/go/beta/environments/work/stats.md", - "sha256": "3a0875c80e46d2f7ea3592fc239c081309c3b4a632f30f496b278e6cf1043b95", - "size": 5306 + "sha256": "823285e49edbcd0e48f72c525b98db328845348d7e912bde2f7052fe064e94de", + "size": 5999 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work/poll", "status": "success", "path": "en/api/go/beta/environments/work/poll.md", - "sha256": "cc960de4adab0e853b9a02b7363c9fec38a11e688d459b7dbdbfbb7e331751ac", - "size": 7684 + "sha256": "69817213c3c8e0d43f6bf4aecfd655a90116c052a34fe80f06a8a314a46db036", + "size": 8377 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work/stop", "status": "success", "path": "en/api/go/beta/environments/work/stop.md", - "sha256": "077bbee20e95a04247a0d95e309f154fdb798fe9392c27c8d497619ea957ff8f", - "size": 7388 + "sha256": "6ad70d4adfdd509d7e7c402a9bf62bcedbd6dcd0ea9fa71a166b9326421413b4", + "size": 8081 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work/update", "status": "success", "path": "en/api/go/beta/environments/work/update.md", - "sha256": "29d65dddc0439f23c210562fa53ebe00df6d02c590c6309600730c81e2c1aad0", - "size": 7455 + "sha256": "a6e077100f12fcb1aafb30a14cb8d741cf986b8f368f7171d04c95a345b9525b", + "size": 8148 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work/list", "status": "success", "path": "en/api/go/beta/environments/work/list.md", - "sha256": "67822cbecbedecf8ef524c0ed8b1b7aaca3335221c624c9ad2fa2e6e08547102", - "size": 7405 + "sha256": "07e4475aa584091f28d0e8c5a03678d5caec063fd3d2cc5ad881a4a9f2cad182", + "size": 8098 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work/heartbeat", "status": "success", "path": "en/api/go/beta/environments/work/heartbeat.md", - "sha256": "b2e90868d2dc73592e7d42120e6cf152e1bd1111d7a4a7fb9edc26860aeec74c", - "size": 6561 + "sha256": "834ee5c25c4495d1bf19f667cc56e807a819d25be716773c72f811ce306fc5ea", + "size": 7254 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/environments/work/retrieve", "status": "success", "path": "en/api/go/beta/environments/work/retrieve.md", - "sha256": "19964127c9289987a9b76a951a6b4e5a071e04935aab3ea792d0523d8ef18c99", - "size": 7158 + "sha256": "6afb82efe5072eed0d2b5129de0fd6884be354900e593a34c13b075f0613736e", + "size": 7851 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/agents/versions/list", "status": "success", "path": "en/api/go/beta/agents/versions/list.md", - "sha256": "17f22460337cc17915c0b2c1a48568d763dd0fe27d3e14f1f8d36fe3f5e44d57", - "size": 21234 + "sha256": "19323202efdeb8c2719bd8e5b018852f17278a924d474678ddb2c9facdf95566", + "size": 21927 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/events/send", "status": "success", "path": "en/api/go/beta/sessions/events/send.md", - "sha256": "bf9f86925c5d2dc58069670cee3c38e48454ac279c82b357af636a4a6f928f09", - "size": 29235 + "sha256": "c9913af9c9de18e43b69a6ea2409f624a094acf0cb131d4f3de996d3037dc545", + "size": 29928 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/events/stream", "status": "success", "path": "en/api/go/beta/sessions/events/stream.md", - "sha256": "77fe4a51170954de6ad43ac254a1d8fcdc062d45225cef41c8c10bd9e92d60c5", - "size": 73874 + "sha256": "b3f8b7ffc72aca3f7783bfcb472835f0445ee1dd37e7e32d4986034427e0422d", + "size": 74567 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/events/list", "status": "success", "path": "en/api/go/beta/sessions/events/list.md", - "sha256": "ecd12faf2ed3fdb01981857a5eb0a217327a913bb7ab0d3f4744243c14fb15d5", - "size": 71878 + "sha256": "c37651b478a2e6949b508a09c3596ec508b8f337e7078507cddc2e932076fcd1", + "size": 72571 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/resources/add", "status": "success", "path": "en/api/go/beta/sessions/resources/add.md", - "sha256": "585f79e26cce0b16af9e49fe7eb44a14dfb7a360f24b3f2a1701198770b526a3", - "size": 5313 + "sha256": "2b50b579eae8074bb89b325a3de16d50b065e3630183be8af4daa789eb848101", + "size": 6006 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/resources/update", "status": "success", "path": "en/api/go/beta/sessions/resources/update.md", - "sha256": "89bfb7242fa6e518c212c81283fba12e1dd1d0ff3c34bc86b8fbacab5e7fd934", - "size": 7830 + "sha256": "e588e026b8fcb40acf0801e74def1a23f81a3650b2ce1012420222b7e118e3b1", + "size": 8523 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/resources/list", "status": "success", "path": "en/api/go/beta/sessions/resources/list.md", - "sha256": "0d38e4f7c977a3585c2ebe5c7c58e61ca307fba65db01121e2f1e23161a1c60d", - "size": 8099 + "sha256": "14d50146b633360f8d4153cb7883f1981fffd2e5e60111f742abc3fcf9d38ca4", + "size": 8792 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/resources/delete", "status": "success", "path": "en/api/go/beta/sessions/resources/delete.md", - "sha256": "aadefb521e71b5a157090ad3b6d8a092d0893f642c0d3252f7a9b28f32b4bbc0", - "size": 4832 + "sha256": "de3fbb11213f40f1aa8b6ed644ecc887ec72f55d107b8b33f9379130650c84e3", + "size": 5525 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/resources/retrieve", "status": "success", "path": "en/api/go/beta/sessions/resources/retrieve.md", - "sha256": "e9d7302cd6f2e7ad07e50f82a68643eca5d83ef99b46f0ca1185c81717dacb0e", - "size": 7546 + "sha256": "41ee704786c4a5768d3cf2e14e3e84da988a58a060aa7de6892b66a0384258dd", + "size": 8239 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/threads/events", "status": "success", "path": "en/api/go/beta/sessions/threads/events.md", - "sha256": "818d3b3d55249889e6e7f2293d4ef17f8fc27bb1b8db1a0d7f90731cbc0e4a01", - "size": 144526 + "sha256": "474d306464fd7c7bc2b095ca17cc2326e8c5b75828aaf413fc6a65cbf03a57e9", + "size": 145912 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/threads/archive", "status": "success", "path": "en/api/go/beta/sessions/threads/archive.md", - "sha256": "c33ce718adf6b57033bc21e33a14661e55b7debfee13bfda7bb94fa0c137a438", - "size": 25453 + "sha256": "441f40ce721468df18ca07b577910ea1e8c7124a13606ec1e0cd67953a842bd9", + "size": 26245 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/threads/list", "status": "success", "path": "en/api/go/beta/sessions/threads/list.md", - "sha256": "9b657b62db2a24d83f8c44ff9ccceaa3fb20b59995af0fbe345f771bdaef788a", - "size": 25911 + "sha256": "784d68c29cb01e76d9a8bf1027de9317474b7dcd83fdf1270b4abcc357c4e64c", + "size": 26703 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/go/beta/sessions/threads/retrieve.md", - "sha256": "22d678366ce739ab2e9ce62d2efecbbbc9a642dbdf84206d804be94a6ed14f17", - "size": 25420 + "sha256": "aa95b01b81e88cd5664ac54f37d02929fcdd6038069e2984be297d56abc0b9d5", + "size": 26212 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/threads/events/stream", "status": "success", "path": "en/api/go/beta/sessions/threads/events/stream.md", - "sha256": "7a372cc60e7050252c202d5d42e5172dec8259668e6f670413eb2572d4f4a873", - "size": 74103 + "sha256": "4b1f0b54f16b7fa75238855880a22b84222f023339a51ed604ef34d2685c4701", + "size": 74796 }, { "url": "https://platform.claude.com/docs/en/api/go/beta/sessions/threads/events/list", "status": "success", "path": "en/api/go/beta/sessions/threads/events/list.md", - "sha256": "680739136f7272b4fa55c189907d6f03d9b86953d0a84e48a14d1c68ffa69737", - "size": 70402 + "sha256": "b55c306f4b6d8543c36d0b4371e5ec356c24fd6347955798ffb51de56c7b4d92", + "size": 71095 }, { "url": "https://platform.claude.com/docs/en/api/go/messages/batches/results", @@ -15479,8 +15990,8 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/messages", "status": "success", "path": "en/api/php/beta/messages.md", - "sha256": "71f9c93b3ff69f7e69530bbf5f85d1707c7a8bb3e1372aead6604657026613e0", - "size": 232513 + "sha256": "a1ba71b8135cbf610a09c1c3c09e0beddfdea72bd79f4da15a9d31148dd01998", + "size": 234415 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/models", @@ -15507,8 +16018,8 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/sessions", "status": "success", "path": "en/api/php/beta/sessions.md", - "sha256": "d365e9bcd9f8359f10d65254d3941d1d86b6b29364b881b791d8516ad32ee66d", - "size": 156499 + "sha256": "08ed44114fb98027aa83ce3c6dc5fc42912496690d80bccfa9325dccc3b5d4ce", + "size": 156796 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/deployment_runs", @@ -15521,29 +16032,29 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores", "status": "success", "path": "en/api/php/beta/memory_stores.md", - "sha256": "a910805c15719c031669cecb50fcaf127ada78d43f27472b5425c40c1fcf3719", - "size": 44161 + "sha256": "6d2bce85809680aad9f3cd02195411959932df5649fc4ebe296eb7f8cfbffb9d", + "size": 44276 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/tunnels", "status": "success", "path": "en/api/php/beta/tunnels.md", - "sha256": "feb995b823e8fef3bab519b50a10ffbdddccb8f0e25fb9a9f725593cb8b18b6a", + "sha256": "5bb2e28f30606dd7cf27b173a4ca86d9f370eb2b4ba6aca4c052050d1b540285", "size": 20239 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/environments", "status": "success", "path": "en/api/php/beta/environments.md", - "sha256": "452713df45dd2956aff984a46f3f832c55989022eef8e423a801cb72cb800d84", - "size": 42000 + "sha256": "928487218e1bceb60a01811c9b231b53fd81c46dcc282637ee4eb8e770267e93", + "size": 42150 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/sessions/threads", "status": "success", "path": "en/api/php/beta/sessions/threads.md", - "sha256": "1e1dfa3a3fb524c9a75e5a4196fa8391f6f5441e2876e613ea447fb02d684187", - "size": 67724 + "sha256": "d97f5eb2e53527453079435958ddd28f9e1cece41ba442ac28c4dc4e10f703b2", + "size": 68120 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/sessions/events", @@ -15752,7 +16263,7 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/tunnels/certificates", "status": "success", "path": "en/api/php/beta/tunnels/certificates.md", - "sha256": "1b268d9cbb763929198f2960e02e22411cb7d25d9e179afeb20f9913e08637ef", + "sha256": "10ddedbe1dd4ba79a28752185d11a01ef4e99405b149701398dfbe2017a31a9b", "size": 9032 }, { @@ -15794,8 +16305,8 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memories", "status": "success", "path": "en/api/php/beta/memory_stores/memories.md", - "sha256": "9ba4a141838436df9a2cdcbb4d3976a71a54131fc92d8a555152747c81ea14f6", - "size": 22526 + "sha256": "b86dd335590bce51305416ebf01d5948d2a720c533430df36101a5b14b43855d", + "size": 22496 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/create", @@ -15808,8 +16319,8 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/php/beta/memory_stores/memory_versions.md", - "sha256": "ef5a2ffb116257174b3750411f9b1c25bbf00386e35c38e498f75e760f5bd8dc", - "size": 16850 + "sha256": "066f369af88fc9092b5023d3ae5e7ebb093ab3c5c1bebc7d425f5877b0074958", + "size": 17030 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/update", @@ -16144,22 +16655,22 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memories/create", "status": "success", "path": "en/api/php/beta/memory_stores/memories/create.md", - "sha256": "8b678b3783f6f456214cd987716ef50faeefca0d133efc75e9a462305a0aca5c", - "size": 3344 + "sha256": "4f2fedcf4b92c4415b1ad9db9a1bcaa17b52d62a993fc5f05174f670a987934b", + "size": 3339 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memories/update", "status": "success", "path": "en/api/php/beta/memory_stores/memories/update.md", - "sha256": "93f1e5133db753dd0d6b0e4469dbea03ec738f0693fab6c23b04ed28dd4f0b07", - "size": 4101 + "sha256": "9d90358700887326eb5762fa21f6978ea6febaa51b4f97a174501b2ad38b17a6", + "size": 4096 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memories/list", "status": "success", "path": "en/api/php/beta/memory_stores/memories/list.md", - "sha256": "5916db2b5c0eb8330a6198d9a1d15af573bd4caf77cc0498b19a7241292d0e68", - "size": 4370 + "sha256": "29264350501534231936bd159e6ef07f209ff7210f2b50d2e8bfe49de26a285b", + "size": 4365 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memories/delete", @@ -16172,29 +16683,29 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/php/beta/memory_stores/memories/retrieve.md", - "sha256": "6189aab788400ab0b0071c7e564b4ff9e4cb968a65c85b845221b260914849bb", - "size": 2895 + "sha256": "fa596c284341810ca97709d539e46bcc9bde2f3fa194db28b4a7d98703f8770b", + "size": 2890 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/php/beta/memory_stores/memory_versions/redact.md", - "sha256": "fe2bebcba1cf9fcd779bdc0ed8d87de01627eabde90fe36ab79b5b4a62fb7e14", - "size": 3721 + "sha256": "9eacd6b02e116e9cd0414f46d2f54dfc2cf5b5dc79a1e851beb4783274355b6a", + "size": 3766 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/php/beta/memory_stores/memory_versions/list.md", - "sha256": "883ba99cec4158f1c1d95de4f8e28e3ac43f0e69b0757e745ac905f35bf591ca", - "size": 5043 + "sha256": "088134c239823d5b2817668f56417c37956a5e25251b1cb738e86b65374a46b6", + "size": 5088 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/php/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "918fff99330e25d698d18bf409740322c258df07d231e490730cbf309ca18f35", - "size": 3864 + "sha256": "ef1394db6c6d2daa47f8f05cc32a647d110f3e2ba11c1a336e06d2b371eb668e", + "size": 3909 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/messages/batches/results", @@ -16242,7 +16753,7 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/tunnels/certificates/create", "status": "success", "path": "en/api/php/beta/tunnels/certificates/create.md", - "sha256": "20fd1f2bf0fe9e353221a7d2f4aa7d09054fce9fff9f62a797d998d567685659", + "sha256": "6bdfe1e953b9568bc93364bc3a9a374d7cba29ed52c2de2ecf1e9a997172ad19", "size": 2153 }, { @@ -16396,22 +16907,22 @@ "url": "https://platform.claude.com/docs/en/api/php/beta/sessions/threads/archive", "status": "success", "path": "en/api/php/beta/sessions/threads/archive.md", - "sha256": "ce17946ae56a214afa3740baa6128cbc2ee1f7bc9e624f250df37ed42131f75e", - "size": 3632 + "sha256": "a07512edf3a31e14d4a4385d418a9a23530502d5a30a401d0d7c447b0b09ee95", + "size": 3731 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/sessions/threads/list", "status": "success", "path": "en/api/php/beta/sessions/threads/list.md", - "sha256": "f471712fbccb63d7b7b3b8becae26d90a5c4225b15a7720d439579f690b66c76", - "size": 4117 + "sha256": "6ce04ea7fd3333df05301fa5cc2627bbbc67235808ba3cdf76280a2b937d0381", + "size": 4216 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/php/beta/sessions/threads/retrieve.md", - "sha256": "d36fbf81e1a71d974be75f3c1d0fa7af6099169322dd5be0d1e236ad38d2c98d", - "size": 3617 + "sha256": "6884c81eba021118cb150ebff87e1a669d8e4b2dc443a9671b072fbb7ac01c0b", + "size": 3716 }, { "url": "https://platform.claude.com/docs/en/api/php/beta/sessions/threads/events/stream", @@ -16473,15 +16984,15 @@ "url": "https://platform.claude.com/docs/en/api/typescript/models/list", "status": "success", "path": "en/api/typescript/models/list.md", - "sha256": "2e49f152bbbfa7180092052bc5518f8a6326f9263da2a1f9ea5b026fa131db08", - "size": 7486 + "sha256": "d0b9d39a545e12255c80a1c08279daff9bddb831c98f1c844768ff92dd70ff83", + "size": 7763 }, { "url": "https://platform.claude.com/docs/en/api/typescript/models/retrieve", "status": "success", "path": "en/api/typescript/models/retrieve.md", - "sha256": "8e3daa2fbe3f2614345c02f4ea279553dc249e0563627539e814d573b315a3d8", - "size": 6617 + "sha256": "d12c6d2a9390da49abb5244954cc7525bf7d519c4e51048665221237d8214c36", + "size": 6894 }, { "url": "https://platform.claude.com/docs/en/api/typescript/messages/create", @@ -16508,22 +17019,22 @@ "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults", "status": "success", "path": "en/api/typescript/beta/vaults.md", - "sha256": "266b5a40fc477320ceec464f437be0ddff032b55def883a8698e890ac4ec226d", - "size": 71658 + "sha256": "75f0d3d1d792fc4069aeeb8ae4940d5d43e6299fcf974615652e6690f6ac992f", + "size": 75259 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/user_profiles", "status": "success", "path": "en/api/typescript/beta/user_profiles.md", - "sha256": "729f95c4bb9ae0c70979f0fe26c62b04872098696062e47a043f58b9d805894f", - "size": 26690 + "sha256": "6acec99e0d8d5333848ff3e730b9edc5e56d55f3f4bcb127cf88f2ba6db6721f", + "size": 28075 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments", "status": "success", "path": "en/api/typescript/beta/deployments.md", - "sha256": "52c28d238cc0164ddcd54a680e3756bb9e8e67e59fd54759e764c4d6b23f8c48", - "size": 204930 + "sha256": "d36bf9521cf7a0cbe88add23ed3e02c282c414291ac231f9c5aeefd02cdbcaa3", + "size": 207146 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/webhooks", @@ -16536,316 +17047,316 @@ "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills", "status": "success", "path": "en/api/typescript/beta/skills.md", - "sha256": "1127d943a1c2d200466a6843becc785ad894c579c60194d4a9eac6bd53ccf182", - "size": 33995 + "sha256": "53a919bc84afe896dd52a9cf8a942331867c067d113ebff3fd7ac560a17bc42a", + "size": 36488 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages", "status": "success", "path": "en/api/typescript/beta/messages.md", - "sha256": "d762ae42cd00bd3aa12d7896ce34f93ead269a5dd4a5e39cc7555d9108ff95c1", - "size": 1264494 + "sha256": "56ccc7799bf3ab3c4619d58ae4e9104103c9f3917d55bafea688ed7928c90c63", + "size": 1277725 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/models", "status": "success", "path": "en/api/typescript/beta/models.md", - "sha256": "5622b3c5feb1d677270f41669384fa08c8a665f5cd74fe1840d7a0f5ab9d6ec1", - "size": 23232 + "sha256": "9357d55835128006cc7761394241575a5bbf55af21335612d7404d554fc9aaa1", + "size": 23786 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/agents", "status": "success", "path": "en/api/typescript/beta/agents.md", - "sha256": "c73c03a93df5e64eaf92e480238c0a93a229bf87e4d9d6c3e0b765c361c4e6ab", - "size": 238026 + "sha256": "ff0df1b3ff53d85356b1b5ccc3b361f5b065ed9f18277f995d4982537aad6a24", + "size": 239688 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/files", "status": "success", "path": "en/api/typescript/beta/files.md", - "sha256": "5de15f33230c932cf0c77151dbee8e254bd23a3d30e315d2948ff9838f9d35f4", - "size": 17142 + "sha256": "0963900f02df8b9f0dfc7bdaa609e68d67f973d53b04bb4c1e6d6943913055db", + "size": 18527 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions", "status": "success", "path": "en/api/typescript/beta/sessions.md", - "sha256": "34546fa4f0438ca7911b83943d6b5e44fbd9e36bae012b18e64fb38285c5dc70", - "size": 695074 + "sha256": "ccdb1b272fdf2d6d4c9efd15bdfe0bd3c6bea98bbc89790e8d3822aff5a8cc6c", + "size": 700634 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployment_runs", "status": "success", "path": "en/api/typescript/beta/deployment_runs.md", - "sha256": "c0aae1a7538764ecc6b74588490ae2daad0e0d3f80ed0ce79d36ca92f8711534", - "size": 28988 + "sha256": "91c16bf5967a26bc3bcadf18420047cd9214e10e9e5a6169f8d15b2a9a014cfd", + "size": 29542 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores", "status": "success", "path": "en/api/typescript/beta/memory_stores.md", - "sha256": "d70c64a612c78e928b4a8829a7b5ea0f6840bfdf8843862e62ea91884db6a231", - "size": 75776 + "sha256": "ed664fa97d3510e5bd968ba11da8f2907c321739a593c949116c27eb6d11d311", + "size": 80268 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels", "status": "success", "path": "en/api/typescript/beta/tunnels.md", - "sha256": "a19c37bf597f6d731cfd0327b6fc992fa9dbcb91cece4beee2fc82a005e41a33", - "size": 36429 + "sha256": "03fab858a6b7b1b2395bc6791f151f81bccbd4056836280dedcef5b89b06e50e", + "size": 39199 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments", "status": "success", "path": "en/api/typescript/beta/environments.md", - "sha256": "9c5380f5a94a2c6b83c827e45956d99691d52834b542d49a142a6c47c05575e5", - "size": 85896 + "sha256": "69dadb85e1bba1e4abdb5abe2f3236f10b0523dfb24fdaf7324e1f3f80f2c4be", + "size": 90380 }, { "url": "https://platform.claude.com/docs/en/api/typescript/completions/create", "status": "success", "path": "en/api/typescript/completions/create.md", - "sha256": "995ba8b86e75b8604cdbb62a449bcb67edd8b01872e2c13bf0ff735fffc7fc37", - "size": 11332 + "sha256": "e65d1e7627dc77c246fa2f5302f2352205f83f7fd5d6d917cf46d20c3451d325", + "size": 11623 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/threads", "status": "success", "path": "en/api/typescript/beta/sessions/threads.md", - "sha256": "98ce892a966d6aca2814794958a57fad450b9d09a7e39b02557347354f2ff645", - "size": 277905 + "sha256": "c7fec71357a0e97db48ba1e78a7f6db8b7ba57c09f4e3e7cc09581ba6fa797de", + "size": 279686 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/events", "status": "success", "path": "en/api/typescript/beta/sessions/events.md", - "sha256": "9c9256e267764bfbe037796e1f164da73198cd05145554163e50ae004ee30604", - "size": 394065 + "sha256": "9db1433379c262168db1be66e16f76e2069b9b324f77bd7d55071e049721af78", + "size": 394896 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/resources", "status": "success", "path": "en/api/typescript/beta/sessions/resources.md", - "sha256": "ea659f561db099664e794a77375b7b6aaace7e3b5460f3876adc48534ab078d4", - "size": 31880 + "sha256": "99f833fe773b09ccec25b63ef20b4a7da0d219c824e7700f033b28b5ac931b81", + "size": 33265 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/create", "status": "success", "path": "en/api/typescript/beta/sessions/create.md", - "sha256": "91644bcac20eea1c133ae788d6acc7f00ca77832577b3e083f25a1aedfd3ff55", - "size": 58622 + "sha256": "8f0b04c2036d87175247a128bd12e82396e72dd05e6ce5a026e38ebabea852bf", + "size": 58899 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/update", "status": "success", "path": "en/api/typescript/beta/sessions/update.md", - "sha256": "d8c827e0293474252012078ad2a3f634fa6e9f120f338e2a941d03f36983af6f", - "size": 44344 + "sha256": "b30dcfd1ae4e9daeb220b34d0712053102e78437cec3bf18f09326caa4c59c58", + "size": 44621 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/archive", "status": "success", "path": "en/api/typescript/beta/sessions/archive.md", - "sha256": "8cf428c3dcd10f1e6e5ebc5f231daf9e0dd71a04c03e89d7382f8170f43ddf81", - "size": 29542 + "sha256": "7ab9cd5b2fb03fb616ef680775a54c51b45bf9f0c7d28db43f08d2bec33a4f03", + "size": 29819 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/list", "status": "success", "path": "en/api/typescript/beta/sessions/list.md", - "sha256": "0b2277702b7ba107d581268db67cbc327dd51e30646f1c66663c9fed7f8cb077", - "size": 32117 + "sha256": "5a97fa926d451da606375b1d860c7f018a598f372869d1293d8ee54daa23f969", + "size": 32394 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/delete", "status": "success", "path": "en/api/typescript/beta/sessions/delete.md", - "sha256": "e82dbd4721f0e6719660ccad0a47e8d9682bcd762f28fe8b1f6d6a3627a49d7d", - "size": 2437 + "sha256": "9f4ce0c2ba4b80e2bce8a8339f5eeff70d888e5f9f06686b15f187b53920363b", + "size": 2714 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/retrieve", "status": "success", "path": "en/api/typescript/beta/sessions/retrieve.md", - "sha256": "7e84b4919f762b40a02f6cf61e07b2fdab399509e223f6b34e54d254ee3a5621", - "size": 29528 + "sha256": "c0eb7d24478331df26b1699d3d4ac43d32d7276c0ced483715005568b73db951", + "size": 29805 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/agents/create", "status": "success", "path": "en/api/typescript/beta/agents/create.md", - "sha256": "ea58e74e36c8d8703ba80f9b0a1eefb9503c221882825109252a9b098681d3dd", - "size": 36979 + "sha256": "5a37fb89b341b54b07cd270b783f20c3100ecce9cc4c270b53f225d9f35ff5a1", + "size": 37256 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/agents/versions", "status": "success", "path": "en/api/typescript/beta/agents/versions.md", - "sha256": "6ff37bcfa2b821acdf38a81879e3936f6e7879f92d0ca84b91347e8f311f00a9", - "size": 17428 + "sha256": "c806503882f27b7819fb81b6a11af092ae53c049c1a0beca7bf54ab01696c328", + "size": 17705 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/agents/update", "status": "success", "path": "en/api/typescript/beta/agents/update.md", - "sha256": "9b5689943aca78e1aa2dc2b9461e31d563bb3382df6216f3f6b73f603b7b0281", - "size": 37821 + "sha256": "7f72bba78bd1c69ec62322ecaff4bed445ea627df78b4ed4d848f3941ed3214a", + "size": 38098 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/agents/archive", "status": "success", "path": "en/api/typescript/beta/agents/archive.md", - "sha256": "1d7089fbf412faa319ba708d2394eb5eb9fb2116bcb04149def4ce45d91f343c", - "size": 16793 + "sha256": "8ab6eb98af8b0a3cea0916e79bf0812a93948a2b1a02f36194b073dcd4ead8b4", + "size": 17070 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/agents/list", "status": "success", "path": "en/api/typescript/beta/agents/list.md", - "sha256": "83526f136be565beb424e7fe6b8efbd918074b9fb81efcee364f551a48b25a58", - "size": 17686 + "sha256": "49aa11d92286341b457b7ab0e3b78f73a100f9ab8474a84b2e3631ea85aa9e2a", + "size": 17963 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/agents/retrieve", "status": "success", "path": "en/api/typescript/beta/agents/retrieve.md", - "sha256": "651145e81a886e4c85f3b7bbe58c825be39f76e9a2cb06bb014d43b7e9f3d3a6", - "size": 16936 + "sha256": "6988b5ba8c12424f0508e27dbefcf967fc7a65506dab6ddb8ad72bd7331978bd", + "size": 17213 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work", "status": "success", "path": "en/api/typescript/beta/environments/work.md", - "sha256": "5dbd81c18f590abaed891c0503544bac1f67be38583dfd1015e77ae318f8f0b1", - "size": 42707 + "sha256": "aed93098baae77bbc60109df969effb8ea64b8576ea1e1319d0a85784d1c346b", + "size": 44923 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/create", "status": "success", "path": "en/api/typescript/beta/environments/create.md", - "sha256": "162eb550102501ab9df36e1b8ee09e49876a0badfcd6cc68a5a04bddf7db5524", - "size": 9102 + "sha256": "f25992f53cd4829b2cee09de1b031d7385a18cdaa874b459eeda5b99246f8ef3", + "size": 9533 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/update", "status": "success", "path": "en/api/typescript/beta/environments/update.md", - "sha256": "51045adc25c4c7c1d1effe9ea8fbed8c1d3b5d68f8fe2fbdea1600e2c71d67dd", - "size": 9202 + "sha256": "a1018804fcb7533e2b27f01cefe0858168953021d5613b14f1315ee7eceaf9ba", + "size": 9633 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/archive", "status": "success", "path": "en/api/typescript/beta/environments/archive.md", - "sha256": "a37978da9e192ca64dbd5ccf2bf40c00656907b19bcb420b28f8c56c02902e83", - "size": 5971 + "sha256": "a434d35832000c5af4b57f249798260d41da94ba97cafb5963d50608a8f8879a", + "size": 6248 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/list", "status": "success", "path": "en/api/typescript/beta/environments/list.md", - "sha256": "359be30f516478ebd45b500f073181c16545b6a4f50e1abff6e208e49570fd74", - "size": 6510 + "sha256": "fd2fa3da28b80a30a595435bfc86828054c6d05d44735dfc0f575e354d33b89d", + "size": 6787 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/delete", "status": "success", "path": "en/api/typescript/beta/environments/delete.md", - "sha256": "551972326f76736d031cf9704be78dfcfea2d2e9d69eaad8ff7aa33730425dbb", - "size": 2589 + "sha256": "4132ce6a8501fe96d2725481fb070235eecde7d51454c279cc19b0d9eabeefa6", + "size": 2866 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/retrieve", "status": "success", "path": "en/api/typescript/beta/environments/retrieve.md", - "sha256": "511ebad5f228a3633f1c87116158600957ae6e19314cb491f982630b16f14557", - "size": 5913 + "sha256": "564e982aaca28897eeb43852a6cd2c50dcc05f9a993f34bccf060a0dce53cf38", + "size": 6190 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/models/list", "status": "success", "path": "en/api/typescript/beta/models/list.md", - "sha256": "1f87a6b0c60a7638082cee72158c3489eec5c39c67d7e2ef267868cf1ee3d41a", - "size": 7879 + "sha256": "9e01e0f6b5c18660d39e3d194b90b8c413ad877b044d6bc1d3388024de58c0f9", + "size": 8156 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/models/retrieve", "status": "success", "path": "en/api/typescript/beta/models/retrieve.md", - "sha256": "11ac80ab3d18735c1ccaa817cb78bc01ee3b23ac745101c498a2a2fe80d230dc", - "size": 6998 + "sha256": "9475ccf5efaa70ab9dc4ef54e2352669c6941caabd0081c46e19a308b108512c", + "size": 7275 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/reveal_token", "status": "success", "path": "en/api/typescript/beta/tunnels/reveal_token.md", - "sha256": "1fe452bba62ea673edba0ba1b1518dc683c9323501dc3e75c2626b6c25cb8b06", - "size": 3028 + "sha256": "622f4a714d1329a15a5169427b15fcaa0ae3f826864feb77c00381643b3290ce", + "size": 3305 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/create", "status": "success", "path": "en/api/typescript/beta/tunnels/create.md", - "sha256": "da1af6cf9431a646fd1acd6763bb5d96d57b1e23d23d636d74c2cbec409ebe66", - "size": 3496 + "sha256": "0d6d417d447e6e2954deeb29786a51a85ade6c20f6a09363ef7489a3df54cac3", + "size": 3773 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/rotate_token", "status": "success", "path": "en/api/typescript/beta/tunnels/rotate_token.md", - "sha256": "c15b5666333a230a2e63e49fccd21efc78ce413855dc6e69e0005fdaafc12c5c", - "size": 3153 + "sha256": "b66b04df148c132dbd8f06de0e900a5885dbfca39ee3c73a7557a2ff492b8948", + "size": 3430 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/archive", "status": "success", "path": "en/api/typescript/beta/tunnels/archive.md", - "sha256": "b1d4452ef45d726e8171998e257a1110ee2c16787cfc660826d88794701f1123", - "size": 3510 + "sha256": "7189b142d9a2dcd80d50fd62fd4fe1439a238a17b49f9fa5e33d6146dcf21f55", + "size": 3787 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/list", "status": "success", "path": "en/api/typescript/beta/tunnels/list.md", - "sha256": "4145b13b58bf55b6efbe2faaa26eafafaf8f5047304c999b348c2f5bb392a4d5", - "size": 3798 + "sha256": "ce4794ed73ece7c2baec08d2b23c6923d7ce428847c4a0d9a874a5d0756e9df4", + "size": 4075 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/retrieve", "status": "success", "path": "en/api/typescript/beta/tunnels/retrieve.md", - "sha256": "92f7d3242c9d3aaf5cbce567df03cfe220cdc407efc752bc42f628f7f15285de", - "size": 3231 + "sha256": "5364c8ac10e31e869ad88ad9a84c6c7ede264ed7cb9b23c591af149d59958d78", + "size": 3508 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/certificates", "status": "success", "path": "en/api/typescript/beta/tunnels/certificates.md", - "sha256": "252b086a48d5a7f401b5a1221202c33ed93394a572c94fe372f0b8dc468aa926", - "size": 15832 + "sha256": "2c63193c018aedde13fde542182552371f7decfa813f91bc3bab74832b401e5c", + "size": 16940 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/create", "status": "success", "path": "en/api/typescript/beta/messages/create.md", - "sha256": "6210f11d05355654115daea3ba22ef64a54179b16b2ad012c61879a9be62113c", - "size": 186722 + "sha256": "542c376394c63cfd3c24b6b45b8a82981a89ab54589cb9dd58b3e5c6f32cc5e5", + "size": 189003 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/count_tokens", "status": "success", "path": "en/api/typescript/beta/messages/count_tokens.md", - "sha256": "7b3f7a433d3f839b9c08c2a4f42f099f3166fb7ef743922fe5eac9f7ff39eb38", - "size": 116702 + "sha256": "ca5d9b312062f73fcbfb371697a380dedae813ae965ce46718b4f57ad325f723", + "size": 117049 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/batches", "status": "success", "path": "en/api/typescript/beta/messages/batches.md", - "sha256": "4a5d402377e12651c88b0d4691b8ab67d38e5dc6e83910f939e45186fba33070", - "size": 377900 + "sha256": "d6be470bde9a8db6d80771f3eba6c743aa74bee2e461a2307f5b6e2ea91de732", + "size": 383478 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/webhooks/unwrap", @@ -16858,645 +17369,652 @@ "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployment_runs/list", "status": "success", "path": "en/api/typescript/beta/deployment_runs/list.md", - "sha256": "297c3d862a9e06f6bb55141df4998dec0e407f5fb8f0f575280756eb894b1a45", - "size": 9579 + "sha256": "f30f1b39616c592596c10399b700aae51ff2c5809d9964d303a99251719c6c5e", + "size": 9856 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployment_runs/retrieve", "status": "success", "path": "en/api/typescript/beta/deployment_runs/retrieve.md", - "sha256": "1ecadbcb5dc175a318d48a8552faa992e3390741e17ed5b20de97924324d7fca", - "size": 8163 + "sha256": "fe12630a38926c464f034ad3f85d3754992fe18c5ff687e810dfea4203463bed", + "size": 8440 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memories", "status": "success", "path": "en/api/typescript/beta/memory_stores/memories.md", - "sha256": "f8d21f049722e4a90cfccb3db4b8fa6279fc64fcb28bbc9489c2754f441f0d24", - "size": 37694 + "sha256": "a01105de3a17bfc2ce9cc003c0cafe0dfa18993af8aec3373c9abad6828069f6", + "size": 39321 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/create", "status": "success", "path": "en/api/typescript/beta/memory_stores/create.md", - "sha256": "37b972f3e00fae43bd1a4e9cc6aaf508c6dd1aa609dfd8696664425e9e60837b", - "size": 4627 + "sha256": "e9da3e770243c2417ae405d0cc501995d4efe2b352c06f116a5908949b677ca2", + "size": 4904 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/typescript/beta/memory_stores/memory_versions.md", - "sha256": "4b48289f896a73e5b1328e303389b5830eeca5c2d9aba629d3bab8745e787cd4", - "size": 30790 + "sha256": "eb2fcc3398b725d4851c6df5372157120cbf3ceaedc7c20edbdcb328e7915c08", + "size": 32285 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/update", "status": "success", "path": "en/api/typescript/beta/memory_stores/update.md", - "sha256": "04214b988b8f6f59cde2894ea3754ce471f60657ba3089ab97db9f8995117b57", - "size": 4557 + "sha256": "bc36b5bf30d743028c7b0741ac12105cedca458ac0bf1dba527a6e89979e1714", + "size": 4834 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/archive", "status": "success", "path": "en/api/typescript/beta/memory_stores/archive.md", - "sha256": "9e9c543fd23486fa11fbbb5e7da37551711d125f77385480ccb24edb7f868a98", - "size": 3872 + "sha256": "54b3ecdc8a5e43889850524fdaaf4f3e341fb24403130ad101df5977423d3585", + "size": 4149 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/list", "status": "success", "path": "en/api/typescript/beta/memory_stores/list.md", - "sha256": "d1d6858228f6ebbfcf7e3ecfbb724ac2f1a7909712ec8d1a45faef822d441ce8", - "size": 4839 + "sha256": "dbece220a94828789afc08ea7e7744335e5e7e1684bc39f1bb7d04fcbd861578", + "size": 5116 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/delete", "status": "success", "path": "en/api/typescript/beta/memory_stores/delete.md", - "sha256": "83cf968f9a318e58c97686b911a633d7d3202c75f21fc3af8853669ad1bf3336", - "size": 2592 + "sha256": "e52d7225a7d7f5be7b2e8bbd037bee02737575c52002103ea0b207eec2e8074d", + "size": 2869 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/retrieve", "status": "success", "path": "en/api/typescript/beta/memory_stores/retrieve.md", - "sha256": "1c54d8253b041655df7f291befa729a954bed04a6fca585197b52037d208a4d9", - "size": 3872 + "sha256": "f93e189dd5a05c557f34fdcb0df839cbdb8f162b8ac57f678f97b513b666c0a0", + "size": 4149 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/user_profiles/create_enrollment_url", "status": "success", "path": "en/api/typescript/beta/user_profiles/create_enrollment_url.md", - "sha256": "e325deabcd56d559445069c2d0bade32def88bc694b5897fb2bf6c0fd46cb8bd", - "size": 2750 + "sha256": "4d54c572d99e050e8ec2926074578846e96dc8e51b0e241c4b3954f11fa255ab", + "size": 3027 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/user_profiles/create", "status": "success", "path": "en/api/typescript/beta/user_profiles/create.md", - "sha256": "f3b0327d824ca61eed64bf90cddadf36302c333c8b308826d8bbee9c261e73e8", - "size": 5964 + "sha256": "5faf9d2228db0ee11df6d5c07eafb4a3bfdeca6f2e2d1ec04b4228be4160a512", + "size": 6241 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/user_profiles/update", "status": "success", "path": "en/api/typescript/beta/user_profiles/update.md", - "sha256": "1f3bde5d0e8e3ab95db0eeed82c1bcffdab6e87249ac1c679c62dd2dfd455612", - "size": 6015 + "sha256": "15e334dba409e9c4db58d179b04517255c4df14c8ced5a93b05dea1219f9d731", + "size": 6292 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/user_profiles/list", "status": "success", "path": "en/api/typescript/beta/user_profiles/list.md", - "sha256": "30f002f8c81573ca5998ae15683d0cfacbe808e1e308a47cd7040e933a70b5e8", - "size": 4885 + "sha256": "ed9b6d77d5ffe7befd6b967d932e4f9a7487b5035e4bc3d3a42f6cf208a679ca", + "size": 5162 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/user_profiles/retrieve", "status": "success", "path": "en/api/typescript/beta/user_profiles/retrieve.md", - "sha256": "183c0b1db78e5d4a61e6e9e6555e10f98c9d2545adb54f03324798b05916f83d", - "size": 4515 + "sha256": "43919c71f102777e7439d2e228999875807261795c3c36713384cc81d2c78a2b", + "size": 4792 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/create", "status": "success", "path": "en/api/typescript/beta/vaults/create.md", - "sha256": "e560d3a757bc399f04af1acb8df4bb919af091b43731cc4df64442e464e41c42", - "size": 3302 + "sha256": "6525aff3f4e273155d83c901c8a5386349dd0ea8d814b94d8163633a8bf97751", + "size": 3579 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/update", "status": "success", "path": "en/api/typescript/beta/vaults/update.md", - "sha256": "84f5fa5a73e33ac27fb25906ced859beb6829401061169efb49f953c1fd8920f", - "size": 3357 + "sha256": "74ba61158258063070df60a6e90ec6b0cfe0904d96586cdb3c325fab482c3c46", + "size": 3634 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/credentials", "status": "success", "path": "en/api/typescript/beta/vaults/credentials.md", - "sha256": "74bd9e17ba44f9157b77cde306248100627461e07206ecabcc185c65f02e136f", - "size": 81132 + "sha256": "92e588eafc01050ada8b76c6340fe1b1cd3fd2f80f8a13506e33fcda63a713ba", + "size": 83071 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/archive", "status": "success", "path": "en/api/typescript/beta/vaults/archive.md", - "sha256": "535fbf98d7346dd9dae6f112c4294e2a2f63785f5a29fdb95f299ffbd0ff4db0", - "size": 3036 + "sha256": "43a3c84e16d4f36921365982d952972188c5b0c760b004f02b3785c6e0426dde", + "size": 3313 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/list", "status": "success", "path": "en/api/typescript/beta/vaults/list.md", - "sha256": "d71072d577d02046f47a27b2a8800dcc68c8c5a8ae6ff03a0fe5612cd417bb8e", - "size": 3478 + "sha256": "74c51f2e804dfba94c58c28a2c879858cec100dcf4924c5a729e06b835e8ddcc", + "size": 3755 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/delete", "status": "success", "path": "en/api/typescript/beta/vaults/delete.md", - "sha256": "10b2aea678447041f7f266f1adc6c856167b2df9081ba4569f2c58a7085a35e4", - "size": 2423 + "sha256": "f1ede8b98cc5ed3733b21bb6260bb88246b3d259282ed7650ff1653c2cb21c04", + "size": 2700 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/retrieve", "status": "success", "path": "en/api/typescript/beta/vaults/retrieve.md", - "sha256": "e1b9d5021ab55ec65386c62abcf730869495299b54787cb671763f0fed7079f5", - "size": 3022 + "sha256": "dbb8a1d0b07eb9474f9085770229847ae46b8999c709eb862cf1143f9f192fed", + "size": 3299 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/files/retrieve_metadata", "status": "success", "path": "en/api/typescript/beta/files/retrieve_metadata.md", - "sha256": "a7b596fbb70fab218cb71a6a317ef1ed58e77e3f31e72589facac6aa33b1ee0f", - "size": 3417 + "sha256": "9516d1fc67849ce2dfeb5ae2632fa600ddeb52e173db7ee622f85ab1486e5034", + "size": 3694 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/files/list", "status": "success", "path": "en/api/typescript/beta/files/list.md", - "sha256": "8f3d67b9076ece0e72884efe32ac5648a9ec22e155962d9b357ec337f814a243", - "size": 4201 + "sha256": "80dfcbae8bdc4485b4e7f5e60b3ffb30bdd7fa48172ed3801f0583ead9f8dfc5", + "size": 4478 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/files/delete", "status": "success", "path": "en/api/typescript/beta/files/delete.md", - "sha256": "c690fb83a46f7b25bac2296f2407b4c0206fa3207d390f20c3982bca10b2e4cc", - "size": 2410 + "sha256": "3adeb15de333903f86fa0c285e3e32022f9a10d7d7955334bb2bbd16b90fdd85", + "size": 2687 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/files/upload", "status": "success", "path": "en/api/typescript/beta/files/upload.md", - "sha256": "19880ed913ea53368428ef318642fd9957d979a7a30d9d80415ead7bb4291f4d", - "size": 3471 + "sha256": "cb7f85c0f1021d6ac9102607e86bc5005a490d501263a992d2deddfade8d0994", + "size": 3748 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/files/download", "status": "success", "path": "en/api/typescript/beta/files/download.md", - "sha256": "f64b93de501e51d522db75a20380a04ed4396d8330dd0c83523546cb3947c40b", - "size": 2186 + "sha256": "173ad4d3e67a6df0d6685e1a9a781b24405aa63173e0801b77246871aa17b05a", + "size": 2463 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/create", "status": "success", "path": "en/api/typescript/beta/skills/create.md", - "sha256": "8e916b35a0c56acd4fbe63a29fec7d267c322c6d81e3053924b0ff74f5b92d64", - "size": 3683 + "sha256": "8372eec5eb003db260ce881fb88bdaebb613b4f38e57f08835a55395ea84864c", + "size": 3960 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/versions", "status": "success", "path": "en/api/typescript/beta/skills/versions.md", - "sha256": "0f50f298fef76f05e540d897868428056d00ca1da709d1af61d6ba939decfca2", - "size": 20577 + "sha256": "7aebed48c2484ac915886b9f8a120858b81c29653ed0b5c5e0e7d90c15135ea2", + "size": 21962 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/list", "status": "success", "path": "en/api/typescript/beta/skills/list.md", - "sha256": "39157e91202e7f4694368973bf6eed4da4a15a95b056cb990c02a4eca7be6014", - "size": 4050 + "sha256": "53324cbe51999efebabbce979989d56573d7d230b4ecb666d81e69e3541f5f98", + "size": 4327 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/delete", "status": "success", "path": "en/api/typescript/beta/skills/delete.md", - "sha256": "f000c38c15cd5839f8fa76926a1ab0e00e22fa0552df58c203e3019fb150e06b", - "size": 2525 + "sha256": "b02f382ff8632db0cf6e2d39484fb2d6ca9061fef8ea8781039fdd331e66e6a3", + "size": 2802 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/retrieve", "status": "success", "path": "en/api/typescript/beta/skills/retrieve.md", - "sha256": "1971b82dff1ccdd7113797ab0282628330c64bac7a8ed3aed0dcfde1b7bc66ac", - "size": 3392 + "sha256": "e8ed391e95aa4a1f25e544f3b60b39e403a01ed41457060baeadd16898db3088", + "size": 3669 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments/pause", "status": "success", "path": "en/api/typescript/beta/deployments/pause.md", - "sha256": "f41102df6229208a297a187000afab2740f845831a979aec12d7d2cdfe0cedd7", - "size": 17491 + "sha256": "96b8aade0ed12e8e9f9b69125044fa14c57c83624b929987838e2c90d61be5e1", + "size": 17768 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments/create", "status": "success", "path": "en/api/typescript/beta/deployments/create.md", - "sha256": "678cdf1a40ac6db435b52d06c4d709d4908e0ced9b3d5c45d44b5d15b49ebaf1", - "size": 28622 + "sha256": "efd139df124935c955fb0681dad028b2e02c307611b269b206b8e99f4872e6e0", + "size": 28899 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments/update", "status": "success", "path": "en/api/typescript/beta/deployments/update.md", - "sha256": "4248ffd2151a8255f9d88a7f16a7f52d2d9cdc37cbafac4c8d74c82d10cb6a8d", - "size": 28694 + "sha256": "3f3a59ef7be9d069ed9c8d02bf8f77e5f5193dfe385bb8770cc0475efdf0e114", + "size": 28971 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments/archive", "status": "success", "path": "en/api/typescript/beta/deployments/archive.md", - "sha256": "29308c24f92a35039618f66bf0fb105fa9c73444ea8a9f6aabb629bf9b777cb7", - "size": 17503 + "sha256": "4de8d2fe76a14d45be64c8261116278938a53e612f35476427fcb25acdcd1e6f", + "size": 17780 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments/list", "status": "success", "path": "en/api/typescript/beta/deployments/list.md", - "sha256": "d3a418befdf7dda1deef7d5121b7a78fbe364dca4a028a7d51bc88862c64eb8d", - "size": 18682 + "sha256": "b872d56da8a140395b305f14050e5791c553f793e1558f87f327e33e88f7d16f", + "size": 18959 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments/retrieve", "status": "success", "path": "en/api/typescript/beta/deployments/retrieve.md", - "sha256": "3195bfbd995de79469af8af0ed3975b708c176e2f7a7382620d587246c4e890b", - "size": 17489 + "sha256": "27ae26abff8d52b0ed60af2dac65977e75a477cb0905e5fb4afc012d48e2e52a", + "size": 17766 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments/run", "status": "success", "path": "en/api/typescript/beta/deployments/run.md", - "sha256": "a6197a4c9d096b0aa5f7ded5b45c1b4cfca9793957d602b17c8699d756a0b3cf", - "size": 8142 + "sha256": "62b3e54a04f5e813ba99c5b0cceed008a40b43b3e40dbe01bc45dd439360c2b9", + "size": 8419 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/deployments/unpause", "status": "success", "path": "en/api/typescript/beta/deployments/unpause.md", - "sha256": "af2951240ed45e1fc97d1acac1fc422099ea3aa01f29a103269b1dfb1e89ae6d", - "size": 17503 + "sha256": "b4a6c335d66ad4bf023a3fd27784e5d9d44125bd8fe5544c93dc35f3fd5a24db", + "size": 17780 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/versions/create", "status": "success", "path": "en/api/typescript/beta/skills/versions/create.md", - "sha256": "80e35dfa3fe8bdd695b5c4a2ddbef95ff15a9c54317c6aba7205a21dcea63e2f", - "size": 3833 + "sha256": "6de10e74c8a7d7d2cfe7f76e7dca992de152f2dcb216e1c9998dc2f36659a8ab", + "size": 4110 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/versions/list", "status": "success", "path": "en/api/typescript/beta/skills/versions/list.md", - "sha256": "ee18d3d174ff5b04e618ce239273789ea422617d4719d91b521bc9ade60c875a", - "size": 4043 + "sha256": "cba28471880ed8fc85f47f9945a1672d2c90aaf5f7f3427bfa99820ba4f87acd", + "size": 4320 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/versions/delete", "status": "success", "path": "en/api/typescript/beta/skills/versions/delete.md", - "sha256": "d30a236395f7442f11bf80fe4c969608115bfe3b7005f2ad11d857352d6ac803", - "size": 2826 + "sha256": "7feb3ba1bb1198c1e48b1aa1a1436ae8d62410e682a50c694a459f522ca15322", + "size": 3103 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/versions/retrieve", "status": "success", "path": "en/api/typescript/beta/skills/versions/retrieve.md", - "sha256": "8f5447a8de739c3749261fd05ed92f4d464b1bdf2e9c986fe0d729f5ca2a5d89", - "size": 3783 + "sha256": "6177d7a2b07d455021b6ade5bd893f3db15358d0bca35d2a42c9d19dbfb27cff", + "size": 4060 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/skills/versions/download", "status": "success", "path": "en/api/typescript/beta/skills/versions/download.md", - "sha256": "14a2dd7bbcc8c87072b2ab7b5cff16b0ebde485939a6d745c2c17dd68585e7f4", - "size": 2561 + "sha256": "5ed4720cc816a9ddeb22cb7d48366614f62ee70047c634336de578c9fb2b57ed", + "size": 2838 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/credentials/create", "status": "success", "path": "en/api/typescript/beta/vaults/credentials/create.md", - "sha256": "6b5368d9c4472e201fa5314aa49f925b5c38ba154eb4e28d07522c8ad0e90720", - "size": 11875 + "sha256": "caf0cb481308abb0ab4ce7d0f6b57e90ff48d287d4614e2b2a8bdf9e40936df1", + "size": 12152 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/credentials/update", "status": "success", "path": "en/api/typescript/beta/vaults/credentials/update.md", - "sha256": "64b569b64479e1110c300a667710a962d365879719369ebac5385e4b9f00326e", - "size": 11028 + "sha256": "4d4a68132b6df96fd39f76812d6d1fb5041f7379d644b1351e61fd39b6810d5d", + "size": 11305 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/credentials/archive", "status": "success", "path": "en/api/typescript/beta/vaults/credentials/archive.md", - "sha256": "acbbe340231b280bd1e85d28e5a0ded24a90ba93b94e580ca42f465ec17346de", - "size": 7026 + "sha256": "f035c055d7ac7892a4241fb863cb28f1152b1d2e27956114fb3ae059e738aece", + "size": 7303 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/credentials/list", "status": "success", "path": "en/api/typescript/beta/vaults/credentials/list.md", - "sha256": "3373aa263933051309c73fce22b6c0de096518cb9379f67ef46194ca8a33c04b", - "size": 7425 + "sha256": "7fdf60a3ed460487db2f85cb57044adf88d986485fb4e1827e269bf17d41118a", + "size": 7702 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/credentials/delete", "status": "success", "path": "en/api/typescript/beta/vaults/credentials/delete.md", - "sha256": "eb4ad1eadfa285f0b8c4c2ea5cc998447285621a182d075c30d9afc03ea943b2", - "size": 2680 + "sha256": "1a57bc8fc50b20c3dca6898ca01cc3b0cfc773d562056ccef2eeec101512261f", + "size": 2957 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/credentials/retrieve", "status": "success", "path": "en/api/typescript/beta/vaults/credentials/retrieve.md", - "sha256": "a01727d1e6bfdf120f409af22153fd4755821321906952d9b41c9f284ebc5b91", - "size": 7012 + "sha256": "9267c9c247ea54b99ea188b2318f460757958104164d4d815b062f86cfa78a69", + "size": 7289 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/vaults/credentials/mcp_oauth_validate", "status": "success", "path": "en/api/typescript/beta/vaults/credentials/mcp_oauth_validate.md", - "sha256": "abf25e10e31d9b6ab13438854c134d0060023c74db458c7fe2fccd48d066dc4f", - "size": 4992 + "sha256": "173ee78b8c1478206819da601cb9903374b4d20420d984e0fadb08de24a6c4e7", + "size": 5269 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memories/create", "status": "success", "path": "en/api/typescript/beta/memory_stores/memories/create.md", - "sha256": "da5ef91ec38d4c77017aaf8eb9b0303d7df0aac4fe01db48401c8d588069648d", - "size": 5364 + "sha256": "c0504805abf6fbba265bd9e325036fc431cb7d4dfaec6f4879833016874413bb", + "size": 5636 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memories/update", "status": "success", "path": "en/api/typescript/beta/memory_stores/memories/update.md", - "sha256": "0cfe928f5e21a10cf30e0e610a53e8abe57d24ed2143402550b0084f2826a09c", - "size": 6347 + "sha256": "ff3bc2c98918405ab717e37f612947dd95ba15f95ed580a249873932cd3a4938", + "size": 6619 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memories/list", "status": "success", "path": "en/api/typescript/beta/memory_stores/memories/list.md", - "sha256": "9a4221297b1e634e0ef25e5e95aeca33ed23f655c5038945f7fd80461029f5fc", - "size": 7065 + "sha256": "15e7b77afc64b698459adb08110c4509d3d98ce159e1a2a2b0162f1114e05e7b", + "size": 7337 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memories/delete", "status": "success", "path": "en/api/typescript/beta/memory_stores/memories/delete.md", - "sha256": "ec214bae890349113d443b2f3fc0fdc91820d74dcf7d3fc859a6a5a540840abd", - "size": 2932 + "sha256": "67680ad5f3fe607ab7fd05523a375d9e3659c6117fcc6a83ebdb0e555bacdf97", + "size": 3345 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/typescript/beta/memory_stores/memories/retrieve.md", - "sha256": "1790a3895ae0549896b7ce354dd02a7f875df15a555da45cdabb35cbccb71d3a", - "size": 4903 + "sha256": "db241ccbbaf6125957a1195eb67ef34ae334c0b703f0d7f95af6de0603ac0a63", + "size": 5175 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/typescript/beta/memory_stores/memory_versions/redact.md", - "sha256": "a38ce164486246f56f655c84db3efd67fa3d23886f41476ae3393fc226eb90b2", - "size": 7225 + "sha256": "c1ab141d65c756b45ae092c7218209d60ea498d91db02cc3c2b376a08ff6d54c", + "size": 7668 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/typescript/beta/memory_stores/memory_versions/list.md", - "sha256": "49167ec9cc4eb93f17d390ebd89ac4ed80d1be89fe368478406ee0e5287a93ab", - "size": 8280 + "sha256": "2336667f37de340b2eb99ab270d58c64fda8681717c1750fbe8e51be2a7a29fe", + "size": 8723 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/typescript/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "35b683f2dae9518d70db70c5e76e07a5530361888b5b383c69e2797ef6e0ebb9", - "size": 7345 + "sha256": "e5947878c2c27a76504df253651778c878b38172e72f5256bffc75cbd104f320", + "size": 7788 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/batches/results", "status": "success", "path": "en/api/typescript/beta/messages/batches/results.md", - "sha256": "a3622348bb7d72fa813c7bc72e2394bb0809d1e19007165361a94329718adfea", - "size": 57078 + "sha256": "c938493969a8bb189400f20df835dea250996df8e1d77b0c37ff8a4689765470", + "size": 58314 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/batches/cancel", "status": "success", "path": "en/api/typescript/beta/messages/batches/cancel.md", - "sha256": "69b87e3f1dcbce895da9ab2256fcab7355127d926d516426af36b6b1c05dbbcd", - "size": 6421 + "sha256": "e43ff82ffce4e7dc8b5cf60685ce53ef7567add848c6327db8870e8838c57488", + "size": 6698 + }, + { + "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/batches/create", + "status": "success", + "path": "en/api/typescript/beta/messages/batches/create.md", + "sha256": "e2b58969a6135d840657bc5c12bc9a34d78c8df3bd33496cb78e8937631cbb3b", + "size": 138075 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/batches/list", "status": "success", "path": "en/api/typescript/beta/messages/batches/list.md", - "sha256": "1640cf86170c024e2bd317e3a8899f5872d5d567360f70325582fe6cd9d82c65", - "size": 6635 + "sha256": "9eab0cb40dad73036bc138e2c65206af7d90c96f786ca2ef84b45f3a7b0cc34c", + "size": 6912 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/batches/delete", "status": "success", "path": "en/api/typescript/beta/messages/batches/delete.md", - "sha256": "6ccff477d2abfae4121dbb87c69cdffd1ebe4b7d951ad8f8ce2ced5fde9f161e", - "size": 2861 + "sha256": "8f98aa2db0a953cbb172c7f8eb1f911a3928467d1c48fc8bac2b41026e26d007", + "size": 3138 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/batches/retrieve", "status": "success", "path": "en/api/typescript/beta/messages/batches/retrieve.md", - "sha256": "f755652b63f7453587b77db062d3eb8d90b4fbd8e9fc0e04b5d9fa38e7a514d7", - "size": 6111 + "sha256": "87abfcca312df945e4b4e9fd6fb9fb06fbcd34b1f9087f2f6bcec375f5b25cb9", + "size": 6388 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/certificates/create", "status": "success", "path": "en/api/typescript/beta/tunnels/certificates/create.md", - "sha256": "2dc46c93507a53c2ecca8c1425cc88efb53b1e8d13bea0d914cded984d899dd8", - "size": 3806 + "sha256": "94d97e631f51275406a759cbd648493681622c48bdab09c7611cf5ea12d288c8", + "size": 4083 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/certificates/archive", "status": "success", "path": "en/api/typescript/beta/tunnels/certificates/archive.md", - "sha256": "dd4901d23437d13ebebeae5d977f238f7d02d7018f2edd47d3815fb3d86137d9", - "size": 3755 + "sha256": "e824394f4f6f0566e45513172fa1b9e0592c1938bcb9a50111bc8b5223234b74", + "size": 4032 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/certificates/list", "status": "success", "path": "en/api/typescript/beta/tunnels/certificates/list.md", - "sha256": "d6ccade45c2f43ceac62863c11c2fdfe826103025370314498351cc6722058b2", - "size": 4008 + "sha256": "7babf28dcf5856c70432ec87cbab459217d1f5462cc2eb4a80f49aed07a21c06", + "size": 4285 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/tunnels/certificates/retrieve", "status": "success", "path": "en/api/typescript/beta/tunnels/certificates/retrieve.md", - "sha256": "9b0f089d8b31fa0318b50ea02d88c40168cb74bc47d669a082641d911bf54761", - "size": 3533 + "sha256": "f6d109cdab89422ff190bb9da6e37ece203cc76b13c1acff4ceed5355a61e54f", + "size": 3810 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work/ack", "status": "success", "path": "en/api/typescript/beta/environments/work/ack.md", - "sha256": "2cbbcba4bbbacff4914fa2458c3c1ff43d35f721686ec60892c2388b7330824d", - "size": 4834 + "sha256": "7c6ce330ac00a310fb7e8f461d008422f576f00a84e1c181cdf09c08798cec70", + "size": 5111 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work/stats", "status": "success", "path": "en/api/typescript/beta/environments/work/stats.md", - "sha256": "75eef3ab0f2a54336e2a7ea69752c4d1335754914975bcc3d4a2137115a6dc3f", - "size": 3187 + "sha256": "1a340021c760979a7cc8db03200c45a170f47d1bd2fa1b1b2bf7389f24651da0", + "size": 3464 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work/poll", "status": "success", "path": "en/api/typescript/beta/environments/work/poll.md", - "sha256": "dc95d2a5d4f3266686ff3fd7afef13f11787e107660921abf71c848d7cc8929e", - "size": 5032 + "sha256": "7b1176583fdb106c416cb84fa28817e711695771bd3c1dfc52dcf8dffa8877ef", + "size": 5309 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work/stop", "status": "success", "path": "en/api/typescript/beta/environments/work/stop.md", - "sha256": "6e22800bdade86c44bcd487dbbce0de70208b2dc70c569808006c8c647cddb19", - "size": 4873 + "sha256": "1995524154e88b25016eb14bdf05ec02a8755ce147a7f666b924426d57adfb23", + "size": 5150 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work/update", "status": "success", "path": "en/api/typescript/beta/environments/work/update.md", - "sha256": "1019f5f21127c235e4e40e07a2e78d8e5e9af80beef61ee896739d2c13e7db4c", - "size": 4992 + "sha256": "8309449822b83f3eb889427467f9323886fde82850fc1ee1d0114810516ffe5c", + "size": 5269 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work/list", "status": "success", "path": "en/api/typescript/beta/environments/work/list.md", - "sha256": "470163d350327175c22b026c4ebdca92c8f7f25f16e9b427ecc474966065f748", - "size": 5089 + "sha256": "b4dafac964acd39c9ba415f6f7f21c5f7939aac1d4ffa91f5463bc227ac60a7e", + "size": 5366 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work/heartbeat", "status": "success", "path": "en/api/typescript/beta/environments/work/heartbeat.md", - "sha256": "80a75b195bba2712b7a8530feb6414e6962760747df3e61d39fe6d10e24e3cdb", - "size": 3907 + "sha256": "68533491a9102c211c1d4a30952e6d6ebf97b4a0441bb1efa651c1ee93981de7", + "size": 4184 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/environments/work/retrieve", "status": "success", "path": "en/api/typescript/beta/environments/work/retrieve.md", - "sha256": "94a9d9099ec0df0a2d0d3f6addd14d2bd15f78d617509671d6f076fb32b40818", - "size": 4786 + "sha256": "d9344dc9e9ace6c472aa8a44e97582155bd2fcd122e76fd3c77f8256ff9d178c", + "size": 5063 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/agents/versions/list", "status": "success", "path": "en/api/typescript/beta/agents/versions/list.md", - "sha256": "b2778aafc040eb6a1184cf9d245292908300fa8347a79066b08e37da4f156524", - "size": 17411 + "sha256": "4467ea518fc2f1fd4730042948ab8669100879f87a8d57ad1ea6f9326cc8f8b0", + "size": 17688 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/events/send", "status": "success", "path": "en/api/typescript/beta/sessions/events/send.md", - "sha256": "bc9c4b28cd9c3523e18eb286b9c5ad0f14445174de35f7d4897234bc6bcbf222", - "size": 24840 + "sha256": "d4d4b1fa9463139c5f77d553e5a2a83ef95204c65b07fa23ae3dcd88733db568", + "size": 25117 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/events/stream", "status": "success", "path": "en/api/typescript/beta/sessions/events/stream.md", - "sha256": "f4c96adfa81f38963eb380bf9782d3f65d55faf8030dce9f3eaeebcf6a391e3b", - "size": 66934 + "sha256": "4625d7918d7e2b7bf3b7339398ea78bc69749bb80c89cfda5bc3cfbe970399df", + "size": 67211 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/events/list", "status": "success", "path": "en/api/typescript/beta/sessions/events/list.md", - "sha256": "3d262e4f71ddea210b48937f73b99c3032ad15b8ceacf9a89f0bed7dc1987a28", - "size": 64934 + "sha256": "f4cdbda73c3f435926fffd54a2e8b1ecc11453639967a147e5e11766f4b227fb", + "size": 65211 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/resources/add", "status": "success", "path": "en/api/typescript/beta/sessions/resources/add.md", - "sha256": "ebbc3230c07f4fab23a8eea3137f9f13c5a14648bfc6f567f288ba6e163519c3", - "size": 3143 + "sha256": "b350939cd5f792d690443d2c1c44218c745526b832bbcc7e8e0efa47c309d002", + "size": 3420 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/resources/update", "status": "success", "path": "en/api/typescript/beta/sessions/resources/update.md", - "sha256": "79aa3914f3a7202333a3526805ab495d2a39dc28a67ce127c8156910cd76fc94", - "size": 5331 + "sha256": "f533e2d1d27ae1ef0543d04fd8ae84b5c0152eabfa2bb61be3d59a96806a0baa", + "size": 5608 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/resources/list", "status": "success", "path": "en/api/typescript/beta/sessions/resources/list.md", - "sha256": "071675a4746eaab9bb5b4532c9270f3b3fb1eaf7d052c358675c3d0116cedf74", - "size": 5732 + "sha256": "bc60980ecc83a2d2d2a035ede4f11f7dd44923eba67f9d617b5afdf937c79196", + "size": 6009 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/resources/delete", "status": "success", "path": "en/api/typescript/beta/sessions/resources/delete.md", - "sha256": "4f801ebc6960ca0b21d84237036dc267d927702732acebb7429681155c9b5573", - "size": 2660 + "sha256": "1dc79d18da48447e7e7438ae1fe4cd9b3307ff91051afa07a2facc0f1f9f19d8", + "size": 2937 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/resources/retrieve", "status": "success", "path": "en/api/typescript/beta/sessions/resources/retrieve.md", - "sha256": "45e8c2f206da56e60630128d3a9a134cfc720e84cda66f9cbce8e4b8aad60c01", - "size": 5097 + "sha256": "12f67da6a515e3302aad3e1550fe195d2bc87dae9bf03da6e43d9b4df2183b53", + "size": 5374 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/threads/events", "status": "success", "path": "en/api/typescript/beta/sessions/threads/events.md", - "sha256": "96d95f70f875ce64a3dea9941c15c3ac9b2b54e68703279630e15a23c4051e85", - "size": 130871 + "sha256": "79ca991cb46a3cf3c5d3217bf576bd289289814655e77646ff80d252b4e0e934", + "size": 131425 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/threads/archive", "status": "success", "path": "en/api/typescript/beta/sessions/threads/archive.md", - "sha256": "6780249bb9d1ca36580cc041725255ef6404f47b24462cb90e2842768f610f00", - "size": 21129 + "sha256": "1292bc84a00ee6e23a0203cd37ffc196c5b70c2e9ca0f97fe91948d31dd92f4e", + "size": 21505 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/threads/list", "status": "success", "path": "en/api/typescript/beta/sessions/threads/list.md", - "sha256": "449971ff5e6356feb8903a2f7959ec45f774ee64d1a8f5384dda10e0dbd63801", - "size": 21675 + "sha256": "1cd73fa24b66d17e46f70d1a14acef84fc333d0ca63800d5564f2d27e89cd96a", + "size": 22051 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/typescript/beta/sessions/threads/retrieve.md", - "sha256": "b76742010fee37fbb6a006edb6a11f51a312da9547020272e94961520b0446a5", - "size": 21115 + "sha256": "56d7ba1f42ee9960fcee6f0d11aeca6cc342470a746093902e13be73800e6a4c", + "size": 21491 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/threads/events/stream", "status": "success", "path": "en/api/typescript/beta/sessions/threads/events/stream.md", - "sha256": "692d8e67ee39d41bbd8ac8ab53d97e012c0fda6d97192d410d1c64a5c0b205e6", - "size": 67160 + "sha256": "f5d78fe68f4473b201a3bf0cea5905347354a56657a3cae148e107549686f58f", + "size": 67437 }, { "url": "https://platform.claude.com/docs/en/api/typescript/beta/sessions/threads/events/list", "status": "success", "path": "en/api/typescript/beta/sessions/threads/events/list.md", - "sha256": "e31a148349ad83dfe33c3f8302164b01266a802ba9785d593b1594ec546dfdde", - "size": 63690 + "sha256": "d4f0dcecaf99beb7278e8e0bbe5213345d048e6e78a5ebd610837ef117e63c8d", + "size": 63967 }, { "url": "https://platform.claude.com/docs/en/api/typescript/messages/batches/results", @@ -17551,15 +18069,15 @@ "url": "https://platform.claude.com/docs/en/api/java/models/list", "status": "success", "path": "en/api/java/models/list.md", - "sha256": "f378d47f761b1097aa1d07365025385964991fdce65158cee5b96a1d5ed14a90", - "size": 8372 + "sha256": "6d132b06835fcbad195b0be9cd5bbdd98d31800c16b7b6f9bb132c2da7d106d5", + "size": 8828 }, { "url": "https://platform.claude.com/docs/en/api/java/models/retrieve", "status": "success", "path": "en/api/java/models/retrieve.md", - "sha256": "5414bd855f59e79c0768721abd17301c329f9c27d948a2a815ef21e5a2e9312f", - "size": 7605 + "sha256": "719ac9d77e0a2eccf5de550505d14661051fdac7f3005fc39d5d574abfa3a6fb", + "size": 8061 }, { "url": "https://platform.claude.com/docs/en/api/java/messages/create", @@ -17586,22 +18104,22 @@ "url": "https://platform.claude.com/docs/en/api/java/beta/vaults", "status": "success", "path": "en/api/java/beta/vaults.md", - "sha256": "a3c3272762cec49465455ff881bc4a315e2f92b4174409d3d3b88dbf0bcd7336", - "size": 82899 + "sha256": "126e2b36f4b335ac1eb24c0354463513e271bd5a140e42d036dbc04b2a688995", + "size": 88827 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/user_profiles", "status": "success", "path": "en/api/java/beta/user_profiles.md", - "sha256": "0c381fc48a4783b1b6ed6633bf30b6b01306177e7da86f27ccac0ff496d69651", - "size": 31662 + "sha256": "b83d690161815b454e43b88df7ab72a7bfbd4cf1b784a2f3c17f025aa3292689", + "size": 33942 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments", "status": "success", "path": "en/api/java/beta/deployments.md", - "sha256": "96dd9b10efc12e5f8a9398feb2ee0fe071bb1e4ebf69ee020f6ce198434fd398", - "size": 200743 + "sha256": "d5bfd730ffd8ea008751d0d4793f0a9acf562e85d0d6e831c4592a597c5ac3bb", + "size": 204391 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/webhooks", @@ -17614,967 +18132,967 @@ "url": "https://platform.claude.com/docs/en/api/java/beta/skills", "status": "success", "path": "en/api/java/beta/skills.md", - "sha256": "76e7e1c3d5a7ce5327a68f61711b9e2d2a8736156868263e4039d936162f5768", - "size": 40144 + "sha256": "f3708e1ee5cd66b5ee73dc7801b22ffe39f708bc8f5c45162ef0a19c3a6f5641", + "size": 44248 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages", "status": "success", "path": "en/api/java/beta/messages.md", - "sha256": "4fcb9d7e85f556cea1f4ca4bc824e35c5706ebffde8652a21823a75361f078cf", - "size": 1225657 + "sha256": "7f7a027e473de81c5143980ce713b31d36b4f44907489ea09a6965780cb067a0", + "size": 1239175 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/models", "status": "success", "path": "en/api/java/beta/models.md", - "sha256": "7abc6c8fb554f5d5401b9d6fdfb4f514c76e2d8f4d41e1120f737a146ca79ea7", - "size": 25102 + "sha256": "9d77db684633ae1bfc6741418f2059cf9e962bd6913e06264c113acac9a3eeb2", + "size": 26014 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/agents", "status": "success", "path": "en/api/java/beta/agents.md", - "sha256": "bf3f74ccb94711e8267ab53776ecd4d94a94f9df4f8041918857ea888ade49e8", - "size": 234845 + "sha256": "333e40e4faf1662bbc6c69452c5e27ea8908a080d7cd9b3ac4c6a1a63a7f44fc", + "size": 237581 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/files", "status": "success", "path": "en/api/java/beta/files.md", - "sha256": "424ee5b34b766c7d396b054993c10f3bec09f4293322b96415df0cff4d1e90b6", - "size": 22135 + "sha256": "9051b94fcf786ce0a5eaea743b0468339d7e01a7ec547a34bbccea572762f736", + "size": 24415 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions", "status": "success", "path": "en/api/java/beta/sessions.md", - "sha256": "d91c28aa2104a527e29f0f25acc765c9e2acf7841a06dc602e2d8f970fbb78d4", - "size": 676716 + "sha256": "989c1a80cefa179f45ea6d237aa8ef23d168a6419f78b8d55195dccacd27ce4a", + "size": 685677 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployment_runs", "status": "success", "path": "en/api/java/beta/deployment_runs.md", - "sha256": "b47031c7bc05d50d7d8ceceb3ab0c64e3fc6441c6cd11c28d27cfe5ba53b080c", - "size": 29280 + "sha256": "a8c63f62723e74acd7a646bccc048cb71189c464c31d51e4d333a472ae35f397", + "size": 30192 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores", "status": "success", "path": "en/api/java/beta/memory_stores.md", - "sha256": "638558ec8c1004ba365f7926c7b89def7817e6759e0e5ac56f918774b2b328d1", - "size": 89817 + "sha256": "4d2ed18a9e704970f1521bdb240e947ae99103232096d8891d94fb953685dcaa", + "size": 96815 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels", "status": "success", "path": "en/api/java/beta/tunnels.md", - "sha256": "b343016106c950d8912d90bfb53bf8c9422f4c5917953be1fd1e64dd6d806b34", - "size": 47039 + "sha256": "b3f1f9fd1304f1292a0268466c12bad51b3eb36d49785e1caa7af9f5f0ac8e77", + "size": 51599 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments", "status": "success", "path": "en/api/java/beta/environments.md", - "sha256": "2b1a078ebc0d8a4a537cf1175742f864a6ceae212953bda0cea493f901cf23c3", - "size": 100384 + "sha256": "670e626a3cff3031e7bc9153aa1d33385391a8d3b0353de9fe21000e8763adec", + "size": 107374 }, { "url": "https://platform.claude.com/docs/en/api/java/completions/create", "status": "success", "path": "en/api/java/completions/create.md", - "sha256": "37fb864722fa57b62e097b5a21125fe87e4fb73f6a3f432b270cba98965289cf", - "size": 9531 + "sha256": "c5073dc8bf8abe0eca5cefb0ba058bf57f6a6682b9993e1df63cf1958461041c", + "size": 9987 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/threads", "status": "success", "path": "en/api/java/beta/sessions/threads.md", - "sha256": "b795d2f1a649c2fe4d3847bf523cb1b32416ed539cfdb5e7be36e689bc329336", - "size": 271605 + "sha256": "54801d0f30dc633c2b24c58fdac90c571fd2ea04508eee58857c832419cfc015", + "size": 274281 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/events", "status": "success", "path": "en/api/java/beta/sessions/events.md", - "sha256": "d2f1c3278717bc5fc776a72c4bf3398520ed0b4931b97baad35efdf1679155ac", - "size": 374599 + "sha256": "0049882430d9777435c1df12d0d40dd0bc176da2b7e4bc6c5efbba1ff87c7b44", + "size": 375967 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/resources", "status": "success", "path": "en/api/java/beta/sessions/resources.md", - "sha256": "acf3c299c951d14460be925c279c9028e8d6af14321d6d6426e0623fa6d6f0c1", - "size": 31837 + "sha256": "c844af683322cb8728471d8dcead5aeb91de7bb94370cbe1c81c6bae0e6d4e3b", + "size": 34117 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/create", "status": "success", "path": "en/api/java/beta/sessions/create.md", - "sha256": "bdff618497d228ac2e7f5d31f0a6fe7cff440d18c797f8ed63f61fb9ae8a08d3", - "size": 57499 + "sha256": "f9866f2078790e207ace0e4dd426b03fa5c7c9c7b7a9b8d6561fead914b6d701", + "size": 57955 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/update", "status": "success", "path": "en/api/java/beta/sessions/update.md", - "sha256": "b3b124b2b0a43db9ea997c734a5263f2aba428988a10b9f26c4668c171e41887", - "size": 30842 + "sha256": "f9a6a0e7dfdfe8caf2ba7ea3b16f6d5b0a9e04a562dd84af92a1cac5176dc25a", + "size": 31298 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/archive", "status": "success", "path": "en/api/java/beta/sessions/archive.md", - "sha256": "9212cae740c1e653b61b20a3c05590a40a262049cb056be877b57374887c50e0", - "size": 29967 + "sha256": "0d84f67922fd79dba10e9d732a38813b64273275352d052545bb75f5802697c1", + "size": 30423 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/list", "status": "success", "path": "en/api/java/beta/sessions/list.md", - "sha256": "f1d5813ce68434e585489518c2a097e205dd0a3e7eb1fe0e30df0063b51ba00a", - "size": 32327 + "sha256": "5dda653990b4d6769ce3ebcd716decfb8ccd59d709e86304b83fc9b3a16963f7", + "size": 32783 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/delete", "status": "success", "path": "en/api/java/beta/sessions/delete.md", - "sha256": "b1f8959e6e553ef30ba22761a2e9359d7acbd6fbb20533d78f195ffe803e169b", - "size": 3474 + "sha256": "396bf326d76266ad684bfbed295d9b1529581e5100ad00171961d3ee7e2a237d", + "size": 3930 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/retrieve", "status": "success", "path": "en/api/java/beta/sessions/retrieve.md", - "sha256": "fab96ded440e5d23ad5a36cc8e578862338d33df2842ccff3655609b5bad668b", - "size": 29955 + "sha256": "e51eec86ba874f29e1103eb934a9d5dd6ae0bf9374f73861845ffbc0d60eec91", + "size": 30411 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/agents/create", "status": "success", "path": "en/api/java/beta/agents/create.md", - "sha256": "f5b519fe4b8a3a217f705a318e0ef65d1d4beb26b39c79348e724b64e7cdcdd5", - "size": 35682 + "sha256": "b421cc8869ea9d0c9c8bed0fe93f42e5ba6663fb7f7d3a7f08beb4dc03836138", + "size": 36138 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/agents/versions", "status": "success", "path": "en/api/java/beta/agents/versions.md", - "sha256": "b218019ee706f1560fc7ca93005c9dce953d7143fdaf78291a1fd74cd55dccf7", - "size": 17892 + "sha256": "3a34960c481746a9e405dd06acd9d51dbe6c3b044d153ed812af3a34d274691f", + "size": 18348 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/agents/update", "status": "success", "path": "en/api/java/beta/agents/update.md", - "sha256": "3630506fc89f418e268412cf6b59d9addacd0ece63a4e474a690e2c6e770f94c", - "size": 36302 + "sha256": "6add642b7612ba9e22bd717d4bbdfd034940ef042172c40429a5cff413ab426d", + "size": 36758 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/agents/archive", "status": "success", "path": "en/api/java/beta/agents/archive.md", - "sha256": "a69aea19c8a0dbdb315d01608e1418c3d7d96741a43dd0fd286a55304db3b67e", - "size": 17372 + "sha256": "e0dac635ca5449d03861bb31c627af04fe5dde7f7f04b41a417759a323c93a79", + "size": 17828 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/agents/list", "status": "success", "path": "en/api/java/beta/agents/list.md", - "sha256": "8e98474f20473021134c631d8feeac5153084467aa73cdad6748408a23651757", - "size": 18108 + "sha256": "7babfe8776b5a1bb5855fc5c3ad724a08b522bbba43e6f9f8da900c32bde0bb2", + "size": 18564 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/agents/retrieve", "status": "success", "path": "en/api/java/beta/agents/retrieve.md", - "sha256": "59e5e7140acec5564ab344f880fd9a8510217bd764ec9de3a744959207a5008f", - "size": 17496 + "sha256": "626eaad3ccf603c820024991af670a3849c21915137821bdfb39ab09fb667cb3", + "size": 17952 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work", "status": "success", "path": "en/api/java/beta/environments/work.md", - "sha256": "d60ce9acb449606c456c8a75b66880ef653c62886fc854ef7ef1422c8745e1ca", - "size": 51794 + "sha256": "ac53df4a4732908e928ecbdc20678d66da64194915c854b8ec182396a47c5c11", + "size": 55442 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/create", "status": "success", "path": "en/api/java/beta/environments/create.md", - "sha256": "a8c9385d852936c5e3d4956119e0538296f8175f5a7fd16418c9d1baf914c199", - "size": 10008 + "sha256": "3e0ab78fcc9bb7d8539f1b7ea2cf8e3212528231f4ca9dd53edbe511c0d1a624", + "size": 10618 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/update", "status": "success", "path": "en/api/java/beta/environments/update.md", - "sha256": "3aae1a5e03d1632d006418ef566cd6ec4c6895f9656c28cd26a15274ab98aefd", - "size": 10021 + "sha256": "f21f21a49a13d151da9c9fda88bba803b60a0dd14797e9d62fee8cbe5754cdb7", + "size": 10631 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/archive", "status": "success", "path": "en/api/java/beta/environments/archive.md", - "sha256": "239a27951dea12e804d2daca9501baafefd6753fa5d5429161e6190a1cd8da31", - "size": 6931 + "sha256": "e48f7f0e8f51217ed6a51ac69be196bf8fe7d2ef394dd18ecdd4d9577147022a", + "size": 7387 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/list", "status": "success", "path": "en/api/java/beta/environments/list.md", - "sha256": "cca8a5afc23114928eafdbb986ef7359168337d316290015af321c90a0342246", - "size": 7360 + "sha256": "ce4c748cf8e80646478a577f8bf3eb53da4b1eb29354cc62c550cbc4e0ea1ec6", + "size": 7816 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/delete", "status": "success", "path": "en/api/java/beta/environments/delete.md", - "sha256": "8879562937775164c930b3e027e431fcc5867ec23b49b975a46e20fc84d49c4a", - "size": 3598 + "sha256": "e0756238cb2d894073a1449ec6be2d7180e9d9f95d0bdc6c2bd0e1f72b33c4fd", + "size": 4054 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/retrieve", "status": "success", "path": "en/api/java/beta/environments/retrieve.md", - "sha256": "95523cb2b10c3c95099215d2e8202611a948aae45e86328371377e82b2ac7560", - "size": 6871 + "sha256": "d9b73ddc1f9e90a7fa06a1a11e80a722a9af333e9776a8b00e35b11ab59edf46", + "size": 7327 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/models/list", "status": "success", "path": "en/api/java/beta/models/list.md", - "sha256": "ced9ec2e11a008b19c709d2e359dfa29e0ea9a0872b1c35888a1867817809eb2", - "size": 8766 + "sha256": "cbcd9e48ccebcd30c3d1cb703bdcb78f095bf0e78162bf3bd9f5374b694a8c6e", + "size": 9222 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/models/retrieve", "status": "success", "path": "en/api/java/beta/models/retrieve.md", - "sha256": "3949ac50eedfea5baeaffd4f4a0bedbe2cf0ff6b726c2f7a055378eeb6594c23", - "size": 8003 + "sha256": "e4e2f0c4116bd10af77b01e1e3c1f52ae0a53468ae83568c81496fd7c4ac542d", + "size": 8459 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/reveal_token", "status": "success", "path": "en/api/java/beta/tunnels/reveal_token.md", - "sha256": "6aa61f81d998596591efe9f0d8ad5dc0db157a2d2524580dedb652d41968230d", - "size": 4075 + "sha256": "6d231cf3de1da8a7827ec9f9025f38b806332aaabfba43da21bcb7b2d8928e29", + "size": 4531 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/create", "status": "success", "path": "en/api/java/beta/tunnels/create.md", - "sha256": "066832432cf9f45edbd2eff04db169afa810cfded86a89f9deb54cfcbbc6d6b2", - "size": 4523 + "sha256": "ee7bb2fd7821ec06c721f2e5e4129ba97f9381507e1fd1766ed1ba4044fdf709", + "size": 4979 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/rotate_token", "status": "success", "path": "en/api/java/beta/tunnels/rotate_token.md", - "sha256": "f62148892668f38e16b05e58e4499ef6fdd9f514993745fa11579556a766975b", - "size": 4176 + "sha256": "50e71c60d357978090bb826d71d055463d9409a60a25d935c4bbe90d3e325fae", + "size": 4632 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/archive", "status": "success", "path": "en/api/java/beta/tunnels/archive.md", - "sha256": "c99adb5c01446399797916cd37b82feb4c5fda2a64c4857594d4a6a4f2b1bff0", - "size": 4565 + "sha256": "a0e14d4389947cdab9da8fa1c052b1e9dea7525e0c1142a576cc8916f7414f4c", + "size": 5021 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/list", "status": "success", "path": "en/api/java/beta/tunnels/list.md", - "sha256": "fdae80687024ec0674d880ff4c8c694ac07ffec8f224e6bc3403e205ad33249c", - "size": 4750 + "sha256": "a60dfb15820177604c6be7d4de0d57227149108c7ceb57e0ad67779e892560a0", + "size": 5206 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/retrieve", "status": "success", "path": "en/api/java/beta/tunnels/retrieve.md", - "sha256": "a5f3cb8622f97d6d9dd5899e6b7835e706ed37dfa8e16c4e021e9b1237628374", - "size": 4288 + "sha256": "75b0070ea152f0667cabcfb443529b57bf3fc2a7d51e8c1b1996d34f75eb9157", + "size": 4744 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/certificates", "status": "success", "path": "en/api/java/beta/tunnels/certificates.md", - "sha256": "249aeba5e1d3f0bd964fb5d6d2a6332409337ff51c1e583c8b2d0294cd0363de", - "size": 20267 + "sha256": "57c1aaeaee3d32f7f019f9a84c89af430a056d6946311f0a51251e5ec6c114a7", + "size": 22091 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/create", "status": "success", "path": "en/api/java/beta/messages/create.md", - "sha256": "1a7730e818fb7b424d27404e4f0cf283d943bfca8260caf08e64fd962fbad57b", - "size": 172975 + "sha256": "b9b136ca3dcd52bcfd3832a01afad453c2b0ce9efe52204de150ff818751d338", + "size": 175339 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/count_tokens", "status": "success", "path": "en/api/java/beta/messages/count_tokens.md", - "sha256": "674813530001c373820521ae8d5ce7bce32b7fef580ad277d7cdbe3e70c1e199", - "size": 112145 + "sha256": "0a1ece96c6e91ad86e114510cc314797b04e11db2ebd61dd90716a9f281b02ba", + "size": 112601 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/batches", "status": "success", "path": "en/api/java/beta/messages/batches.md", - "sha256": "b9f34e6527f6f55e8db6333495d80b1d668ffd575f6d7d2092770d4b2574329f", - "size": 368680 + "sha256": "f1d5368a5b664f0cb2fad384bb82c98a9ba3516ddf690d4ff40c107a13d14812", + "size": 375326 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployment_runs/list", "status": "success", "path": "en/api/java/beta/deployment_runs/list.md", - "sha256": "bdb2bb4c9286a5e05d793d5c237efbc8ae4f43f47b99b65c72441c97575d8f03", - "size": 10002 + "sha256": "e07fc8b29f3031f9ec2a8b21658c68bf03fcc05c14a3fd61c786b57df5fd4b6d", + "size": 10458 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployment_runs/retrieve", "status": "success", "path": "en/api/java/beta/deployment_runs/retrieve.md", - "sha256": "76a1fdef912f207e135fc2946ab5c2d3a65a5a9a9b2ba878aaeba6da25ff8b68", - "size": 8801 + "sha256": "66d03c81fcb95f99cc9d7666cc60947aa0f956a1eba6107c80b1414e2ab38125", + "size": 9257 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memories", "status": "success", "path": "en/api/java/beta/memory_stores/memories.md", - "sha256": "a97922bd836a6b5e1c7d5ed8c7edfe634a777ed67525fc696fff2da49194cd7f", - "size": 41723 + "sha256": "04bea0ea0f144a85294ae37e5ce3fcc9148c7742c37bb0265b8e657be696d2c4", + "size": 44245 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/create", "status": "success", "path": "en/api/java/beta/memory_stores/create.md", - "sha256": "bd961d49d6f35855ba6a21096525e9671b394d9c439096b9f857ff33205e17f4", - "size": 5734 + "sha256": "fed09282a6e03d973fcbe16667d11036f1fb51b91bea919947e3cf1590ca4688", + "size": 6190 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/java/beta/memory_stores/memory_versions.md", - "sha256": "fa3d6874b5bbc531b25ab70d46d57572181dc26b4766f17919ac20ff1008143e", - "size": 33776 + "sha256": "678eb6814005a3ea4eb00a3e84c3653fa5b589d55a6e1f5c7f1c77cbf8a3b8d6", + "size": 35808 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/update", "status": "success", "path": "en/api/java/beta/memory_stores/update.md", - "sha256": "ca404c87800fa0b9ce472890142505617cd271a58376245ea46b981dd0302d60", - "size": 5561 + "sha256": "b429164c865da208ecb03aac3b3f38cd180b5be78b358f599f8a54de843cad18", + "size": 6017 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/archive", "status": "success", "path": "en/api/java/beta/memory_stores/archive.md", - "sha256": "56f65a1619c667dc781f154cb8aa747347cb19c323690c52848d7b89d0865bb7", - "size": 4945 + "sha256": "f82dcd3d16e48cab0df0128dc95508e13430fd22af902140af310df581c23a43", + "size": 5401 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/list", "status": "success", "path": "en/api/java/beta/memory_stores/list.md", - "sha256": "f8f7c23e1ed815c97f46879981b4bd0c490ca6d88eacc09f6d89174f3dc8dbd0", - "size": 5751 + "sha256": "a4d23305923f228fb7f894fa4feaa0bdce1604f60cf5139d2aefe1d9bee7ded1", + "size": 6207 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/delete", "status": "success", "path": "en/api/java/beta/memory_stores/delete.md", - "sha256": "49c297e56a8eccec17b02a3098a30ea53bbed649602a7acc42c14abcd032637b", - "size": 3640 + "sha256": "65a6a945076d8cfeb0e8698484b392f004fc3d6f2bd445d48cd9b652d6884566", + "size": 4096 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/retrieve", "status": "success", "path": "en/api/java/beta/memory_stores/retrieve.md", - "sha256": "b9ed8f878d052f4d5b42479cb3f98f1e86d03ab666b3058592c079387bf7a2e8", - "size": 4943 + "sha256": "988ecb64638c78c54fbfd882019da0b7c3a2d5a5248f88a910672db19ce5f821", + "size": 5399 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/user_profiles/create_enrollment_url", "status": "success", "path": "en/api/java/beta/user_profiles/create_enrollment_url.md", - "sha256": "143cdeea0eb82ab0ee4e7f416ca9391b66038a930bfe5c2f5c94dbaa4f8d8c81", - "size": 3820 + "sha256": "755705f303e1857398007440edd43c46176256e280e312b615dde765ce1f927b", + "size": 4276 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/user_profiles/create", "status": "success", "path": "en/api/java/beta/user_profiles/create.md", - "sha256": "93e757d81f7df19a86891b9f04aaeb3213235c40c489729e2c9285797a00edca", - "size": 6949 + "sha256": "0d8c857f0c841f391fcc9fc7e5f222ed0d09a1c19fd0fdd396d1b1d6d1d85e37", + "size": 7405 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/user_profiles/update", "status": "success", "path": "en/api/java/beta/user_profiles/update.md", - "sha256": "9424ab64b9b6eb4b6ff15c95d921b3ab535d70ed9d011935a8646542c6732662", - "size": 6978 + "sha256": "9ca7df7cdf242698913ca8f75cdf5c211fe35460aa94c3543307edf780c04054", + "size": 7434 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/user_profiles/list", "status": "success", "path": "en/api/java/beta/user_profiles/list.md", - "sha256": "af577b48bbd4a73d982087bc8df3307300f999c81acb8ea96a5092ffa95dbd35", - "size": 5818 + "sha256": "462bc9ef19e30b32034b66e41e045bcc745b5812f1fc710a6289feeb5b259069", + "size": 6274 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/user_profiles/retrieve", "status": "success", "path": "en/api/java/beta/user_profiles/retrieve.md", - "sha256": "572c87cad2774112cb0deabfd8a61d213e2ffe73052c6229b9a8c1ab98d778de", - "size": 5546 + "sha256": "c858cc91cf661979e5f21563c47aba0073d4dbbf360852f44259ecadaa519d3d", + "size": 6002 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/create", "status": "success", "path": "en/api/java/beta/vaults/create.md", - "sha256": "82fe62cf10d464434b4e5990983b61606a09ae4bb09d6ed82b8250f5940dea78", - "size": 4363 + "sha256": "4462ce74a141dfe3c885321bb96894753851c5b71926f470fbad9d78f03e96e1", + "size": 4819 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/update", "status": "success", "path": "en/api/java/beta/vaults/update.md", - "sha256": "b1eec5eb1ba16bcde7d8d5b7bfd61d255bb8b19467e258a61b0b4665597520df", - "size": 4337 + "sha256": "ee504f95f80665b2c96f88ad022a4336ad4bf87e0e598cb00f94b9d791c701a3", + "size": 4793 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/credentials", "status": "success", "path": "en/api/java/beta/vaults/credentials.md", - "sha256": "67b4afd88b99d7f21882db8f01f6b5c450d44f4f01bc88b36d3a5dfe790cb625", - "size": 84871 + "sha256": "89c98209a9102f4a0e64bd16c298d1c224844282a9c7fe0211559a06558a9fe5", + "size": 88063 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/archive", "status": "success", "path": "en/api/java/beta/vaults/archive.md", - "sha256": "30eeb5e558f7524677d89a77c54bfa3fe10bacde4aded7cc47ae628634427658", - "size": 4071 + "sha256": "a7fd113293da46e83d9c9a1db5b18d197aad1eae5b11eb85cdf07ad4ad30cea2", + "size": 4527 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/list", "status": "success", "path": "en/api/java/beta/vaults/list.md", - "sha256": "75b26456fae16e78c78c69fa042e98a5a59bc4941b9ccd52509a8df75a1397a4", - "size": 4362 + "sha256": "c7446d2ae5e92199125e60edbc4ea14cec2c6c4a194d23eaa63411aea0cff64f", + "size": 4818 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/delete", "status": "success", "path": "en/api/java/beta/vaults/delete.md", - "sha256": "8fd3a0fb6572c4ca4eea27331c6ad935aa699d22dd91a12c10bc2a7da4016e90", - "size": 3454 + "sha256": "332410778202f21eaf8a54928276c70bbd7d72296945027c1c2f4948353836a5", + "size": 3910 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/retrieve", "status": "success", "path": "en/api/java/beta/vaults/retrieve.md", - "sha256": "7a21add64d142553be413c5e8c59aaa606bd09e07564c071634499528f027668", - "size": 4059 + "sha256": "c0e1470121b64af69c6852923dd3fe6c4ed0e3c0eeae9d13fe5442ac61bbf216", + "size": 4515 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/files/retrieve_metadata", "status": "success", "path": "en/api/java/beta/files/retrieve_metadata.md", - "sha256": "fb4a6e2c81197bc8582356cc17b7764c026b65b218ab826c8af5b41e072142f2", - "size": 4475 + "sha256": "dd31aaa7d933ceb0b6458e3a18fbac9eb5153d4d6fe714616df122f7c17a350e", + "size": 4931 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/files/list", "status": "success", "path": "en/api/java/beta/files/list.md", - "sha256": "a0df62fc5c6258602d3f8d0ad5234f98614702dc3d2850db6ecf533d2a5f7f54", - "size": 5103 + "sha256": "8b5a71dcb189f5912b18419bc9cba9e4f423e4e0dc1da79916a1fe4c409e5ece", + "size": 5559 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/files/delete", "status": "success", "path": "en/api/java/beta/files/delete.md", - "sha256": "29f7a3ce0292aa282bc8e311834689cc8d9755658617613954cde2e04702f5a4", - "size": 3413 + "sha256": "32d465b3fdbf0332ecec63e63df2e9d7c1561c88c7e12a69016e81abd0ff85f7", + "size": 3869 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/files/upload", "status": "success", "path": "en/api/java/beta/files/upload.md", - "sha256": "c2d76b4a21143e3e77e58c8884f38941d78d04f047f01846b67be1dfbfe57670", - "size": 4577 + "sha256": "6e91ef7a115cf9e1d93c688031838810a82705b2d03b1402b7c782f3da519d22", + "size": 5033 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/files/download", "status": "success", "path": "en/api/java/beta/files/download.md", - "sha256": "bd6f3d56c7edfef21f7f456850521eb5ba7f02e6ce5f8b3f0a2210de442380ff", - "size": 3109 + "sha256": "62d537dc985841b1379616cbcb506b95de8b53a7416eb1cf98de9213fc78ef0e", + "size": 3565 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/create", "status": "success", "path": "en/api/java/beta/skills/create.md", - "sha256": "bffc67956616b2a45ecee64e33a087f2de43fdf26ae184bd691d64b61928a231", - "size": 4790 + "sha256": "8d1c771ce4a5e1a1a0fdfdf5c753caf0d4d65986eb1b75bae2b7cf96a934adef", + "size": 5246 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/versions", "status": "success", "path": "en/api/java/beta/skills/versions.md", - "sha256": "2d23c9f8e642c832912f39db14697a08cd2117cd72e8b6f8c1826b0104d7b504", - "size": 22388 + "sha256": "c180fa9d695b7d85f9f63d16b3bd3ca66667dd02f60f19ab0af1d52f2edf7bb3", + "size": 24668 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/list", "status": "success", "path": "en/api/java/beta/skills/list.md", - "sha256": "27e8cac177730c49dfcbc35535524bd1de169051a75a76b737acef4b92c1d2b9", - "size": 4915 + "sha256": "db3e3a6e7aadb0b8b1e536d3cdd49e25635f86bc3da2bd5e6d6b7de013e13453", + "size": 5371 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/delete", "status": "success", "path": "en/api/java/beta/skills/delete.md", - "sha256": "99512468246aca36dca66d9597a4f37c5fa17cfbcbbca8efa61472c06c3ae02f", - "size": 3551 + "sha256": "94dcf10f2cfdd0f7b27f123a2c04149285f0a38f917620effa1a220d1e39934c", + "size": 4007 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/retrieve", "status": "success", "path": "en/api/java/beta/skills/retrieve.md", - "sha256": "6ef7954a06a6a87cbe667bfd79197f67be97df61a784c9c6c7f86d7b3f8959c6", - "size": 4431 + "sha256": "e3f6bd5c6a8d72394376501ecf295a27678118146cc2e6db56af14d74d979aed", + "size": 4887 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments/pause", "status": "success", "path": "en/api/java/beta/deployments/pause.md", - "sha256": "c64a68da8efafb4d4b9f7b95ea106244203a0266cc38563a34dc7f43a6978af9", - "size": 17829 + "sha256": "5bb82b19bacaad13ee528660580dd690cefe4182661f7314e36288a039508973", + "size": 18285 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments/create", "status": "success", "path": "en/api/java/beta/deployments/create.md", - "sha256": "9af107efc0951c9025e517026b3cfc8e3f294e2e020f36113fca3fa857198fe8", - "size": 27507 + "sha256": "e4420069810bb8dc25b22d61b56c0627d6c75bd24415c3cbd4317a0cd3c9af13", + "size": 27963 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments/update", "status": "success", "path": "en/api/java/beta/deployments/update.md", - "sha256": "2ee34a0660b239441fc00bb151aecf8e9b78271cd3756e95bc50ff22cd8daf4b", - "size": 27133 + "sha256": "2b6522b2e769d91a8de1ea1ed44487e5644eea398cd88e06d68af59f182338e1", + "size": 27589 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments/archive", "status": "success", "path": "en/api/java/beta/deployments/archive.md", - "sha256": "780d30b325d39fae799fa6436d114256e37501951a25a7075fa73afc66ec1aac", - "size": 17845 + "sha256": "845bba5645258fe590b6399e6091405b44ad93aed153d97797a4fb4eb4dd3d32", + "size": 18301 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments/list", "status": "success", "path": "en/api/java/beta/deployments/list.md", - "sha256": "9c385412bfa855a4a2fe22596b83c9b1b2b2dee1a1f878e937d501d336079443", - "size": 18820 + "sha256": "a00358504d61fca32b088c3d216126c1e90b87e46b52de1320c6440fe342ac16", + "size": 19276 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments/retrieve", "status": "success", "path": "en/api/java/beta/deployments/retrieve.md", - "sha256": "3a3720dffd700412d39b4a6bbeac4d8df9be3610164c031f13f770bd95832f3f", - "size": 17833 + "sha256": "ad7158da8a891edf4ca5a44c90fabe5ec3211c8dff4c21fa7ddd563c8ea02748", + "size": 18289 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments/run", "status": "success", "path": "en/api/java/beta/deployments/run.md", - "sha256": "7ed0b152ad1e22b47e6d67414c06fb3bb3646a173b194a76c295067077b9cebb", - "size": 8764 + "sha256": "bae33cdbf55cb856a431cd16922dc14f6d3f65df7bc1f5049394141c0d297aa9", + "size": 9220 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/deployments/unpause", "status": "success", "path": "en/api/java/beta/deployments/unpause.md", - "sha256": "6166aea300312ab014aeecd10615634a2717ff96c62016884d41a7357f72a53e", - "size": 17845 + "sha256": "1d920da5c64cb6e65679c9601ac0727ae152e283ae124f8823b4a575c235f94d", + "size": 18301 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/versions/create", "status": "success", "path": "en/api/java/beta/skills/versions/create.md", - "sha256": "8cb9c9b14c8a17c58619957733393453a51c8e65adb549cd586a0047ff86a28e", - "size": 4996 + "sha256": "1f55cdb2588738fe85d046bdde7fa2c902eee2dc1ce4f783fbd05456fef59052", + "size": 5452 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/versions/list", "status": "success", "path": "en/api/java/beta/skills/versions/list.md", - "sha256": "e5cb97cfc91811244a30ccb433e72d319655857901dec34e2f5d25cb6ca19d78", - "size": 4932 + "sha256": "72cbe3a1c94742dbbd33f962a84bcdaab89e70c546916355993e8998aaea9fd0", + "size": 5388 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/versions/delete", "status": "success", "path": "en/api/java/beta/skills/versions/delete.md", - "sha256": "a26b17b98ba42cd24b481fa9e6ea7487c5dea08750bc00b249527e77d8502bd3", - "size": 3941 + "sha256": "c5879ce7c21fddc9f8a1ddf525f7c2d3650ffcbd03b7d50625fe4b30040eaaa4", + "size": 4397 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/versions/retrieve", "status": "success", "path": "en/api/java/beta/skills/versions/retrieve.md", - "sha256": "6e7ad52da18c694e531eed60f9fd5874ccfa3dce64e4ca3aad09074947d567c2", - "size": 4906 + "sha256": "5be5022d0c230776f0437ea5033f509bd265c49cc23f89f501826a81e892446a", + "size": 5362 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/skills/versions/download", "status": "success", "path": "en/api/java/beta/skills/versions/download.md", - "sha256": "efab6c1f6ca6129aa2de645623177d331f65bde915ca747eb73524b714b1a6f3", - "size": 3574 + "sha256": "8410f3b49100857768f9903dbfa81207676ead2744c6ed0086e57f3600281220", + "size": 4030 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/credentials/create", "status": "success", "path": "en/api/java/beta/vaults/credentials/create.md", - "sha256": "771da8aafe81a944c1ce73c5eb38bd7ea150787ff09f32259b11404ceb7e8c4e", - "size": 12522 + "sha256": "ca82bab916fb79046cc853259edde28b2f79cb276c02741722c2b233ced234d2", + "size": 12978 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/credentials/update", "status": "success", "path": "en/api/java/beta/vaults/credentials/update.md", - "sha256": "9aaf2b8d4f89d90ed1eb10cf0f8caecbb113b97b3d49dbbabf0913bda5e1e0af", - "size": 11458 + "sha256": "e58607c37f64874d0406acec2550bde9fe2d51a298d788643e7ee3cf00faa47a", + "size": 11914 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/credentials/archive", "status": "success", "path": "en/api/java/beta/vaults/credentials/archive.md", - "sha256": "2b759721e3f008fe9764b3bcdcc7840816773863d958890b7107ae74774e7386", - "size": 7725 + "sha256": "b41182a76e394911f59d0c60bbdff4c12031db4f84bc20fbfa08577d084db1dc", + "size": 8181 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/credentials/list", "status": "success", "path": "en/api/java/beta/vaults/credentials/list.md", - "sha256": "c505f3977172bb859c97fdd91fef87d874969bd58c1323b69cb81e97cd16ce50", - "size": 7924 + "sha256": "deb87f1f9756a6ea3193479b5f11668c20964c5cf9dbc2bd52b33a28996d156a", + "size": 8380 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/credentials/delete", "status": "success", "path": "en/api/java/beta/vaults/credentials/delete.md", - "sha256": "a3aa9b07ae888b3bd996105d19006e25d7705cd1853b1b13731aecd07ae6be20", - "size": 3784 + "sha256": "7d4f561e5b7b6ed71d036ecab0ddd453cce9ebb7094ad97c69db154e1d518a61", + "size": 4240 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/credentials/retrieve", "status": "success", "path": "en/api/java/beta/vaults/credentials/retrieve.md", - "sha256": "968ab62418a3546f16e5bbe38a9bbf6ad1444da45770a1e7ec7f0b476e683ef0", - "size": 7714 + "sha256": "7acd71707e0307a4da797a7fad45d99e8931d60d51de8ae8f09a89552e3ca667", + "size": 8170 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/vaults/credentials/mcp_oauth_validate", "status": "success", "path": "en/api/java/beta/vaults/credentials/mcp_oauth_validate.md", - "sha256": "5f58e4cc8609d436fcecedddc9aa7babb8432e453af4785e7fa07f8ec4b08e7b", - "size": 6127 + "sha256": "12abb150b19be458f423800a7210091078bfe1f6fb92652a433a4ea05ee6da55", + "size": 6583 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memories/create", "status": "success", "path": "en/api/java/beta/memory_stores/memories/create.md", - "sha256": "9b8c792c8d8196767737185b70f403429249cf280ac0cae9a35520f362565646", - "size": 6461 + "sha256": "b7aaf62ccaa414036ea28bead14225cd7372b4d5af62f0838dc848c7096610c1", + "size": 6912 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memories/update", "status": "success", "path": "en/api/java/beta/memory_stores/memories/update.md", - "sha256": "8401f65128a11cba12e8c586359289542c0e47db3a3e00ce257dcf4667a373bf", - "size": 7018 + "sha256": "5a586ade367eb3cb85089d1b79cc141cd6885c939adcd825a394a14fa6374d2b", + "size": 7469 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memories/list", "status": "success", "path": "en/api/java/beta/memory_stores/memories/list.md", - "sha256": "71bd0268506bf56dd808a3f07d7d17509973524b408d3f752f387bfeafd2c4b6", - "size": 7855 + "sha256": "fe7d1e5c8d16414c7dc6491784a38cc3799e721f60bd6038ce9bcb247eb5b429", + "size": 8306 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memories/delete", "status": "success", "path": "en/api/java/beta/memory_stores/memories/delete.md", - "sha256": "afa44569fc01803effb6dff190a92f220b56ddb9fd84ea996d89b83b1e21ae0d", - "size": 4020 + "sha256": "2a71623cc85bb884e63b93042c2775c9e8b99691dbad9693c055d1fe60177515", + "size": 4612 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/java/beta/memory_stores/memories/retrieve.md", - "sha256": "3e61220a00be2f9187a730f2a024d659c8b07166814bb986b0157f4ab4ca9bff", - "size": 5968 + "sha256": "2ee6064bc98c137ba0cff8f877558998ec31b7c8fd599f2c9d3be4b5eb2cdc2a", + "size": 6419 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/java/beta/memory_stores/memory_versions/redact.md", - "sha256": "64dbc34f3f8d75e0d4ac9322030ffdca6b6f4c043c30d1746cd390effbb983c1", - "size": 8383 + "sha256": "1e4ee89ab84871fcaecbfa36388ec07e20d5ae9a489dae94821437f759e8d03a", + "size": 9005 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/java/beta/memory_stores/memory_versions/list.md", - "sha256": "6d92123296d009cca86cbac75bb27936f1c9f04b82a19f234fe2c0a65b9f84f5", - "size": 9111 + "sha256": "31a3dab03ac047212efaf96b23ae667161f08e6a48d773189c6155379371ea6f", + "size": 9733 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/java/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "e12c715a4db9d75232a60d35969b19380d029b35ae25d6c4f97001064c088230", - "size": 8471 + "sha256": "226c573c3023fecd0058350b868feeee09304bba088166f8ed5f561258444192", + "size": 9093 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/batches/results", "status": "success", "path": "en/api/java/beta/messages/batches/results.md", - "sha256": "436dd713fffa7bab749fbe8c15b0095c271eb4fb3f260521eb35d4c6af9254dd", - "size": 54189 + "sha256": "6002a72327ecb84df1eb25649190ee15a0f48643a6a0b124df800ebc53f51976", + "size": 55604 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/batches/cancel", "status": "success", "path": "en/api/java/beta/messages/batches/cancel.md", - "sha256": "9229dcd5613e9ef352389a5197ba048269b3db147856589dae455728193cfd3f", - "size": 7383 + "sha256": "5688d9b42b20450571c20b3aa4f5e745ccc0c665f2065941d58df1dc57ec1c3b", + "size": 7839 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/batches/create", "status": "success", "path": "en/api/java/beta/messages/batches/create.md", - "sha256": "fba2ade711aad914dceb07a5e94eb0e0351b301c429b2c685cee9de9c05f4db9", - "size": 139324 + "sha256": "4a30e3a45254a4d81ada62aaf3b4885f0a2eed67951f1f527c6fbe21ed6c9309", + "size": 139860 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/batches/list", "status": "success", "path": "en/api/java/beta/messages/batches/list.md", - "sha256": "252e6a57bb97fac33c6c403e361d0b5e240ee46fc241543cfdd12079ccc40621", - "size": 7478 + "sha256": "a860962a10803141257fa32b85c028945df439f695bd0c4414266879d96f184e", + "size": 7934 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/batches/delete", "status": "success", "path": "en/api/java/beta/messages/batches/delete.md", - "sha256": "254357256561e6bfee8a4ebf67844d62dd56f5ae065873fe48052f4b12b4ee79", - "size": 3879 + "sha256": "f2db450e56024f503497d8ba7195cf81cc0ea2fe0aa03bcf2a40a91252613100", + "size": 4335 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/messages/batches/retrieve", "status": "success", "path": "en/api/java/beta/messages/batches/retrieve.md", - "sha256": "c48b4e623c042ed8ce7f35eea1ea9348b59d22d4ae75a7a34bddcce4589dd826", - "size": 7077 + "sha256": "776ec38db5d9a623871af8a351111d942dd1415c0d29a703224014eb445e2d52", + "size": 7533 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/certificates/create", "status": "success", "path": "en/api/java/beta/tunnels/certificates/create.md", - "sha256": "9139275024e7eeca3df8cff60c32f5ce97c23af37b9472e3e6850af4d8e5b304", - "size": 4973 + "sha256": "52377321e2711dd33d182eb3081459c579979b6d746fcacbd7c9e3eb280ee828", + "size": 5429 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/certificates/archive", "status": "success", "path": "en/api/java/beta/tunnels/certificates/archive.md", - "sha256": "70fddb7732f95b166f601856be3f99cccb1e0b6affbc8c818a8dafbf7746e76f", - "size": 4893 + "sha256": "f23791f68e38aa2192778e6d5cc03b36d4538f4aa546e126d5e20da3a78d0984", + "size": 5349 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/certificates/list", "status": "success", "path": "en/api/java/beta/tunnels/certificates/list.md", - "sha256": "faf0a9ddfe3aaa05fed28217a0f576a5fad84ea6e33e7d3b9b86bb36f6a0d273", - "size": 4976 + "sha256": "c7d6c3f3e7cad381efc150ec360e0525f787308b6f6321c29295bf669a48346a", + "size": 5432 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/tunnels/certificates/retrieve", "status": "success", "path": "en/api/java/beta/tunnels/certificates/retrieve.md", - "sha256": "b2553521f88d3cdc337e3b526e38cb13d43c1e33b1db1021a39ec88cc6cdf914", - "size": 4674 + "sha256": "82732c09a7eacf7e24d448ab4ecd412b6037e0fc587e4e079c6d1350246a6a9b", + "size": 5130 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work/ack", "status": "success", "path": "en/api/java/beta/environments/work/ack.md", - "sha256": "51742a3a16bc902bec9bb5b525b586f449f36549f8e2ff9f031cda282c405c1b", - "size": 5937 + "sha256": "a8566b4412d70eea0e6398936d6eff2d7099081c985b41e421591f223f16aa43", + "size": 6393 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work/stats", "status": "success", "path": "en/api/java/beta/environments/work/stats.md", - "sha256": "546007a1f3e02565284c2fd6f5578561f4686ee5912806912cae2d03404cf0c2", - "size": 4188 + "sha256": "5f6824fbc54081887ef630ca31b1d694e73aa96785155960f308319124bf2288", + "size": 4644 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work/poll", "status": "success", "path": "en/api/java/beta/environments/work/poll.md", - "sha256": "606d5aac512fde95fda02d8cce26ee4cfcc4beaa2b7b7a98f1fad5eacf68a383", - "size": 6294 + "sha256": "70c07ae1ece87f188bcc58e3c534d160b4b8040670e108742d1f8bdea66ae396", + "size": 6750 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work/stop", "status": "success", "path": "en/api/java/beta/environments/work/stop.md", - "sha256": "a8f0c3e625e0fe43a5069968ec4be397dd77b6fb9a790a5dcb560d2aa8ce197a", - "size": 6157 + "sha256": "47ea356717dae7f8e33e4a604c64a15f98142718e73b5284f03e490e5d1e2ece", + "size": 6613 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work/update", "status": "success", "path": "en/api/java/beta/environments/work/update.md", - "sha256": "c98d22b157f572cdb93b93d92765b241f8b22a1ede6fc88bee5e8d3401713a16", - "size": 6417 + "sha256": "bea7ee720d500ab0d6355825620fb264dfbe2b4efe14ade845d0057dbe7f7332", + "size": 6873 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work/list", "status": "success", "path": "en/api/java/beta/environments/work/list.md", - "sha256": "f9912388f12a1c417cc75c175d37c1f7fa1237d568e3ae8d75ff305aa02fbb0a", - "size": 5992 + "sha256": "28a4ae342bd3885824125d516b61a7c70e5abc4cfb9533178704f126287d0091", + "size": 6448 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work/heartbeat", "status": "success", "path": "en/api/java/beta/environments/work/heartbeat.md", - "sha256": "407e60b72edb15991852cf208c26899ef91fac4e59889d807a486191a074dff9", - "size": 4980 + "sha256": "cfe9e0307d456205575fe7d822cfc5e3eed6b120038194314c5808f30e65c6a6", + "size": 5436 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/environments/work/retrieve", "status": "success", "path": "en/api/java/beta/environments/work/retrieve.md", - "sha256": "f6929e9d9bda9df8fb25f0c99fc9c63fa4adbf36bf69d2645c4bc04016ceaf0f", - "size": 5904 + "sha256": "5b75e998881c558f37ac6d9191f9a7322c66bbd77135218ac0d119eb876581e0", + "size": 6360 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/agents/versions/list", "status": "success", "path": "en/api/java/beta/agents/versions/list.md", - "sha256": "61b6013c3e8415324a7427667fca1fccfe4b32301ea76f320b7e45886b728819", - "size": 17875 + "sha256": "5612c839984018c9872bcea7f56cb1a629283d8d27a896ca242ba4d87ba55af0", + "size": 18331 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/events/send", "status": "success", "path": "en/api/java/beta/sessions/events/send.md", - "sha256": "1bc5cb137e5285db5fef8f73d786069b6642c3b445de80246b03ef69d554202b", - "size": 24875 + "sha256": "36383e34fb48af9f11d64fbf30c8fde80922a67bf7724277bd7624a74aee48e5", + "size": 25331 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/events/stream", "status": "success", "path": "en/api/java/beta/sessions/events/stream.md", - "sha256": "0695e3e3b298c401b80a2c5354f235e6eb1b6b5964eeb52fc7266536d3fed3ae", - "size": 64556 + "sha256": "dbe1bb930f1fc679add692a76a3b66565ac99c3202070facac74d62de2a74118", + "size": 65012 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/events/list", "status": "success", "path": "en/api/java/beta/sessions/events/list.md", - "sha256": "b8bf1df73d8ac74b00a592f0c71f7dc94d4b8bf41a32320ce77eb36e3f37b3f1", - "size": 62457 + "sha256": "1b6b95591755e9997cc57b398928f4d3285d195e49ccfde540d3016a63593edd", + "size": 62913 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/resources/add", "status": "success", "path": "en/api/java/beta/sessions/resources/add.md", - "sha256": "4151e031cc309a5c82a2e779d5c97e27568c2d0d4158b9ec48a0a939191a25d0", - "size": 4392 + "sha256": "56c05702ddeb1b023672dc0d090f4a558fe098a5402f894d0dc31ccea2425aa0", + "size": 4848 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/resources/update", "status": "success", "path": "en/api/java/beta/sessions/resources/update.md", - "sha256": "11a8f603d9b65c75d693c5c3c0f387dd2243991331ed14abf23a9d339ad94434", - "size": 6303 + "sha256": "995c11f1c29acdbcca484646eb15d98bfe57c60781ff66b465404d0567a146bd", + "size": 6759 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/resources/list", "status": "success", "path": "en/api/java/beta/sessions/resources/list.md", - "sha256": "14007220b410050f6f8742e8989d712b4511a34e24ab41cfe9202c5f74fc5a2d", - "size": 6488 + "sha256": "1fa02887569b1cfbdb757987c2523ae1c9f7447835e1a6908f2557064e61ed39", + "size": 6944 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/resources/delete", "status": "success", "path": "en/api/java/beta/sessions/resources/delete.md", - "sha256": "16c21f15ea10226589b17c70ead8397703594ed301ddf07b3de5f5e94ccefba7", - "size": 3760 + "sha256": "b075dcc2d2e6bf988767e89d178bb1c225305db93ed999e20d753a846adab45a", + "size": 4216 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/resources/retrieve", "status": "success", "path": "en/api/java/beta/sessions/resources/retrieve.md", - "sha256": "b84dfedd44015b4745350b963d769ca10d6ac3334ad9367edec580a63707c09e", - "size": 6082 + "sha256": "cc6fcacbc674ea9154094c9f7018a2a6fd913c1d0ab925fc65585cbc62979877", + "size": 6538 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/threads/events", "status": "success", "path": "en/api/java/beta/sessions/threads/events.md", - "sha256": "325fb9036b8160f1d2c77115a67e4ef74e26c3e5a7a6510654b10a7cf616b97a", - "size": 126166 + "sha256": "fc42872566abc4aa3f0f4cd0cec7625937eef7498016e061fb463d2e375b886f", + "size": 127078 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/threads/archive", "status": "success", "path": "en/api/java/beta/sessions/threads/archive.md", - "sha256": "3e0b4f8af9accbdbefb40f7725a59d3943c3af7f3f9a2f197516e22bbb8a0c2c", - "size": 21885 + "sha256": "f05250f6873cb8605136f01ce64bece25244ce4baf4fec3833fee2c9da7ad083", + "size": 22440 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/threads/list", "status": "success", "path": "en/api/java/beta/sessions/threads/list.md", - "sha256": "0db3d0bb4870da82b614e58831cc48178a29802ec41d1cf7bf078b539aa8b680", - "size": 22217 + "sha256": "55dad07e90451508287f9c36c7bdec9492a17a1a44359a1cfec1a32dfe2fbf52", + "size": 22772 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/java/beta/sessions/threads/retrieve.md", - "sha256": "94cacd7f06277b63c7534fb6b12b04c88eb424f72564bb19e49eaaa7901e6b22", - "size": 21874 + "sha256": "0530a1bb8587239b6f220faa24429551f483fd9e4257610c41bd5efc1fd1edf0", + "size": 22429 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/threads/events/stream", "status": "success", "path": "en/api/java/beta/sessions/threads/events/stream.md", - "sha256": "b877287eda3aff5194d334cfcc0a4342c2d91d0ab09ab737fdb3ad051265699c", - "size": 64843 + "sha256": "efc4b00cc71ccd139f06443e5a99290ddad18b23b37160e7c00196da28bce0eb", + "size": 65299 }, { "url": "https://platform.claude.com/docs/en/api/java/beta/sessions/threads/events/list", "status": "success", "path": "en/api/java/beta/sessions/threads/events/list.md", - "sha256": "1a4d6de4fa4ef35027d3d0d13d403fc81d2b2ca4a2879436166e4d81aea7e1ab", - "size": 61302 + "sha256": "28467e3e6361271319545fda7201d2f6872ac4f7b17371160f50c4cb3c884159", + "size": 61758 }, { "url": "https://platform.claude.com/docs/en/api/java/messages/batches/results", @@ -18622,15 +19140,15 @@ "url": "https://platform.claude.com/docs/en/api/python/models/list", "status": "success", "path": "en/api/python/models/list.md", - "sha256": "f2dfc0404756cc3d5aeec8ff1acc0a133fdc58b8fc0aabf63cf2ac0e310b88a7", - "size": 7294 + "sha256": "6ed8551a462a70f0f9a49126a78f3d6694d652fa169f4fee2b267a6f7cf362f7", + "size": 7557 }, { "url": "https://platform.claude.com/docs/en/api/python/models/retrieve", "status": "success", "path": "en/api/python/models/retrieve.md", - "sha256": "d21de521fc8553fa4f2e3c616ecd83528dbc19363d7f001b5e992745d71f5c20", - "size": 6520 + "sha256": "6ceaba9ca0f69d8ecf1b13f4ab51784e7db4113a921b2d645b85285ad074483e", + "size": 6783 }, { "url": "https://platform.claude.com/docs/en/api/python/messages/create", @@ -18657,22 +19175,22 @@ "url": "https://platform.claude.com/docs/en/api/python/beta/vaults", "status": "success", "path": "en/api/python/beta/vaults.md", - "sha256": "4ce568bd579fb92b23db2fa1c6d85f985e6e46d6dac52b39f44bded39c4679bd", - "size": 68099 + "sha256": "2d0b83f6a8eb1e53853bcdfabb75abe4a75d893d5dcb6a25da15aac1800ef46b", + "size": 71518 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/user_profiles", "status": "success", "path": "en/api/python/beta/user_profiles.md", - "sha256": "bb4db54d14431499db6ce168b729a752d3df6c5bf30ec0bf47aba85c39fdd6c2", - "size": 26110 + "sha256": "1bc31b3aa94c3465ea705e9396d494d843b8987a9d69ea0672362a9a4033faba", + "size": 27425 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments", "status": "success", "path": "en/api/python/beta/deployments.md", - "sha256": "bebfadda4eb25429dd62161b7d55fb7d28edf8ee3c9742e6324d161a81dece65", - "size": 205195 + "sha256": "0adf06a2f3b16ba7b0fb5c05cd558a454306521f689e7d2c6564e330e8e3df5c", + "size": 207299 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/webhooks", @@ -18685,309 +19203,309 @@ "url": "https://platform.claude.com/docs/en/api/python/beta/skills", "status": "success", "path": "en/api/python/beta/skills.md", - "sha256": "94c1b2f80954b553b4eb5ae08cbbaa56a72174c4b27084af168b9dffc1dbd104", - "size": 32377 + "sha256": "11066f6b241ca4746cf22b22bb5e04086fdca25f092f225aee3e53183f870937", + "size": 34744 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages", "status": "success", "path": "en/api/python/beta/messages.md", - "sha256": "2e9ed8b44f7c2de9da7964f19b7ed9830ac5fb09f0393b4303c57de3ddfada1a", - "size": 1305717 + "sha256": "a75c4a83ace436f43231d1c6f91ea6612122c41eced452631342ca6f6224a6fe", + "size": 1318792 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/models", "status": "success", "path": "en/api/python/beta/models.md", - "sha256": "d712421c48a2fb87de3efed1c2ff54cee0ae977461111de421e69d73d0856ae7", - "size": 23007 + "sha256": "b5375f135ec8340bcb5b5f37e4d5d7f5a37f8b953c2142bcfc7f84dec4279072", + "size": 23533 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/agents", "status": "success", "path": "en/api/python/beta/agents.md", - "sha256": "f42423d0a20091658fea466b56bf4acc4239d0d1844345ab37e3d63b66d14ca9", - "size": 254710 + "sha256": "7941aaccc2b8f847a2c74d97f6f0ba66968abe69fb6aed9489f5d72e383beabc", + "size": 256288 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/files", "status": "success", "path": "en/api/python/beta/files.md", - "sha256": "60408b91b341832161244280b9791f23ae2d26af594c81cf7ef52283b62d38fc", - "size": 16509 + "sha256": "43fb474082a4cf7643ec7e11c4d1bcce647816c422c34b17bf126647195cbb78", + "size": 17824 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions", "status": "success", "path": "en/api/python/beta/sessions.md", - "sha256": "a132607ada8530a6bcb26c51166f7c7fdf71751a31a6d53bba453ff1c2182a12", - "size": 710121 + "sha256": "1b7e549e6a9527e18319fbee0c37fe3abafef90a230f2ff0f1137379d2cd82d6", + "size": 715415 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployment_runs", "status": "success", "path": "en/api/python/beta/deployment_runs.md", - "sha256": "e94bdf8e23b8fb27fbb10e8045cc232bf028f896224fdc28fd70b111463746e4", - "size": 29438 + "sha256": "b96b2c056429998cdb08c4ddb92c2a6ae2040826ef6a209ea1381f42b269ba9d", + "size": 29964 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores", "status": "success", "path": "en/api/python/beta/memory_stores.md", - "sha256": "feaeca71bb612882cebd884f2e8af72b752f40ea3c9fdfbc63becec1c9992900", - "size": 73636 + "sha256": "8d8fd9e3108ccd23758731ef002fad2a34707e26b20cf3bba1c54bad320906d0", + "size": 77932 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels", "status": "success", "path": "en/api/python/beta/tunnels.md", - "sha256": "1920273f0b30403941e494d50b29cf68ada463d836af1db9c45c5e4b32f84c9b", - "size": 35037 + "sha256": "0905e62f6dba7c228657917e19d4fca7039ee4565d2f6ac1ceca022324fa9e44", + "size": 37667 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments", "status": "success", "path": "en/api/python/beta/environments.md", - "sha256": "9eb7fcd1052cd9a1a52763883c574745642172dfaaf50b8eeb8841a35c0dbd3e", - "size": 84092 + "sha256": "92b5067a6f634bb69f635581d34cf51561f268ae8e05e1db310301976d7026a6", + "size": 88376 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/threads", "status": "success", "path": "en/api/python/beta/sessions/threads.md", - "sha256": "cd5bbdef5012a43f68247a70c37ac29786617fc15341e7f65863c9fe25562dbc", - "size": 282909 + "sha256": "5efdb62ac99d225d43765131ee7d64b9abae2fe9f628fc8a4dddacb3ba016eef", + "size": 284620 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/events", "status": "success", "path": "en/api/python/beta/sessions/events.md", - "sha256": "79d3bb0c80fc3d44f90958cedfdf8fa4a8f42b862c2b0148c40ca49ed9aafffc", - "size": 392067 + "sha256": "a9162e38a67a8b4649e2c9adfc7f8a890dd3b665a73916723a7de65d36579da0", + "size": 392856 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/resources", "status": "success", "path": "en/api/python/beta/sessions/resources.md", - "sha256": "5101f9917623b46477ac432270e4714d6b299c481bb76f4bbfaeb1bc77d702ea", - "size": 30531 + "sha256": "e834039c1102b969b11b7688be7db46ae923079d21c732f83ca4c56874db7bea", + "size": 31846 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/create", "status": "success", "path": "en/api/python/beta/sessions/create.md", - "sha256": "62c7e675be23ba991b3127cc1fe34e06979049a16cb071c28becd4b8d099ab72", - "size": 61097 + "sha256": "11fc29e46f76661203fb4dc69bdfe469ce49fbedf43e7a4d61c1e910c10d21dd", + "size": 61360 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/update", "status": "success", "path": "en/api/python/beta/sessions/update.md", - "sha256": "4d1e7b52f0017b0993c4536b7b16aefddb5e8a344fe7f7cfc791dd5c5c89c944", - "size": 44949 + "sha256": "cce99c2fe372e3bc6608451cc4efd9152597d13a58b0d05372093c13a8c985be", + "size": 45212 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/archive", "status": "success", "path": "en/api/python/beta/sessions/archive.md", - "sha256": "9880ff6cafecc0d796f1488a26f73238cfcc42a9d190f33c983e80d302cc8649", - "size": 30628 + "sha256": "dd06e1bc83a22115cfb7a9d5f383ade05aafd21a590aed4b1dc4c7299a76f5ae", + "size": 30891 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/list", "status": "success", "path": "en/api/python/beta/sessions/list.md", - "sha256": "fdd98edebc7bd5679a38c695ca80f539e4c4876be895a5c0ce9e21d1937410c9", - "size": 33007 + "sha256": "bf0d4d014db4addcf9807c1f2e0764fff71469613fe018f385ee03e6e226135f", + "size": 33270 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/delete", "status": "success", "path": "en/api/python/beta/sessions/delete.md", - "sha256": "c9c50c286585dd79001c42148fc37e3a715f5e19248bd5aea0a1f79cc4b3e4fa", - "size": 2342 + "sha256": "d15234a6d48a52c87d6a409540baa0c351fe8daf7be2aaa4a522acd7ccd7cd2c", + "size": 2605 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/retrieve", "status": "success", "path": "en/api/python/beta/sessions/retrieve.md", - "sha256": "efcb8205f16b54342d64c0e4c6cb9ec079df76d66278b222b7c7f22b6cabf033", - "size": 30613 + "sha256": "e6cb51015a959ecac252c330631fda27cc8036ed4598a9515e1a43cfa644b9c4", + "size": 30876 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/agents/create", "status": "success", "path": "en/api/python/beta/agents/create.md", - "sha256": "f29af0bdb0089d324aa05701899d9941801e1f34d84741f9412aba230535fcd0", - "size": 39943 + "sha256": "dca452c3abdf995dad22c39a7ca21b41839106a17a298167a8addd7f6a945185", + "size": 40206 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/agents/versions", "status": "success", "path": "en/api/python/beta/agents/versions.md", - "sha256": "12eb00500460789a368858abcceb5a1c77b0e59e883009e940edd18545fdd8eb", - "size": 18342 + "sha256": "cd9dc6cc214060095522d27e0bc97f2132ac6df730937223e9b0753534efbb8b", + "size": 18605 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/agents/update", "status": "success", "path": "en/api/python/beta/agents/update.md", - "sha256": "4e8a50eabf0a9509f4aec593cf47c66caaead2bde145a4a292e31f3c11b039d3", - "size": 40773 + "sha256": "129c1cc021f53d00e2b8c6765207442f23bd938ca4d60b238e928e9bb192cce9", + "size": 41036 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/agents/archive", "status": "success", "path": "en/api/python/beta/agents/archive.md", - "sha256": "39ae7df93cb2c8473062f76a57e9a6d746cb8aa89531aa60b237d7341f159ed9", - "size": 17820 + "sha256": "4c1a2630fedd624ad74046d105d7b88b1812c7a02c151ec97b9c89cdf240a59d", + "size": 18083 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/agents/list", "status": "success", "path": "en/api/python/beta/agents/list.md", - "sha256": "26eb807419649e036f77d6bef9854b07bbc7bb54569c0c7b6df209679a5a4ea2", - "size": 18582 + "sha256": "c6c79bba0de8f26c2e383a4bd9d8048c4c4d26fd35a553b13a6ae2be3468d660", + "size": 18845 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/agents/retrieve", "status": "success", "path": "en/api/python/beta/agents/retrieve.md", - "sha256": "aff034dd0c9192c7ecdfe8d8e962eecd30bd54e6a3e4248444149dbb15bb57e7", - "size": 17935 + "sha256": "58dab28d0ec2d268e8887748fe4e617a06752a0f465e580f91343cf21c6734a0", + "size": 18198 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work", "status": "success", "path": "en/api/python/beta/environments/work.md", - "sha256": "1863c2c2c4967be683178c8c1aa7f046ee5ad926ef7ef9916c0a7145dfe187bc", - "size": 41908 + "sha256": "d661f32ca05a4d3ddcc4f1a7f88f5f453b0eaf16c729fba9158f6af51558928e", + "size": 44012 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/create", "status": "success", "path": "en/api/python/beta/environments/create.md", - "sha256": "e604cc6ce2a1192f1c898288931c13961c2b205b3de4b5b645099e84d389a82b", - "size": 8800 + "sha256": "56f27afd2224f8bcb7fb2fb4cec03784e13057a2a6c2f356842f93a57bd14472", + "size": 9215 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/update", "status": "success", "path": "en/api/python/beta/environments/update.md", - "sha256": "a31d269c9580167f4f859ee968a88891cac5963bf332b7223e4ae3a108c3548d", - "size": 8926 + "sha256": "2c86ecacbb709f81f40e4e3148f0fbe082f149484c0cd443ee788bf93a43e136", + "size": 9341 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/archive", "status": "success", "path": "en/api/python/beta/environments/archive.md", - "sha256": "a8eb1b89b4f168bb018e9911dfcf5e3d2a5c49b1b7e1fb98119a08739bea6fd8", - "size": 5871 + "sha256": "ab9473055f8bf39e4255bddda37ba2a5d36c0f8a94f65e49cb0dee411b5b60c1", + "size": 6134 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/list", "status": "success", "path": "en/api/python/beta/environments/list.md", - "sha256": "6cddbe0d2d0ee481d071cad95f01f5c33bddbaa0bdd6a40d285e1ee0b8a9c931", - "size": 6309 + "sha256": "b46106c36abf7163f942d663c92af5e37e4f6fcd739109cd101015663398cede", + "size": 6572 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/delete", "status": "success", "path": "en/api/python/beta/environments/delete.md", - "sha256": "65a2dfe7f47fc5923f310ad78197adf7b7514c381110d9570887297c9eef5937", - "size": 2492 + "sha256": "0ace97e4da9e339083ed87eaecdb7e01ebd5929b5603d1ea65808ac0c2866ab2", + "size": 2755 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/retrieve", "status": "success", "path": "en/api/python/beta/environments/retrieve.md", - "sha256": "8f8d9a749782a3c202b5ce6b8b6521434efeb1015a42988d2906730ba3201f74", - "size": 5808 + "sha256": "c7ba1b5f8ac2d5949ec61df3b3a31dd6a1577a8a168cab376055dbc5070a5fd5", + "size": 6071 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/models/list", "status": "success", "path": "en/api/python/beta/models/list.md", - "sha256": "9bd7aa301fab1d615bde3acf7e3b1d72316c34fb1b63d826c49b2ddf69f40670", - "size": 7678 + "sha256": "357481194d7ca5bd2438ca9f4876525c4cba23acb3728b008b66340d721d965e", + "size": 7941 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/models/retrieve", "status": "success", "path": "en/api/python/beta/models/retrieve.md", - "sha256": "f75879bdad53c97c1e44f89fbf212857781141e9d5daa2dee7fa3246802964b9", - "size": 6902 + "sha256": "bbadaded1261656b7103da313ccb5f6a029a4f56b160fc383fc6bf29ac3309a9", + "size": 7165 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/reveal_token", "status": "success", "path": "en/api/python/beta/tunnels/reveal_token.md", - "sha256": "19e88369f13e8a165c706024cfe06fa7e3aeb4f9f99d662d7126d5d0c608fec1", - "size": 2927 + "sha256": "55b1f774eb74b8d9001264ba415424a8fe198916d508be850464a58bde9e2920", + "size": 3190 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/create", "status": "success", "path": "en/api/python/beta/tunnels/create.md", - "sha256": "b7d7a83eb9872354799f670cc8a7cb4d588cd07ee08b99bd222499171f8ff55a", - "size": 3355 + "sha256": "55fcd0b0cd37a5f5156634291f86821da8b805a438e6428a8dd60f916a76bf66", + "size": 3618 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/rotate_token", "status": "success", "path": "en/api/python/beta/tunnels/rotate_token.md", - "sha256": "6443ded5b3e8ab143aa34d964f34f163d4a1b158431de3345a441029da846567", - "size": 3020 + "sha256": "559607ef381486b83c95c1959050e1fdabe210c33474d40f6243d8f25f90e48c", + "size": 3283 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/archive", "status": "success", "path": "en/api/python/beta/tunnels/archive.md", - "sha256": "669f20747d3f1f804509ee6f0026e93b012579f0161d42cf8c6bc2748d0e1b28", - "size": 3416 + "sha256": "c68f3be00ad571feda5e40e5effb655e73929c9b5018b6566a844cc28e423e59", + "size": 3679 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/list", "status": "success", "path": "en/api/python/beta/tunnels/list.md", - "sha256": "efb02368aa58d349f66edeed03cdecf43052baca0a9f189cc693166524cf7a7d", - "size": 3594 + "sha256": "5eef85263caec995f9a0633fbf2ac1ea53a54be1e28077d43fa6a06039e1720a", + "size": 3857 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/retrieve", "status": "success", "path": "en/api/python/beta/tunnels/retrieve.md", - "sha256": "75236565d78d0555d5f2b4b3e43193ce0ce20be81678f600f2dea677ed1861ab", - "size": 3136 + "sha256": "9f315ceb6de447662619effef0fae3d96643ea43ed6074090943f49e48a56ff9", + "size": 3399 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/certificates", "status": "success", "path": "en/api/python/beta/tunnels/certificates.md", - "sha256": "e2aeb7ad8d7baf2d8d9b5b5c4c235342fa0b207108cd6234ea43fc6c5517d173", - "size": 15196 + "sha256": "09fead2663d3fa6711edabbcc34520b5ff20be878d7752588b44e98adbe5be51", + "size": 16248 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/create", "status": "success", "path": "en/api/python/beta/messages/create.md", - "sha256": "e24abe6281c34b58897e713dc5166f4b2eae7672f6b7a8a52fec32ff12e25081", - "size": 182258 + "sha256": "816b1b544e8a0fe3e7b5a67bc287ba874a622ce2f4d8d290291e1a02b625af56", + "size": 184501 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/count_tokens", "status": "success", "path": "en/api/python/beta/messages/count_tokens.md", - "sha256": "4141055de8442a3b82af63cfbe5facbe2060a1cb4172ab0020e6f0580e2665fe", - "size": 116627 + "sha256": "389347a7cbc733abb4e980c04e1a49b0f2d6a9763ddb8a32a0bd5d764ba352ad", + "size": 116954 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/batches", "status": "success", "path": "en/api/python/beta/messages/batches.md", - "sha256": "895972eaa07e41ac6f60f646cac1468763a83e7237670287b5cadd1f5b32cf58", - "size": 384395 + "sha256": "ffdf544dc47308f8608576688a40aa32ebef0d0ae0ee5c146b2e270bfc929b71", + "size": 389883 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/webhooks/unwrap", @@ -19000,652 +19518,652 @@ "url": "https://platform.claude.com/docs/en/api/python/beta/deployment_runs/list", "status": "success", "path": "en/api/python/beta/deployment_runs/list.md", - "sha256": "6195ba8da9b10decda68d41caf4b5019890530bc34aa4dd72fd5cb3de847708e", - "size": 9489 + "sha256": "f12ccb1befc31ff35bdab7f77015bb6ea8ead95395cf527223529c3119458ccb", + "size": 9752 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployment_runs/retrieve", "status": "success", "path": "en/api/python/beta/deployment_runs/retrieve.md", - "sha256": "11d93136cd8cddf304b59a0c07afe0cc89cd26f87da4bad496c9c8a085286326", - "size": 8253 + "sha256": "502a10e3d4e441367eedb592e61544e7ab6291cf7c730b614ef0338dff0a17a6", + "size": 8516 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memories", "status": "success", "path": "en/api/python/beta/memory_stores/memories.md", - "sha256": "d9075c8e5f103503e428dc7e066c9910bdd68fd78b003cfa2f0cb9612b73961d", - "size": 36941 + "sha256": "8c7dbb15e3b0809cd6d67fdae6a5980d9749d60ff4f9d7abc2686d5000180a53", + "size": 38498 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/create", "status": "success", "path": "en/api/python/beta/memory_stores/create.md", - "sha256": "99f4bbdd7cc35e03996a4a38c828935c525769f6e979fafc882c1a80b0bb85d2", - "size": 4470 + "sha256": "9cd53669d2027cce7ae80702fdf32ece00ba2bd796354351551a0a345c5b54a2", + "size": 4733 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/python/beta/memory_stores/memory_versions.md", - "sha256": "8fdcc11389c8b2fdbc6e8faee627e4fdac4a27577c94efdc7b8decc29d178442", - "size": 30492 + "sha256": "ce93d80a832a2e91f2915a0c0bc88b3f40784cce7d353d2af0812c2bd7d36283", + "size": 31945 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/update", "status": "success", "path": "en/api/python/beta/memory_stores/update.md", - "sha256": "d82386c08ff80478a714a31d7d7dbfb82dbc040d8ee4fa71795a1479f99c4ce9", - "size": 4413 + "sha256": "927ac7a0acf3cb7fc4b5e9f0aaa35cd7b72992b5383a5853593fa62d785230ed", + "size": 4676 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/archive", "status": "success", "path": "en/api/python/beta/memory_stores/archive.md", - "sha256": "aaaca2391edc644dfc2f4e4f413f0bfa6b001906629c155156ac1fce74be8210", - "size": 3797 + "sha256": "b08f99e3b8588f69d393a96cf50e5c2ae2134923f6879e643fcefe628f1e6cbd", + "size": 4060 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/list", "status": "success", "path": "en/api/python/beta/memory_stores/list.md", - "sha256": "13cf5b61e29ff23051ea6149839eed7bfa2e67e28aef180dbd89a80a4e9e89f9", - "size": 4606 + "sha256": "9fbbcbb5da28d6ef87300431ce5a748eed926c832e201cf1aee8699bcf1f524f", + "size": 4869 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/delete", "status": "success", "path": "en/api/python/beta/memory_stores/delete.md", - "sha256": "25f5636bbfe7100e7cc85b1e17710f31adbc2116008f2baaa1bc4137f0d12fe8", - "size": 2504 + "sha256": "79259f80b25d294af43297c930b03a524b0143ed8b7434556cc9ca0147ea0cdf", + "size": 2767 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/retrieve", "status": "success", "path": "en/api/python/beta/memory_stores/retrieve.md", - "sha256": "b334e6f6f885218e3d50136ec41ccb59e3e1a2c8593520b4cd01061567e1612c", - "size": 3792 + "sha256": "4da7333a06d945588eb77850cc832423f42a135ec246938f30b20afcb60e94d8", + "size": 4055 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/user_profiles/create_enrollment_url", "status": "success", "path": "en/api/python/beta/user_profiles/create_enrollment_url.md", - "sha256": "efcda593a09f98ae62672688a6fca1f9d26c05daf5f3ee80fee90fa990deae0e", - "size": 2653 + "sha256": "4d6b8f8b00c76b046ed81c01dea26e8f3b2529066052d57b7c665ebff142ea1e", + "size": 2916 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/user_profiles/create", "status": "success", "path": "en/api/python/beta/user_profiles/create.md", - "sha256": "b6d2ccc880aef553c83434b4cbe8bbaf640fc9c6b08ca8dc71b1742dd952c82a", - "size": 5804 + "sha256": "6d2e9116e68d76b8c8cf88ab5219c94a2335aa273498ff6789df7682111ead07", + "size": 6067 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/user_profiles/update", "status": "success", "path": "en/api/python/beta/user_profiles/update.md", - "sha256": "3646844c9162f3fa6b820978b7af5b92c33c632908f16a90815de44847827382", - "size": 5861 + "sha256": "334e05bf2b49305572afb83e32576283a94a208fa40c51df915a322052047eb8", + "size": 6124 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/user_profiles/list", "status": "success", "path": "en/api/python/beta/user_profiles/list.md", - "sha256": "9bee0cea7bb57c96d7ab081511877d50ed9748f7a71d102b1b7edfb161bca046", - "size": 4700 + "sha256": "66e5ea95473135ecf21966af217abcd69b0189f86c292c4bf4ab828f579bfcaf", + "size": 4963 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/user_profiles/retrieve", "status": "success", "path": "en/api/python/beta/user_profiles/retrieve.md", - "sha256": "d3f6206fea419933f19a49b767fd23a54fc2f253a97caad142f4719b9b72728f", - "size": 4448 + "sha256": "2b3a4253c52aa5e7e919b40a08b6d103d0066bf305fce1e98b174ab7e6dd5fdd", + "size": 4711 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/create", "status": "success", "path": "en/api/python/beta/vaults/create.md", - "sha256": "ad69583ee7689f2a5c2d532939f53b85f35f196595a5a269c5b37166af5e36cb", - "size": 3143 + "sha256": "4ef307d970039bb5c7c6cd79d140b3647da16caf6c16e94b805f90f959e2962a", + "size": 3406 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/update", "status": "success", "path": "en/api/python/beta/vaults/update.md", - "sha256": "220f361b56c5e375f0af5f053aaaee18d424afa87579d2ba4ebea4e7ca34d696", - "size": 3211 + "sha256": "7617878a590abd4310718dc8d1de63f83be5442ae92f05e8dcae7a252ca01083", + "size": 3474 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/credentials", "status": "success", "path": "en/api/python/beta/vaults/credentials.md", - "sha256": "081d5bc69519abe7b59af6c04e0a5c74cee55da77b827c467cf6bd7ea4844d72", - "size": 78231 + "sha256": "b2c38e7f48608f76d07b87991fd23b000f65205e2985d0c71d988be71a6fa1ea", + "size": 80072 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/archive", "status": "success", "path": "en/api/python/beta/vaults/archive.md", - "sha256": "b3a3cecc6f2b8cda1ad9c047809a269ef212b430cb52cf026ffdb9189328e8ac", - "size": 2936 + "sha256": "da9f5cc757f01e8b49cf923521015e2b97b1655e4dc7313af5ee31e64d387c3a", + "size": 3199 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/list", "status": "success", "path": "en/api/python/beta/vaults/list.md", - "sha256": "10361c632a28d8ea1f89447517ad4294ce404e71d794b649d6b98ff76b81d1b3", - "size": 3245 + "sha256": "8dafbf3db49a491b357b2ee38fba494598161b00888c921cbbd36f255b4a4d14", + "size": 3508 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/delete", "status": "success", "path": "en/api/python/beta/vaults/delete.md", - "sha256": "0fb392b7e318d68ceb1bf62c7916906f07de33ed73b8105b3330939921313bd7", - "size": 2328 + "sha256": "42c2d09e973d2349210954ba5460494cd3859bcf2529ea918f309aadeba12a35", + "size": 2591 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/retrieve", "status": "success", "path": "en/api/python/beta/vaults/retrieve.md", - "sha256": "9d8a6fcf9d7b1eba2f23b41ef8251435e652475692f3a26af025fbfc76004283", - "size": 2921 + "sha256": "de255df641a042f5ef78d46027e17914aadf3635fdb4181f297ca31a83d7a696", + "size": 3184 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/files/retrieve_metadata", "status": "success", "path": "en/api/python/beta/files/retrieve_metadata.md", - "sha256": "d4ca846f241a68b8913d33065a0bef8459a608f2aab55ce34d909010f706f439", - "size": 3321 + "sha256": "14065f96c38f35026efe5377e0ac4d64a1b4e491056fd904a5138314a11a8148", + "size": 3584 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/files/list", "status": "success", "path": "en/api/python/beta/files/list.md", - "sha256": "4d5979f9528c028f0366eb6e16a218f6269139dda380400c7f10e2756b238821", - "size": 3990 + "sha256": "744f62653369cfff9e9f75436c0f8291876c41a0a384b548a11c917e8d6294e9", + "size": 4253 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/files/delete", "status": "success", "path": "en/api/python/beta/files/delete.md", - "sha256": "8c61583f923ba9061a422ab5a982d5d3733ad8abe1a34284456b6fac7752c165", - "size": 2324 + "sha256": "674e5f4ae85b246f8a4c54c866649bc59da1bbd0eb18a31f45167b848d207932", + "size": 2587 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/files/upload", "status": "success", "path": "en/api/python/beta/files/upload.md", - "sha256": "8c7551bca75ca8fab4f02d78080780c2af8db7c0753cc8f1a2555e0db587e7e3", - "size": 3296 + "sha256": "112076ac304a8de3635e0ddf4af9ab9493f14e81595e3434960b51b80a5088ed", + "size": 3559 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/files/download", "status": "success", "path": "en/api/python/beta/files/download.md", - "sha256": "c7c5699d90d206c418afa597d32ccb4f5b148edd848dc309fe5f3e7e9ac6a342", - "size": 2054 + "sha256": "fad299d38b570ef21a06b07f63993649a4c644972f1b239b31f110a4e7d2c4f8", + "size": 2317 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/create", "status": "success", "path": "en/api/python/beta/skills/create.md", - "sha256": "745cc274d959eba530377bd7e36f8cdc76c25d0951d9845b391a6017d5e3f2d7", - "size": 3480 + "sha256": "49b8703f54269067b0f5969f45160ab7a01203cf46be8aabb59e0afb59b1cf6d", + "size": 3743 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/versions", "status": "success", "path": "en/api/python/beta/skills/versions.md", - "sha256": "d35d18fe694f835fa4353a9feed139337de745d160aa06ffbc7f433f51e2032d", - "size": 19617 + "sha256": "6dd8083eff2444239e0e931ae3e2155b3ae9fc2c488d044e41cc7e53ca436299", + "size": 20932 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/list", "status": "success", "path": "en/api/python/beta/skills/list.md", - "sha256": "0baa106591afeeeb7a467a39d3d2be46b491f2979d3d0ff33a6d6146ad037c41", - "size": 3801 + "sha256": "6f96e675184cde1f7cafe1d4cd604187c9243122ca076b811fe7ca11246a9ec8", + "size": 4064 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/delete", "status": "success", "path": "en/api/python/beta/skills/delete.md", - "sha256": "63de3ff8374d87a935e07f6614b5b7b5be4117dd6ee3e70468e395f7370be85e", - "size": 2414 + "sha256": "235f71a9503b160c62a31aa96d6b1e62800b6ac19c55744b05768b0300f913fd", + "size": 2677 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/retrieve", "status": "success", "path": "en/api/python/beta/skills/retrieve.md", - "sha256": "13811cf612f57af7e6a1542c3a2c928935e44350b7a0187854c3cf728c76bf37", - "size": 3270 + "sha256": "e76cbdf7af08d6b26fcfc61e099fda16e33cccac139a0d613ee357184c88ca12", + "size": 3533 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments/pause", "status": "success", "path": "en/api/python/beta/deployments/pause.md", - "sha256": "eae97749ea06ebbad2c888d2d53d1f36bffed2095d2c7498f21cf723581148f2", - "size": 17654 + "sha256": "66274e73f902fbeacc55dd6c6401abcbad574e4ffc97f30fc5fd74354834e855", + "size": 17917 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments/create", "status": "success", "path": "en/api/python/beta/deployments/create.md", - "sha256": "78fd9cd9e9771a001696bf00c4639097fb34263079f5d68f7410e9b8b87951c1", - "size": 28180 + "sha256": "7db407f9dd758dda119ac4b336cc8518b34fe80919328d9d01eb0abf81700f49", + "size": 28443 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments/update", "status": "success", "path": "en/api/python/beta/deployments/update.md", - "sha256": "8b9f27bd245b7603e8e6452b01a745c0c876cae65cb4f5a061d6494f57670cac", - "size": 28149 + "sha256": "26989d363a30f5c75d7b06273e20b7083d06289c690c3cc50269b4cc27b4aa35", + "size": 28412 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments/archive", "status": "success", "path": "en/api/python/beta/deployments/archive.md", - "sha256": "4ffc772109b4e29936b3e2349c427f35fab41c3b637025d422ed339ea6869506", - "size": 17664 + "sha256": "d62c07dbb3d18b78bc44654fcda349b471b400d6d96d122b5dee5412ab43d590", + "size": 17927 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments/list", "status": "success", "path": "en/api/python/beta/deployments/list.md", - "sha256": "424e12909dd355a68a46038d624c14e7bc5cdf2d8ba7cb4a0c915cb38393e070", - "size": 18674 + "sha256": "2009f74e18a7adb5c882d3f8f80dcb6ea33510b9d763cde6d257a394fd1c5d7d", + "size": 18937 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments/retrieve", "status": "success", "path": "en/api/python/beta/deployments/retrieve.md", - "sha256": "230f3ab173327b5ef1a601f095e778d5644a33f251be4e97ef3146c09b82f035", - "size": 17649 + "sha256": "10ca9cde072c5da67d24b933c09cc1aa517b360475058f3e8becc22a8f7f14d8", + "size": 17912 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments/run", "status": "success", "path": "en/api/python/beta/deployments/run.md", - "sha256": "2fcbb5d9ca65cc5fcaa044b9b5137a6731732ebefb172dd963b98fd99846aaf0", - "size": 8232 + "sha256": "789e492018c50bc27d49ebc989f9256ddc220baae2f4f210ce55c40133cf650f", + "size": 8495 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/deployments/unpause", "status": "success", "path": "en/api/python/beta/deployments/unpause.md", - "sha256": "540a3aef918fc2197431896811c06dfa067f9f6e109750b13da5628b010d62f0", - "size": 17664 + "sha256": "be6c0e7f47dc36ac096b0897938578408b7c59b6b9e8b2e549fecc70efdc9fdb", + "size": 17927 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/versions/create", "status": "success", "path": "en/api/python/beta/skills/versions/create.md", - "sha256": "4c21a349117a2153f48c28730accb9249d5bfd5255c01efaeb37d704ad459169", - "size": 3650 + "sha256": "b3f022aa7fb63edcb4a17ec57dae775e2d7b9c692621587234ed91926435c9f1", + "size": 3913 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/versions/list", "status": "success", "path": "en/api/python/beta/skills/versions/list.md", - "sha256": "ee59497c288093e9733e3bee509cf3ee1eb42d9b1c1c4b7879d199a94c1050ef", - "size": 3798 + "sha256": "dd0b29fb0ee185f52de2aa3eb153a570886670d0807c90660a186d638aba0d08", + "size": 4061 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/versions/delete", "status": "success", "path": "en/api/python/beta/skills/versions/delete.md", - "sha256": "b34099eb7b0585fd33f0899b8bdb5794a3118adbe5b1056505b3882ddcc1a0f5", - "size": 2675 + "sha256": "4c3854c306fd3888c672b50adb7ebaaddbdc665a5015eb571d707e8394ccb37a", + "size": 2938 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/versions/retrieve", "status": "success", "path": "en/api/python/beta/skills/versions/retrieve.md", - "sha256": "aac5e5bf326d14b20cf0305ce6d21d138481a45f5e475ed022cc0a450e513b3f", - "size": 3610 + "sha256": "54ff8267ef7441a95e841006477491888204753db16c9b438f360c7c647bc569", + "size": 3873 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/skills/versions/download", "status": "success", "path": "en/api/python/beta/skills/versions/download.md", - "sha256": "48f307e59fcfe70102e53816137e6f8437b171ef28125487a0b0d95a6859801d", - "size": 2387 + "sha256": "069406c2b86eda5b4144c1fa498ca8e6726159dca91ba76bf094c6a68f0810f0", + "size": 2650 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/credentials/create", "status": "success", "path": "en/api/python/beta/vaults/credentials/create.md", - "sha256": "2cd03498d16c8b19cac6058f0b43c23cca8a496a70d67b2c2dd3bfe706a288b4", - "size": 11233 + "sha256": "7e53d374bd7d3cd2b96ad88734a2de2515fe81992fc297992012758aebc0879b", + "size": 11496 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/credentials/update", "status": "success", "path": "en/api/python/beta/vaults/credentials/update.md", - "sha256": "f383a85647d297ae708f8c2d06db607bd352040818406220f6a6de1b74902b24", - "size": 10438 + "sha256": "a1468c4e90d32faf1fe0302654042708805eaa1a473b8f44bd290daa4e93f71f", + "size": 10701 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/credentials/archive", "status": "success", "path": "en/api/python/beta/vaults/credentials/archive.md", - "sha256": "016197a771a0ed8d5f05ae0b1b96d661fc551f50a6f07775648815d6e0a90005", - "size": 6644 + "sha256": "bdfb45042d6abb6c6cb78d13d29b9544680a379088a583a6bb5bb3c3f12a25f1", + "size": 6907 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/credentials/list", "status": "success", "path": "en/api/python/beta/vaults/credentials/list.md", - "sha256": "394c7ae90d29b90cac4cfaf0d5446c909cee5b153541e0398526b934723792ec", - "size": 6968 + "sha256": "4c04d1a9e68097101edbb082982542fec3bfba071512f6eaa0fbad17676394d6", + "size": 7231 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/credentials/delete", "status": "success", "path": "en/api/python/beta/vaults/credentials/delete.md", - "sha256": "8702216bea1b4ff3240e6abd92f3af7bc38514fe6e2534032047f1082a54168c", - "size": 2523 + "sha256": "7b4d5b8c90fa0d44b57a575fe7dd6857eacbab842a0eec74a8c17a0ddc135ee0", + "size": 2786 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/credentials/retrieve", "status": "success", "path": "en/api/python/beta/vaults/credentials/retrieve.md", - "sha256": "3d8b08eb04d73e48857bc34d1ac42b4e37fa81c2899a22638fd35f52f8cb0424", - "size": 6629 + "sha256": "950cca76b52e2412d6061cb031c2ccd36bfced7bc45f449a9e2c44b2668ccb85", + "size": 6892 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/vaults/credentials/mcp_oauth_validate", "status": "success", "path": "en/api/python/beta/vaults/credentials/mcp_oauth_validate.md", - "sha256": "a17a67e12de044852c25b326cb480ab9c15f9815aa557a975402bc992b03cbbd", - "size": 4846 + "sha256": "e2b66ae76e3a864143094f8b54fe248745fc0954ac10013079c77126dc9fc820", + "size": 5109 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memories/create", "status": "success", "path": "en/api/python/beta/memory_stores/memories/create.md", - "sha256": "65f6dec1219ab8673925ce3eb5ee81b88b3918705a2476d4369180c53c59b0d0", - "size": 5203 + "sha256": "77fc2fb2a929da5854962b1c293902dc6b866912293ba6483a8a394c8092eafd", + "size": 5461 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memories/update", "status": "success", "path": "en/api/python/beta/memory_stores/memories/update.md", - "sha256": "b289f09b63dc40f8d66c271b365a7e15f75b57f3e623018e9f39faa9c0bb8161", - "size": 6134 + "sha256": "93bc4e78b0a6a73e0928e912fb11f16f3414a000333e75daa10fa2e7a1d623f0", + "size": 6392 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memories/list", "status": "success", "path": "en/api/python/beta/memory_stores/memories/list.md", - "sha256": "49dc503dbf88411a4ba6490ad1fd738c984ac8d1849646a8574a16dae564942a", - "size": 6759 + "sha256": "778a83b6d3373555b447a21f7ac38c54b0a8c04f349c3c2a351836ee6690de41", + "size": 7017 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memories/delete", "status": "success", "path": "en/api/python/beta/memory_stores/memories/delete.md", - "sha256": "a8060faea5d48412bc1303c0f9d1cc33c8ca5dcab0ebba78185d7c2626f1adba", - "size": 2759 + "sha256": "c0b48c61cecda6d556e54d386339345140f86d1804bdc8fccd6103829255fcfd", + "size": 3158 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/python/beta/memory_stores/memories/retrieve.md", - "sha256": "746ed1297e7b5cfee691c5943885e2385d0ca762710e3abeea46d00106991904", - "size": 4717 + "sha256": "fd2a265b6105bdbe90dd31151e166100125acddd92b4841089c4de1eef6144d3", + "size": 4975 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/python/beta/memory_stores/memory_versions/redact.md", - "sha256": "9c95197856ae6a9239f03485e0daf86463682e65034880d29ed9f344e1feb417", - "size": 7150 + "sha256": "eb07bcbef6e32d773aeda642bc5c9310a011f2facef75042a72996248398f355", + "size": 7579 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/python/beta/memory_stores/memory_versions/list.md", - "sha256": "2b470841e31b9858ac359c84e84cd96cc7aed5a26f3d49b6884bb5bec62c4a2e", - "size": 8074 + "sha256": "f2adad31da07ba97524a072e471314c90e418ed50f12fe8d471d6928be9fc9cd", + "size": 8503 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/python/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "25fab304dc5ec3f9de3c35a5c7b000ac79b1092f0e8dfae314c87b1d70caae7e", - "size": 7256 + "sha256": "d8e78159b324fe855f06ea46ca9c56b21eefbfce7be69770b00d4ea1d264bfb0", + "size": 7685 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/batches/results", "status": "success", "path": "en/api/python/beta/messages/batches/results.md", - "sha256": "c1105eda83c2164795e8f9d20499995617bfdca5dc02ee6a31702b9753cf19c9", - "size": 59177 + "sha256": "ac8842f897edcf14b4629d83405a7dcbe6d321ea35f0bda88f2c3731fc18cd03", + "size": 60399 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/batches/cancel", "status": "success", "path": "en/api/python/beta/messages/batches/cancel.md", - "sha256": "3b5025697ca7ccfb69d7c86775d7be92e9b3448297c9c75555f2b820025502c9", - "size": 6347 + "sha256": "8d772368778dfe5024833bb2ece413a882848e600b86d6b85d01913cc6d361ff", + "size": 6610 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/batches/create", "status": "success", "path": "en/api/python/beta/messages/batches/create.md", - "sha256": "62007c81a0a218fb14c2a082e2d39312a7ad5e7eb631023b14a612e7307cb93a", - "size": 135807 + "sha256": "5332157dfaa402f99eb1d6125db853e06fbac0ad11776d6af42215825843a79b", + "size": 136150 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/batches/list", "status": "success", "path": "en/api/python/beta/messages/batches/list.md", - "sha256": "4472a9188b7713037e8b9e9822bbe4a718238b1fc92f9768d1d9dee4565a2af8", - "size": 6438 + "sha256": "4887b8829a68c3d4ebf86bb0f60f76c33673f242b928c9b6c4e6f761667fd094", + "size": 6701 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/batches/delete", "status": "success", "path": "en/api/python/beta/messages/batches/delete.md", - "sha256": "b7a38e3358d0c78df327a5dc0e7958e1c99dc39d8c7ec058a7d1193f4c376038", - "size": 2778 + "sha256": "266d26cd357d3199c552cbdfea9426523e74584bccfac34343016b95b7d68c3e", + "size": 3041 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/messages/batches/retrieve", "status": "success", "path": "en/api/python/beta/messages/batches/retrieve.md", - "sha256": "75cd408c454ee8a8bb0ddf2d90effd8650d39d0efa6b8db50203464c20303749", - "size": 6035 + "sha256": "7a3dbbaa53ab0d16104b24fc684d87835090faf2415618f108b0397c5f0b4a37", + "size": 6298 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/certificates/create", "status": "success", "path": "en/api/python/beta/tunnels/certificates/create.md", - "sha256": "bdfe33989e5793e112c1779166090cdc3cdb402525f0158a6a0aded321e12f55", - "size": 3675 + "sha256": "dfa4d07c1737fd27be76aea0419681f92bc1e98b918f98dbae7b6437ad46cdfb", + "size": 3938 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/certificates/archive", "status": "success", "path": "en/api/python/beta/tunnels/certificates/archive.md", - "sha256": "73b25adc0c8d17627654469ea16442ddca69b4c7ce34411703fbdb6051764b49", - "size": 3598 + "sha256": "aff3d2ed01c93759cbfc6f3574b25f196032e38449478e99c4d7ebe8daa46487", + "size": 3861 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/certificates/list", "status": "success", "path": "en/api/python/beta/tunnels/certificates/list.md", - "sha256": "535eef0b14eee14dd31659cf1badbd3612e76aaf7219b0ceec2542df948252ff", - "size": 3795 + "sha256": "47ebf340e1ebca7db56d1789a2531d624216b5b713fffe6c1ae784a0a53f173e", + "size": 4058 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/tunnels/certificates/retrieve", "status": "success", "path": "en/api/python/beta/tunnels/certificates/retrieve.md", - "sha256": "4ea9355b0b35da56fab316f8b06f885199d9dd0bb16c89b2dccec9f2e08fdef8", - "size": 3375 + "sha256": "e1151009520610b1bc4fe41898e1ed20cea96b03863171cc24439c8ccb887c4a", + "size": 3638 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work/ack", "status": "success", "path": "en/api/python/beta/environments/work/ack.md", - "sha256": "1ad2fea4ccd5de785da0d6e5a5f9acdc83dea3f14ac9414ec8cba451b8cd7851", - "size": 4705 + "sha256": "8d55de0aea00dc305d8e3bc8cb9601119533f7db6d835429419f44643514ef10", + "size": 4968 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work/stats", "status": "success", "path": "en/api/python/beta/environments/work/stats.md", - "sha256": "cc2bbf320a23d35360157348440613a8b9da0800fddbd29360a8e5945badb89b", - "size": 3099 + "sha256": "fe91315e7ab483e34484a5dc42cce1eb143abb79bd296542e027f7348d6d3676", + "size": 3362 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work/poll", "status": "success", "path": "en/api/python/beta/environments/work/poll.md", - "sha256": "73b7fdc372fa77b6fbcd65dac7537c4ccc4266a6a16597cdd0fac2604657d9f9", - "size": 5117 + "sha256": "b776b96ad2bd08721760a50b7c27511dd377c1e3dcbd0eec8a312be87abe8bf6", + "size": 5380 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work/stop", "status": "success", "path": "en/api/python/beta/environments/work/stop.md", - "sha256": "91f93b3d6cafff5a44a7036cc699edca1b8b13fb1de151970c6c0bbfdf5d897d", - "size": 4751 + "sha256": "7a7b716f7d7cbef22173fb3838447baa48ed4bdf16530dde1afc0916745c35c3", + "size": 5014 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work/update", "status": "success", "path": "en/api/python/beta/environments/work/update.md", - "sha256": "a72eaba69adad9db01a731816ef4ed06b5e3ea6759184ca350186fb64930d80c", - "size": 4840 + "sha256": "96173537ac8a656acfe48c64eae1e005d3301ba89f12a15b1ebc437cf689a55f", + "size": 5103 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work/list", "status": "success", "path": "en/api/python/beta/environments/work/list.md", - "sha256": "630fdfa21e1c164050f4ae89ac3180039de932c9a507bb73f6183883ecc5c951", - "size": 4899 + "sha256": "3e5f510089c3040e8cf215a874e6881b3758cf180e86f6850687c3ba08dddf5f", + "size": 5162 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work/heartbeat", "status": "success", "path": "en/api/python/beta/environments/work/heartbeat.md", - "sha256": "e3961b46baf32fd3dd7b62e25ec06fb9fefc43b0ef93d0ef8d9777f15bece4e3", - "size": 3738 + "sha256": "a7a886f762f4bd34ff3a76a89fdf1b9bdfcef547f4a9ac2975df1b46dc243199", + "size": 4001 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/environments/work/retrieve", "status": "success", "path": "en/api/python/beta/environments/work/retrieve.md", - "sha256": "58e93cc0aec7b1f8d6420a8d94d266b0f816718a13f155547e12614fe5a435aa", - "size": 4652 + "sha256": "2b8f06721411f7777783fd8e3ea2b09f3806d57cc956c526fad0fc3b5550fd45", + "size": 4915 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/agents/versions/list", "status": "success", "path": "en/api/python/beta/agents/versions/list.md", - "sha256": "f475f4cd8cf7ee08d4ec11246dc708e1af7c9a79fe906360d06f0bf43e62c547", - "size": 18325 + "sha256": "55cae9bc591438216f01945c8d3a9f920ee14bed2c232cc39a1538f59362890f", + "size": 18588 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/events/send", "status": "success", "path": "en/api/python/beta/sessions/events/send.md", - "sha256": "52c9b76acad8cc41f8471f2105b0be64d2d82b7578510a01eb7791c544a404b8", - "size": 24011 + "sha256": "7a989987138594c3e70c2c88c4cd06e70228e7575b4653db84d579dcb2d23702", + "size": 24274 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/events/stream", "status": "success", "path": "en/api/python/beta/sessions/events/stream.md", - "sha256": "e6fea855934a351ca4b663699f5a6b6a015443f55f238dd9ba1d008c6729a231", - "size": 66963 + "sha256": "f49ed3098b5a160e42dc7c6714d44f1b38388e7e90613ca0a8441fde82be5bac", + "size": 67226 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/events/list", "status": "success", "path": "en/api/python/beta/sessions/events/list.md", - "sha256": "c5363186c6a04dc509cd9b07deb94f5253b560243d17f51da6f350df92c371c5", - "size": 65004 + "sha256": "21aa84b66baf7f3548fd507f453a5a8e5947b7aee52e558690cea4b54d1ed319", + "size": 65267 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/resources/add", "status": "success", "path": "en/api/python/beta/sessions/resources/add.md", - "sha256": "1b98cf3a57f126f81b12aaea686f2a0607f42f3e855d59f5e4e60138e633f878", - "size": 2986 + "sha256": "5151afd2f885cfcc6feb18e2db7c35257f46b966b1eb5da1972113857f6fb085", + "size": 3249 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/resources/update", "status": "success", "path": "en/api/python/beta/sessions/resources/update.md", - "sha256": "57de28d5c593de51eeb7e39b8b7066898313a97a15a445bb8c962327bc9ed28f", - "size": 5053 + "sha256": "6c33aa839dacee08bf5b35e2ae1765dc59aed68756d9e30975911e23a6798325", + "size": 5316 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/resources/list", "status": "success", "path": "en/api/python/beta/sessions/resources/list.md", - "sha256": "b444cd176f9f3955ae73f0ae83c7eb385896336831936b47174de6dfafa15044", - "size": 5409 + "sha256": "053786351cd4b0547acbd3a156d8242b283e93ad1659820f3f27b6ccc5da2774", + "size": 5672 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/resources/delete", "status": "success", "path": "en/api/python/beta/sessions/resources/delete.md", - "sha256": "c80e2e69616f8fc7673bc121b2380503db97529d4f5fce57f173233f2016c133", - "size": 2503 + "sha256": "32c33e2c843567af2f052880b24207f8106c306d4e1645bb843152b1c4a71ab5", + "size": 2766 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/resources/retrieve", "status": "success", "path": "en/api/python/beta/sessions/resources/retrieve.md", - "sha256": "6abe130f34ec894d556ff56ab17a8dde2aa0b9644b1f6847c5e552d7d81c095a", - "size": 4835 + "sha256": "c7431d2bbbe724e1bdd865f31cbf07693faa3e18d653a4f6efa8ec7d288d7894", + "size": 5098 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/threads/events", "status": "success", "path": "en/api/python/beta/sessions/threads/events.md", - "sha256": "cb0d8596336ac7fb7ce445a6d3e1a2da8da8c4856eca26643f0270cb8afaedd9", - "size": 130856 + "sha256": "36af9c0e086ecc63d269231e7786b2ca2b716e7e85cd5f40864d2b19952f8050", + "size": 131382 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/threads/archive", "status": "success", "path": "en/api/python/beta/sessions/threads/archive.md", - "sha256": "31091f3541703347179238c1866e44ee8a9d510ff2e5dd89cfe0e87da3804e59", - "size": 22237 + "sha256": "a7281c7b43e083909b89a00d1f2131db93db8dacfec1c25701dfb3608ff4b40c", + "size": 22599 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/threads/list", "status": "success", "path": "en/api/python/beta/sessions/threads/list.md", - "sha256": "1a358384cee9fa024a86a01ce0d67102158bb9073a3fd701165829c54ef5a020", - "size": 22719 + "sha256": "8ca2911cf261ef1ec4a43a6ede8b2b3e956eafb74e4e257ee9dd0ee842d91ea6", + "size": 23081 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/python/beta/sessions/threads/retrieve.md", - "sha256": "8f86c902aff697a4724f443caba86d0c1a27993e32d25a6890b30f6af07c22c5", - "size": 22222 + "sha256": "9f0a33e4827c4e15670d27d712eb04373a288c8dadfdc698260056f75f844ecd", + "size": 22584 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/threads/events/stream", "status": "success", "path": "en/api/python/beta/sessions/threads/events/stream.md", - "sha256": "a1dd6eb399b216b68aa660467accd014857e839b894e4357286aa8481f694ba1", - "size": 67118 + "sha256": "bbc923c0adb2e61927493afeba11f7e220c067c73e7032264438cc30a7bb4a9b", + "size": 67381 }, { "url": "https://platform.claude.com/docs/en/api/python/beta/sessions/threads/events/list", "status": "success", "path": "en/api/python/beta/sessions/threads/events/list.md", - "sha256": "50a8beb2273bdbbc380205c5441406643d8dd1d013c7e3f68b6204259e42a3c2", - "size": 63717 + "sha256": "dcd73fe910097de02241881021899e94118d6c69df943dbb23a73175f954ca9f", + "size": 63980 }, { "url": "https://platform.claude.com/docs/en/api/python/messages/batches/results", @@ -19693,15 +20211,15 @@ "url": "https://platform.claude.com/docs/en/api/csharp/models/list", "status": "success", "path": "en/api/csharp/models/list.md", - "sha256": "ab58c3121fadc63985c248a26978a8ecd8e152ab370e045d817128ecc205065c", - "size": 7722 + "sha256": "aec037886ab9d86309aa8120568b33da9c10db08b2d6662c5b717955e862a47f", + "size": 7956 }, { "url": "https://platform.claude.com/docs/en/api/csharp/models/retrieve", "status": "success", "path": "en/api/csharp/models/retrieve.md", - "sha256": "363ae9fb4fc29fe6796eaee96e82074ab69a1be2f08b3b688db1d558f44fe38e", - "size": 6374 + "sha256": "a452e5cd1c34fe342364189bf60ea045306f61baf4a0f078b405cc604bf28270", + "size": 6608 }, { "url": "https://platform.claude.com/docs/en/api/csharp/messages/create", @@ -19728,22 +20246,22 @@ "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults", "status": "success", "path": "en/api/csharp/beta/vaults.md", - "sha256": "d8631f5ed9613b3cb9fd8c4e278354b2fc0d4d039cedfa84def3ba09f5fb3a37", - "size": 66219 + "sha256": "eba958380125757fe3abeebcd40b388d93c8cde684ceec57c5e9e7e9b8b36e17", + "size": 69261 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/user_profiles", "status": "success", "path": "en/api/csharp/beta/user_profiles.md", - "sha256": "8107cc4e38ecdd8931b772d9b63e4645534e6b70fca797b1fb01e23a4352368a", - "size": 24759 + "sha256": "60a16769561dad6f2d244f10c8158432d525e8dada4de12aba3dc5196f3b2418", + "size": 25929 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments", "status": "success", "path": "en/api/csharp/beta/deployments.md", - "sha256": "3206eae65e01e01a3413b9c3ca767453bdf78a2ab4a5952e24e4822a14860f41", - "size": 198298 + "sha256": "823d9169b958d8cef07f1c4b81f4461e23f085518ad799504a70fbbb3a65c3c3", + "size": 200170 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/webhooks", @@ -19756,960 +20274,960 @@ "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills", "status": "success", "path": "en/api/csharp/beta/skills.md", - "sha256": "100ecef9e03c92b4eda8838c5982ee73280aff00d19619969d033533847c5c1d", - "size": 28031 + "sha256": "56cfe50b3335e6952e5d4cd4bee0eac8e5f13ea7bb5211d331a1dd8d88d17a43", + "size": 30137 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages", "status": "success", "path": "en/api/csharp/beta/messages.md", - "sha256": "3a6d68f1c15e29d2894a307358a7b602a6586a33c33856f9d22cae429769b750", - "size": 1179205 + "sha256": "6f36afec8bd310ad639f152a8243e186d520bd9ebc436dfceb577e4647cc6160", + "size": 1190837 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/models", "status": "success", "path": "en/api/csharp/beta/models.md", - "sha256": "5855bea4785830b43c2fdf888249eb32e40dfa8ba05da1de157d318cd19d31f8", - "size": 23715 + "sha256": "4e852800055fc74506d204a612eb9b7ee47a64d0288ea0551c99cab4e09f1ab5", + "size": 24183 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/agents", "status": "success", "path": "en/api/csharp/beta/agents.md", - "sha256": "6211b68106cba0bc867e505949983659e5683437d1a2f80bfe784e549f07b4a2", - "size": 229879 + "sha256": "38855eb9ed8cb6680cb3fbfd436f53ebedc940056aee251ae2c40501cf40fbc8", + "size": 231283 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/files", "status": "success", "path": "en/api/csharp/beta/files.md", - "sha256": "e255451b6fb74293be721503d6029dc2fd8c08f2bbb94776cd41b837f98f0555", - "size": 15392 + "sha256": "9bae6f37b7d5ed6db78a16344289cd8f09f74b076c3200fc94cd9e1cbdf8803b", + "size": 16562 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions", "status": "success", "path": "en/api/csharp/beta/sessions.md", - "sha256": "b6b7472e56b95f19b0881a40d419a3a46a4ec2f149417c1cabe54b125cf90dc5", - "size": 672312 + "sha256": "a61cb8d8342c9a12744c9d49fcbb674c5180b8ba34c2985052a802204e31d8b9", + "size": 677055 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployment_runs", "status": "success", "path": "en/api/csharp/beta/deployment_runs.md", - "sha256": "1451da1d9677bbc8398f5daa5e210b4bf107e4ad14a37f7ceb8a2d05e976d6fa", - "size": 28294 + "sha256": "530223a872efb47f1928e4089c3bad7cc1e652a60b7c14798c7b562c760e95bc", + "size": 28762 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores", "status": "success", "path": "en/api/csharp/beta/memory_stores.md", - "sha256": "9dc77240688a6001e63b9d89ff25f696e3017df37db138bf4f35be43bc4d7f4e", - "size": 71082 + "sha256": "d96065a340c3450d3cb40c04655a8cb0e262a8f2e1c13c70855cd52236099f0b", + "size": 74851 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels", "status": "success", "path": "en/api/csharp/beta/tunnels.md", - "sha256": "f5eca8796cbdfbd488aabeb1416d5c826f5dc16e402cb1cf1a281c1b7f43b79d", - "size": 33595 + "sha256": "7d044b066041c24490a80aa7bb74504b7a9e588ba8b83f54aceb8bc584c4b751", + "size": 35935 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments", "status": "success", "path": "en/api/csharp/beta/environments.md", - "sha256": "c365224b3a2ac408c7e26660b82c553220753b02bbdaf52c2715ea6c01fd49f2", - "size": 81556 + "sha256": "425fb5f08f2d44210f73335a9da445c240b9475a320a8eb6eaf0d5055787a2e7", + "size": 85438 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/threads", "status": "success", "path": "en/api/csharp/beta/sessions/threads.md", - "sha256": "61e34b713cb0de7ef05c5ac9b4b0d1c86fe76c9287fe8532bd6a7b805efa9410", - "size": 274224 + "sha256": "21016081ec71510dde1b241c92d9dce2096abdd2a1ecf19061e1c3cac3faec60", + "size": 275790 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/events", "status": "success", "path": "en/api/csharp/beta/sessions/events.md", - "sha256": "6307364e8a38047abd056227c637edf7a36eb28db5d8bc6e78fb8f073aa59f4e", - "size": 387789 + "sha256": "4921b87d19cec82e8c4f3cbde6ba6a018a76d803ef92e18b72d5d1feff50f1bd", + "size": 388491 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/resources", "status": "success", "path": "en/api/csharp/beta/sessions/resources.md", - "sha256": "25a1ece7bad7723200f862dbaace7c45f4bdc88168bea6e9a51669dac7b79eb7", - "size": 25256 + "sha256": "ca5298e29271b6fcb8ecdd8c307271eff7b67da0ad25c8d70e7b894eba4b4377", + "size": 26426 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/create", "status": "success", "path": "en/api/csharp/beta/sessions/create.md", - "sha256": "e6d8eaac1939083d5f8e63ae54f102812507bee0c518528f9f0236c33288912c", - "size": 57636 + "sha256": "17560d243195e0c840a116f111a466d5cfb5136807575935f8b0ac8d1f2b9a6c", + "size": 57870 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/update", "status": "success", "path": "en/api/csharp/beta/sessions/update.md", - "sha256": "e6a64883a4d63f54bbe763006f867fcbb0a1bfdf5cca6a84cd9c8563694eebde", - "size": 29991 + "sha256": "f6815994c239487c29581ab454a3e11b0b71eb3025f97774482cd0b37c2817ba", + "size": 30225 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/archive", "status": "success", "path": "en/api/csharp/beta/sessions/archive.md", - "sha256": "2f3c12556f0281f07a212fedd47f4f34aa7efec237c9a5a1db112342959f6440", - "size": 29040 + "sha256": "f0a36d46127ebc68c4c6f4a76c809e84d88fc96044540833337388e2f5d5d0c8", + "size": 29274 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/list", "status": "success", "path": "en/api/csharp/beta/sessions/list.md", - "sha256": "c74e80a42111bd24b315341e644e7ed01d43cfd056fd4d928e78e16c030c9a40", - "size": 32535 + "sha256": "3ff4bceb4920f7ac93ea67f08c468ead815064aba095ada039fc950e1d162bf9", + "size": 32769 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/delete", "status": "success", "path": "en/api/csharp/beta/sessions/delete.md", - "sha256": "2d70745b60a28563f25c3a1a0278cd9fc61d109ccb02985eaf64c9f585d6038b", - "size": 2060 + "sha256": "e90b9e35acab5faa6cc8bb529107285ed36b7638366f8e79cf325fe96e45317c", + "size": 2294 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/retrieve", "status": "success", "path": "en/api/csharp/beta/sessions/retrieve.md", - "sha256": "cbb4c722cbea489a947f629a919855e4b510b8519d2007aa1928c05772163965", - "size": 29027 + "sha256": "e3a08bf4a9ff80a7f2a1fee11c8cd59eba45202c6987f790bb726ab02d8ac2df", + "size": 29261 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/agents/create", "status": "success", "path": "en/api/csharp/beta/agents/create.md", - "sha256": "c926e968c46485d530bf5cf6382b9f5cd6820271e3972619781dfe5188f38320", - "size": 35182 + "sha256": "cf673f19f939cf8d2f9cc9fd5547ef053a2f6cab1ae9a9a8174f38be056b84e9", + "size": 35416 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/agents/versions", "status": "success", "path": "en/api/csharp/beta/agents/versions.md", - "sha256": "eb371459039eef1fa2637680153cabc7d583cc76672139fd6798ef56febf53d7", - "size": 17542 + "sha256": "f3a3da641ebe82ec61c905d9d17122039ef240ff2d00f7561fc5adee96070e7c", + "size": 17776 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/agents/update", "status": "success", "path": "en/api/csharp/beta/agents/update.md", - "sha256": "a1570ca23132c3c9bd197ddf5d7cb9f285fb4a3de156256c8d760f5873007c7e", - "size": 35968 + "sha256": "209609b97bdcd494a99abe10a4874c53f8c80a26ec24866561170f8e9d7a71e5", + "size": 36202 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/agents/archive", "status": "success", "path": "en/api/csharp/beta/agents/archive.md", - "sha256": "68bdcb39ed172fedff87d31cadf99892d90f54b6f66179c02192246fe6d53ff6", - "size": 16263 + "sha256": "aac052a617e620d4664b83ea897e2583d419770233df4d5fa0a5834c387bd3c3", + "size": 16497 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/agents/list", "status": "success", "path": "en/api/csharp/beta/agents/list.md", - "sha256": "3009b6d09cf790f154cf7e792796a5234ee9a3cfa95a711b94a3e5e50fc1d1fa", - "size": 17725 + "sha256": "e3c2465235f855db63b34fcb491e0e1ca550ef7f0f178fa98b43740ecf82e2e7", + "size": 17959 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/agents/retrieve", "status": "success", "path": "en/api/csharp/beta/agents/retrieve.md", - "sha256": "12a72f58025551dce505aa158e0531587f9697d49ac15a2944d7a2248bdc5036", - "size": 16414 + "sha256": "de140305e2b953d01ac152c4c60b75dfa9fce9ab3dadd0528a8d0c27b51759e4", + "size": 16648 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work", "status": "success", "path": "en/api/csharp/beta/environments/work.md", - "sha256": "971dc4d87916be1c1d862f4d96a7d6face83feb77405625a140c15596d05a995", - "size": 39940 + "sha256": "42f2a144b6c1ef0f9fe70903e3294b589de3e2f3b1c2bb4b548ad954f80a4e9c", + "size": 41812 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/create", "status": "success", "path": "en/api/csharp/beta/environments/create.md", - "sha256": "bd72611b64b98cde431982c817824810f45cf12fc3af8ee9bb3e7abcbd75d269", - "size": 8653 + "sha256": "91df145f69753ffd794f599be4caf0378fb893e7dedc381b77fa408c3e11977c", + "size": 9041 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/update", "status": "success", "path": "en/api/csharp/beta/environments/update.md", - "sha256": "593cf5a5d26240331e6a99425b3e4f4be7c905eba26b8a0331bd88837ac1028b", - "size": 8766 + "sha256": "dba7a726c44c06e160677133c522d0e2bb86e6a6847d70c4fc91a99fd9eb5c13", + "size": 9154 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/archive", "status": "success", "path": "en/api/csharp/beta/environments/archive.md", - "sha256": "59d92f826f4253cf604da6a94adf10c75ba6066489e0220370e3422bc2069d62", - "size": 5675 + "sha256": "8077b8e7035bb427317ecd0f7400240a1bfa4e561df3aa8d45bc8f02ee544d88", + "size": 5909 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/list", "status": "success", "path": "en/api/csharp/beta/environments/list.md", - "sha256": "689f10802507d4bdfa831f2d78290d06cc932c2230398c06c785c2263cbf5ffd", - "size": 6662 + "sha256": "fae82a516c6f86d9c6333b2fffd1a6834c5a7433d719831176cdf5a541cce36d", + "size": 6896 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/delete", "status": "success", "path": "en/api/csharp/beta/environments/delete.md", - "sha256": "6c61322360459a939d978ac0d5b51e6fea3ef421236f65f91378001ea3ea1a86", - "size": 2147 + "sha256": "6cebad3cf18953327abf05433272b1b97a2a0d114868c9a1630babae91ba1549", + "size": 2381 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/retrieve", "status": "success", "path": "en/api/csharp/beta/environments/retrieve.md", - "sha256": "2e1c0fa1eccc5987b00436f2c57b9c36f397f2b0dc214baa296242c564bb2785", - "size": 5614 + "sha256": "603fc00f62d73529214841e2992256007c160f35a777748c0647f50600d6eb61", + "size": 5848 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/models/list", "status": "success", "path": "en/api/csharp/beta/models/list.md", - "sha256": "6154101c57380760c3569192d7778f296969a1f2ea553da980a336bfd9c5ce76", - "size": 8115 + "sha256": "b21be77417f7c8782cd28c89825e0728538fb58798e3fc6e30c75fecc23422d3", + "size": 8349 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/models/retrieve", "status": "success", "path": "en/api/csharp/beta/models/retrieve.md", - "sha256": "7c6584ab5c0ea10a1d0363cac76ea098810ac638a61f89e7d8b03003a5fd097e", - "size": 6763 + "sha256": "b2900d487068fc0ed696e4840c43bd35074bd90995f110584dd4c4610a7b5384", + "size": 6997 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/reveal_token", "status": "success", "path": "en/api/csharp/beta/tunnels/reveal_token.md", - "sha256": "7d026e24192f9647675f735105085ec017645d804fd759f2c536d886e48d0a5e", - "size": 2671 + "sha256": "0bd10d5591602327b420cd6b8d0de51ec32354097c5193db13b22aa9a4b0abbd", + "size": 2905 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/create", "status": "success", "path": "en/api/csharp/beta/tunnels/create.md", - "sha256": "d99eb474b705ef33d3ddb3781ceb117e577e5e1137f1fa755ee12e75a2499851", - "size": 3112 + "sha256": "cf8575494bc59074dfe854ca2f331474f46e3e50f6d34d74eaef1a4120fffc45", + "size": 3346 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/rotate_token", "status": "success", "path": "en/api/csharp/beta/tunnels/rotate_token.md", - "sha256": "1a7c147eac289ed552dd0aafa3c4621577c6c0b66234b0dfcc641434668c7a93", - "size": 2801 + "sha256": "407883f20d797f15868a98056ddb9a4959d05d689b943d3f11f5ab3e86f047bc", + "size": 3035 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/archive", "status": "success", "path": "en/api/csharp/beta/tunnels/archive.md", - "sha256": "7009b38ffb29118d870f4fb42ab1b021720a663d3e7bd5581b9201952226d145", - "size": 3181 + "sha256": "45a63b97717ebf7dac5fc70a3971add26371f32c8679df4efc3b0a6954d6a2b9", + "size": 3415 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/list", "status": "success", "path": "en/api/csharp/beta/tunnels/list.md", - "sha256": "7a3b6dfe89f3b4a4d5fc8e431c2137c90925b03d085d9cfcb2dc1ad15bb92f12", - "size": 3646 + "sha256": "c1671ece51393dc80893c1029297866bde1e47630860c4231369022c4e5118e2", + "size": 3880 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/retrieve", "status": "success", "path": "en/api/csharp/beta/tunnels/retrieve.md", - "sha256": "b7e435630bec316d90a2785a0aee08490b6550969123e47e1993af54138b4279", - "size": 2903 + "sha256": "48b463be2310863fa5af8816d8beb653d500bc26643ba071e6fbbef7ffe97602", + "size": 3137 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/certificates", "status": "success", "path": "en/api/csharp/beta/tunnels/certificates.md", - "sha256": "d8ba51c0c3932229b02ad7fcfb639ef8258eb67d36f5b29ae192f8e2d57b2bb7", - "size": 14876 + "sha256": "59fdf6bb6765346253a9cae14bacea88975e60eb39ec618e06b3c8743458739b", + "size": 15812 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/create", "status": "success", "path": "en/api/csharp/beta/messages/create.md", - "sha256": "3c55d7c46814f885fc74f1c7724c3515f2e4d95f0d8c1b90004659c898f87823", - "size": 164713 + "sha256": "07824354b14e1eef227b8f203b405d332231862b58caf00f1b5c0d34544bd8de", + "size": 166855 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/count_tokens", "status": "success", "path": "en/api/csharp/beta/messages/count_tokens.md", - "sha256": "7b405fbf4073fadc6bbfcd1415f6987c0bd5461901d6e9169983dc9fd54b7d1b", - "size": 104941 + "sha256": "e0ad32e0f890978703f332349e783632256051850e259b73907c3e69a8406f4b", + "size": 105175 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/batches", "status": "success", "path": "en/api/csharp/beta/messages/batches.md", - "sha256": "1b717ecfeedada83ca1a074ab482f5900c1e96a17df85214a70312d5e36a4348", - "size": 359213 + "sha256": "339fecba67f06976604438dc7d01ae0b9fef4821bcda8b0c88ba5e285809660b", + "size": 364505 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployment_runs/list", "status": "success", "path": "en/api/csharp/beta/deployment_runs/list.md", - "sha256": "19f86d1870da57a8fbf77c412534328c0797268320c0f026dc20d6fc628620a8", - "size": 9338 + "sha256": "caca0d7c2f53d6712d218f93d909c182af580b69bd4056acae18475c361e34f4", + "size": 9572 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployment_runs/retrieve", "status": "success", "path": "en/api/csharp/beta/deployment_runs/retrieve.md", - "sha256": "48f64c3de9d15e05992b042622196267e52b489623e42fefcecbee2e132a19f7", - "size": 7760 + "sha256": "8a51c8a0f7b4861b7690af5e73e03ee2ef53ed466cb26f8831763a7fd3582f73", + "size": 7994 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memories", "status": "success", "path": "en/api/csharp/beta/memory_stores/memories.md", - "sha256": "ac61a180eaace03bb9613f6cf746d68826f5fefeba6a4607b0611e322be7024f", - "size": 35405 + "sha256": "f38e1a968c6bd753f8a87dca2208116ac9f52ec4815d7bd51c2e4e2647b850cd", + "size": 36817 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/create", "status": "success", "path": "en/api/csharp/beta/memory_stores/create.md", - "sha256": "fe183098561e6a73ceccce9bcbb77fa618dced9a1ed8aadddcd15ed642dabc42", - "size": 4276 + "sha256": "a30bebb5c46942eec23d985635fee2298e4ac9c793d2221b06ef2ea8f84fc975", + "size": 4510 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memory_versions", "status": "success", "path": "en/api/csharp/beta/memory_stores/memory_versions.md", - "sha256": "7f5e672324b2bb01d5d738ba5ea448664aff7d85be6a08f1bd6c9fc03f2b6229", - "size": 29736 + "sha256": "c12f2b080c3645f8a8a59f0d363983175e0b06deb59061111709f51c39961c52", + "size": 30981 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/update", "status": "success", "path": "en/api/csharp/beta/memory_stores/update.md", - "sha256": "5b9c11c611de84e9bdbfb9c1ef01a9323b9f28a4467b23193579bf73ccdce52d", - "size": 4237 + "sha256": "ca53464bf2dd6c1e2fbfec731a10687dd61127f6a80ee7f1608ee1849607c276", + "size": 4471 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/archive", "status": "success", "path": "en/api/csharp/beta/memory_stores/archive.md", - "sha256": "0c55d1a55082d2e9dcfcc73b88447ea1e9e0d86edfebe9c9f424105c77b6f09e", - "size": 3558 + "sha256": "8c7e6d98918a458675c5f63c35e3ab3db23f11deb643400470df60772f2f96af", + "size": 3792 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/list", "status": "success", "path": "en/api/csharp/beta/memory_stores/list.md", - "sha256": "2143635fca084a162ae87f3e99b226f9a16a3ae976b93759df43e75d69cffb9d", - "size": 4639 + "sha256": "3a24e1b5e0e1b4a4273e69cf99d990a0e116247db4974dd447980e6d0fdfbacb", + "size": 4873 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/delete", "status": "success", "path": "en/api/csharp/beta/memory_stores/delete.md", - "sha256": "0c8cf19947624dd257eb65172c14da27c4f144382a43937d8d554136a0fe48ba", - "size": 2219 + "sha256": "37b6b4879a2702af424095a4e9173c914cd1e1d6887689af5ee64ee3e5979b7a", + "size": 2453 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/retrieve", "status": "success", "path": "en/api/csharp/beta/memory_stores/retrieve.md", - "sha256": "736d16740ac1cd75421d33ec4568c9f5d9dca89b495ad021a08d126d8e24a6c8", - "size": 3555 + "sha256": "703a3a729c3a066beeedd08b9a3fae8bc4c8474deed2798bca41aa18d0a0d3fb", + "size": 3789 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/user_profiles/create_enrollment_url", "status": "success", "path": "en/api/csharp/beta/user_profiles/create_enrollment_url.md", - "sha256": "23febe73328af2b62a4e08678d70a1222bb204d78858fd294b400cffcb948b02", - "size": 2403 + "sha256": "405f026faa927bddf590026cd5224b0f40d9c286c0216fda2c08df913e93dfae", + "size": 2637 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/user_profiles/create", "status": "success", "path": "en/api/csharp/beta/user_profiles/create.md", - "sha256": "d02261d21cd7e1301b25c6cf8d70f948db016d549009687e233369e44f129d1e", - "size": 5459 + "sha256": "d13bd330fb0bcfdeac4b35c79b60a4bbcb492d4db92a3caff3220172aeedde86", + "size": 5693 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/user_profiles/update", "status": "success", "path": "en/api/csharp/beta/user_profiles/update.md", - "sha256": "d18808ae6d7fa6e84a59c918ac5f874ff9a32ab013aa9c237fbf1e17f99eafc4", - "size": 5562 + "sha256": "1ff61228791926088a5e1da757ed4d511d7a090d6e3c438e9230c5b1aedc494c", + "size": 5796 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/user_profiles/list", "status": "success", "path": "en/api/csharp/beta/user_profiles/list.md", - "sha256": "30eab9f80ad4c91661f481082c7325406a248a87874371b5c74225cb56b1118f", - "size": 4655 + "sha256": "0c627feb47fbc566ba6b5f96809a4ea1c37cd2a1ac1f299586f95653cda60fe8", + "size": 4889 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/user_profiles/retrieve", "status": "success", "path": "en/api/csharp/beta/user_profiles/retrieve.md", - "sha256": "09c8a3bbe61ab817365abd3801777ff04f478a930d6866e65582b961676d03ab", - "size": 4125 + "sha256": "b79d1c18b4c33ff0b69ac17b957ceae7689dacd6e1a00b988e4c7b1692aa83f6", + "size": 4359 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/create", "status": "success", "path": "en/api/csharp/beta/vaults/create.md", - "sha256": "186e4e3fed501af8d787bcc7090d274cb3368e9329b37e4521b1258f691a0313", - "size": 2971 + "sha256": "a25015b04672163cc63e4bcaeeb7ef50c7d3ea4d9f1ad22b0d92690b3df92282", + "size": 3205 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/update", "status": "success", "path": "en/api/csharp/beta/vaults/update.md", - "sha256": "d172d790ac9d2f650ddf05ffe1c32ca1c9630493b220c3276b8fecea4ca069d6", - "size": 3059 + "sha256": "2894ff9422bd3dff29b08f164a84e7f89c8953603020b038806a01bf1a4d619d", + "size": 3293 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/credentials", "status": "success", "path": "en/api/csharp/beta/vaults/credentials.md", - "sha256": "c325c843a8544eeaad5b4725e9ea59df4051e64c9cc5d98641e8627597abec05", - "size": 76675 + "sha256": "413414440ba7bd8436ebaee5f3142c91c5f1d131ed7e15d6755694ddbbea8edc", + "size": 78313 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/archive", "status": "success", "path": "en/api/csharp/beta/vaults/archive.md", - "sha256": "225f46ba16ffc488d36b75c663d6804dc2b97c2e33cb2117d55091fb78d4dadc", - "size": 2733 + "sha256": "d729c17e8a9e91c4de5589f228e76ddaf92a7d99bc0feb2d6a9079f0b5d7cd29", + "size": 2967 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/list", "status": "success", "path": "en/api/csharp/beta/vaults/list.md", - "sha256": "908430971fe572561291ab84b04b0039b6c241173b90ffb3700220995287e24c", - "size": 3234 + "sha256": "fb9a5d5ad34d5e5584cb1ca0cfdb8a975e1c03586d7e331ffe87bb0564296e01", + "size": 3468 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/delete", "status": "success", "path": "en/api/csharp/beta/vaults/delete.md", - "sha256": "38ceb46dfd4a5caa00d16476ba2aa2ddba4b7c3a7122442fcda81679c22a68d3", - "size": 2044 + "sha256": "46502e39263af527c4aa28f23889e59717348f6ddd07b44a13c18d5212f29fb4", + "size": 2278 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/retrieve", "status": "success", "path": "en/api/csharp/beta/vaults/retrieve.md", - "sha256": "e23fe72a22e06564acb0e7588872581f9b4bdcca8b66a3217aae9c3d327cee19", - "size": 2720 + "sha256": "58c6e86e0b0fb00005799cd7d5923d5f86c391b528b176d90b6e2d48ec42eb4a", + "size": 2954 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/files/retrieve_metadata", "status": "success", "path": "en/api/csharp/beta/files/retrieve_metadata.md", - "sha256": "8a33eed0700fb66ed0844245e219ad91fb4744605b7f5a6ea8c81a361895e4b9", - "size": 3056 + "sha256": "9921a9591c0b47f0e808dc2d81b61d6a5507d147af36b6a3c653db14ae903e52", + "size": 3290 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/files/list", "status": "success", "path": "en/api/csharp/beta/files/list.md", - "sha256": "88955f8fa25ab15a5941128e604b4776d5e6b02441c69c311ff18e31a5bf01b5", - "size": 4122 + "sha256": "9450fd1be574743e132a8f3426a4e86a65314837fca553dc2295338d48e0016d", + "size": 4356 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/files/delete", "status": "success", "path": "en/api/csharp/beta/files/delete.md", - "sha256": "636d9969e030ebd13798191bd35f7e347d11aa0971a7901a4d5d7bc91d8d58f0", - "size": 1967 + "sha256": "fff298b9f4c3d7962eed2ccdbd0563e3e9a13a96c32eac58166e296a8e89b447", + "size": 2201 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/files/upload", "status": "success", "path": "en/api/csharp/beta/files/upload.md", - "sha256": "e9a0ad660fe313471fe8c4bf9ce2fb97309d883ec85abed8ba9a5c080083f646", - "size": 3073 + "sha256": "8eddd6f2ba7d12380df3fff5af8fad38a9a6965d1300cd58d11c3988a4301c00", + "size": 3307 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/files/download", "status": "success", "path": "en/api/csharp/beta/files/download.md", - "sha256": "9c83d313bf12753faa00221b35f99775a9ecd8301d9d2ede7544fa07843b8eff", - "size": 1669 + "sha256": "b1eb6235c89876934a6a615d3662a81503e474b518ae6e750c837884a8c8332c", + "size": 1903 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/create", "status": "success", "path": "en/api/csharp/beta/skills/create.md", - "sha256": "fd3435bd558658ce2223cad509210adfea8e049948016be52d2975b7b068cec5", - "size": 3304 + "sha256": "0032df7c06fa46d4c5a92691ced0fc4bcffc3d799416ea8bd4cab1873407bc93", + "size": 3538 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/versions", "status": "success", "path": "en/api/csharp/beta/skills/versions.md", - "sha256": "245e023b830a87c3789ead2bfdcf4d38399dccf001a1b6f2660c72a4d56e7d5a", - "size": 15462 + "sha256": "a46db3995d4c39b6d76c45e167ab32cec038af5ba03398f3743522b6b930b628", + "size": 16632 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/list", "status": "success", "path": "en/api/csharp/beta/skills/list.md", - "sha256": "e2f636b5eb8dcb9a0499775744caaf5be6c4b108312a4635dae3ec7812a36578", - "size": 4087 + "sha256": "26c87878a9b69c91eecd53ceda4e67450a1bc575805cd314e996e66a94430fa8", + "size": 4321 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/delete", "status": "success", "path": "en/api/csharp/beta/skills/delete.md", - "sha256": "e4b9858ac74130df774d412833214b29b76fc7cc8e9761c66e21c21cd26230f4", - "size": 2104 + "sha256": "760705fcbeb559c5a8a98732ddcbfae158993fae24c8ecc46beb1ba9a52d7a5d", + "size": 2338 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/retrieve", "status": "success", "path": "en/api/csharp/beta/skills/retrieve.md", - "sha256": "e9f0136206ca44521adaea0e6eb78d06f86b05c523e7e967a0b5a205d369c132", - "size": 3005 + "sha256": "062e9b065632a8d792c8b3c3cdbeb54e726193181e5bf34e282f3a3eb10ab1e2", + "size": 3239 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments/pause", "status": "success", "path": "en/api/csharp/beta/deployments/pause.md", - "sha256": "b34a47013de2328da2a83c8a0bbff120c2a1b2ad55783ee9846fec543aff9c9c", - "size": 17108 + "sha256": "61837514750ad57226151f456dc024509c12f5dd3cb33eb6199f0d2303ffc63d", + "size": 17342 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments/create", "status": "success", "path": "en/api/csharp/beta/deployments/create.md", - "sha256": "9ced6dba1121f767621adc9a678a23c9ed74662bec1097b1f03517aedbe8b999", - "size": 27071 + "sha256": "bc57bb5b46ee675999c47c1d0c161d658b24a79ef3b83ed90f7c7962d0e94c80", + "size": 27305 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments/update", "status": "success", "path": "en/api/csharp/beta/deployments/update.md", - "sha256": "aae446d316653c09ae4e6de9a2b64e462c39caaf87e7098bd35dc6eae88e70b3", - "size": 26872 + "sha256": "47a661f73bfeb04934b57b960b7469a33600c70ece637eb289d9e918c419f359", + "size": 27106 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments/archive", "status": "success", "path": "en/api/csharp/beta/deployments/archive.md", - "sha256": "d688e1466d1dd0e5373d6933c23827b70f9c509f179e16ada8c8407f90a10b6c", - "size": 17122 + "sha256": "d612425a4898b6e4a9b914f68f78fbb4d17a34faf6eaec4b9a9c04b9b2ab6b75", + "size": 17356 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments/list", "status": "success", "path": "en/api/csharp/beta/deployments/list.md", - "sha256": "0dff460da9c4b1b06dbd695e4ed489a59e4397d68e0a1c593585e6841440fbe0", - "size": 18660 + "sha256": "ee0cd474eb00c6e77bfa11b1c3bd02a3540e0c2f820e709ffc4fa099506a796b", + "size": 18894 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments/retrieve", "status": "success", "path": "en/api/csharp/beta/deployments/retrieve.md", - "sha256": "7c823e92d2ae0a9595508b62c168043891441dab5e6d7a7da9caea2585e25a32", - "size": 17109 + "sha256": "d48f2ef5af1ecd7fb4189b39fe3ed6346e5c3f970a29b5931d3d2efa92a30ebb", + "size": 17343 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments/run", "status": "success", "path": "en/api/csharp/beta/deployments/run.md", - "sha256": "9baa540d4ab4504e71718d4c507b51cabe532f88c4622c4e9e1569d22cf80d60", - "size": 7727 + "sha256": "8cc44784db1d64bc8e5c654fe4c53545a393f754775ef8c8407f9bc75657a2d6", + "size": 7961 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/deployments/unpause", "status": "success", "path": "en/api/csharp/beta/deployments/unpause.md", - "sha256": "6458ecede8be4d5a692dc89c41d80452781600296ccf8028e1bfd6031432355b", - "size": 17122 + "sha256": "ec90a9644978f3113e07c8890a9e6580e0c04190c86532a38798b648b7addf73", + "size": 17356 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/versions/create", "status": "success", "path": "en/api/csharp/beta/skills/versions/create.md", - "sha256": "e9f99bb78682d9fd6e6fea69d63d2e0131e122ef2bbcb9497bcb52a61c9604b1", - "size": 3510 + "sha256": "fc591e5453354ca723b05fb8cda818ca4ed91133f3989bcee3428c4ab94a27a7", + "size": 3744 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/versions/list", "status": "success", "path": "en/api/csharp/beta/skills/versions/list.md", - "sha256": "63a701882fb28799f127887e99800b8525453cb2bfdf8290863c5d5cff0e7559", - "size": 3982 + "sha256": "7039c012874c6f170b6750154c0f391c1184eeec951488b90f087e9b4a856199", + "size": 4216 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/versions/delete", "status": "success", "path": "en/api/csharp/beta/skills/versions/delete.md", - "sha256": "814cb0030b62087108d8834269321071760df69f3079c046b63aefc17f8d5686", - "size": 2424 + "sha256": "12b77b90b02740285815253da626b3ada9eaefd1bba97d8b605e337ec6db82a8", + "size": 2658 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/versions/retrieve", "status": "success", "path": "en/api/csharp/beta/skills/versions/retrieve.md", - "sha256": "691cb77ea0e3c68e68257a723253049b10683fecbaad4a68333e8fce52fa8c7e", - "size": 3435 + "sha256": "3b7518c0c67df46451ee7d813b1e42515edd230cf4236da9d12154caba035fef", + "size": 3669 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/skills/versions/download", "status": "success", "path": "en/api/csharp/beta/skills/versions/download.md", - "sha256": "7e5b81e7ce10cf1becc05fa68ce9d22f5eea3179502946b8a745247b140d1fa4", - "size": 2072 + "sha256": "0f62de2b4bd8840e0ca983156d817dc7af5c92098195807b40301a577cdaec04", + "size": 2306 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/credentials/create", "status": "success", "path": "en/api/csharp/beta/vaults/credentials/create.md", - "sha256": "63e7c1c93017fb58cf59f70932951d58097f14ef0a0d0c2b3c66bd33af508004", - "size": 11227 + "sha256": "7f69a74ed5770ca53198af56835bda0f955b1ab7c7c0a19360f1c19b440ae450", + "size": 11461 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/credentials/update", "status": "success", "path": "en/api/csharp/beta/vaults/credentials/update.md", - "sha256": "621371c58ad5c016c2325bbb4798a6fe7bfd1a7167c782e2f28c3a63d32b3dc8", - "size": 10186 + "sha256": "5d8e982a2903096518bc7ea3a2cefa6b5bed4cab1c9ba1cc6c970cfb4932596e", + "size": 10420 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/credentials/archive", "status": "success", "path": "en/api/csharp/beta/vaults/credentials/archive.md", - "sha256": "4ed9e6e42857b0d9364d87a6c62a37b8c3fbcde35f22707dfbb7018cb5e9ebfa", - "size": 6470 + "sha256": "07e65b21266b856cba2eab1c7bdc14a450f23ec69d83ad533dc59311045c77a6", + "size": 6704 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/credentials/list", "status": "success", "path": "en/api/csharp/beta/vaults/credentials/list.md", - "sha256": "c8b3ec2da053719cb8c1da19b2d71849fcfe63277b2cc3388ce367fe8f5e80c0", - "size": 7069 + "sha256": "4a2596875d29e2e7e6e15174cede1829313044dcb7b2b48888c362e789ece662", + "size": 7303 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/credentials/delete", "status": "success", "path": "en/api/csharp/beta/vaults/credentials/delete.md", - "sha256": "12f133542a216974634fbc74db5f5f682b02e9aa51b2a178be3abd8f4b7ce74a", - "size": 2319 + "sha256": "57c60ca2d9bb500d6d4a1413fcbef9da199bf8435e9422a01edf6bae2c05fa37", + "size": 2553 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/credentials/retrieve", "status": "success", "path": "en/api/csharp/beta/vaults/credentials/retrieve.md", - "sha256": "3a3e18158eb6dd2996dd6124bd31714a466dfaf76db6cfb4be051cf4227f6e17", - "size": 6457 + "sha256": "bfc18b376d473345324ae4556fd9aaf35c0f713223dd197c2a38a92bd7b30551", + "size": 6691 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/vaults/credentials/mcp_oauth_validate", "status": "success", "path": "en/api/csharp/beta/vaults/credentials/mcp_oauth_validate.md", - "sha256": "c555736fcc2b85ade2b615c04870b83fe56c6a5871c0eb0a3884619fb417676e", - "size": 4629 + "sha256": "a86fe05079da76dec91610378939045dba6c5ff808ebcecd87afc5d41889b733", + "size": 4863 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memories/create", "status": "success", "path": "en/api/csharp/beta/memory_stores/memories/create.md", - "sha256": "64e2fdd708fabb7882aac81798467cbec987f2c9f10e95ea9db76405e42976cb", - "size": 5045 + "sha256": "e2e2a2b5bdbbe973564980f27c3ff42cad1d044cd3d4d882000f286164df0322", + "size": 5274 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memories/update", "status": "success", "path": "en/api/csharp/beta/memory_stores/memories/update.md", - "sha256": "a55a414a639f575b226591e62b09c37ca8534356c63650457064cd36a8fe1eb0", - "size": 5635 + "sha256": "fc7fd1bcd429042490d76832f4cbd57a8d59e49238420507c57f989d191e5701", + "size": 5864 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memories/list", "status": "success", "path": "en/api/csharp/beta/memory_stores/memories/list.md", - "sha256": "bab5f4efb4466b0cc853347f47370c5f8992adb4ac24a80c29b4473bcba975ee", - "size": 6950 + "sha256": "7c85da36b40fd7c9987f81f0c35a12881a7a7199167c10b54320a4cd806f5edf", + "size": 7179 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memories/delete", "status": "success", "path": "en/api/csharp/beta/memory_stores/memories/delete.md", - "sha256": "4c92b8fe6a9f0be374c28a1e4c8e183240e64e2aaf39e5eb6596f2ed70374c15", - "size": 2567 + "sha256": "15f3cd2fc7bc8f71e5a8dc7ca615bc5aeba4442f65e370881d9fc5ed38d5f923", + "size": 2937 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memories/retrieve", "status": "success", "path": "en/api/csharp/beta/memory_stores/memories/retrieve.md", - "sha256": "60078770eb5d0dd305eb77e9a7bf5fdbe367d3136161a68dbaa0dcd373ffe456", - "size": 4573 + "sha256": "82459780fcd0846a25dcc6ee92b21f73e5faa41340e25f8fa0ea96b2c745959a", + "size": 4802 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memory_versions/redact", "status": "success", "path": "en/api/csharp/beta/memory_stores/memory_versions/redact.md", - "sha256": "f7a4b0a01b78e1f57547c8777580f2d766e56752f0ab9748c7b9bb09f3006634", - "size": 6912 + "sha256": "f162d34caab010859d033ff4eea6b3a9ce226f77d98b48e6ecbd102f9b77f81c", + "size": 7312 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memory_versions/list", "status": "success", "path": "en/api/csharp/beta/memory_stores/memory_versions/list.md", - "sha256": "618d89cfdaaa41a51c896e5c3b61d482c969fa10f74680671df7b27a24971869", - "size": 7897 + "sha256": "f32b6d76131e3e58734efca6cd2ae977e8a0d8144dbcddbcebb86cb443411964", + "size": 8176 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/memory_stores/memory_versions/retrieve", "status": "success", "path": "en/api/csharp/beta/memory_stores/memory_versions/retrieve.md", - "sha256": "2f38234ef4bce1b1b32bde1d8f8cbda4ca2fa22e0677a89a7fb27bc644524722", - "size": 6999 + "sha256": "0b360812061378eacc8e6c5a8267e66164068df00717ae6ccd698d134a84272d", + "size": 7399 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/batches/results", "status": "success", "path": "en/api/csharp/beta/messages/batches/results.md", - "sha256": "77d287d4580d9e802339f28a1251549b827ef5c0c1fa93298377e983b1abc4eb", - "size": 52359 + "sha256": "06d5f3ffdb1a667ff911cb5caf9097721cf24fb95696b107b55e250f3296b190", + "size": 53552 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/batches/cancel", "status": "success", "path": "en/api/csharp/beta/messages/batches/cancel.md", - "sha256": "1663780613529bfbc64edbe250ba1ad9602af0504c404d9fd1c440de40caaeee", - "size": 5977 + "sha256": "41018169702abe48450e7dde6432465469c3eff3676d2618df4d7a8b5e8fe267", + "size": 6211 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/batches/create", "status": "success", "path": "en/api/csharp/beta/messages/batches/create.md", - "sha256": "64de5570a66efed34efcbbca37aec55ef211023827f8187571a3ac45f505c6df", - "size": 137644 + "sha256": "7f3860c47c468af32e27ac3c8c43b5a8d0c98b5202317f09ae5b9eda48776b55", + "size": 137936 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/batches/list", "status": "success", "path": "en/api/csharp/beta/messages/batches/list.md", - "sha256": "3557372065dc5e69daf50bb37d24541f9b018808ac7f615cdf23129c4ec40ad9", - "size": 6617 + "sha256": "c809bd9e8f3b70ab75c1bf54e4d5c82f737c25d1e893df572043b5623fbf785c", + "size": 6851 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/batches/delete", "status": "success", "path": "en/api/csharp/beta/messages/batches/delete.md", - "sha256": "2cc0e8e7862b4ea7f70d30baade11a69cd57fcd67b81686f68a0cc3220bceff7", - "size": 2418 + "sha256": "c50f52d8ff8830da0ed1798bd921d770f0c234c4f04e12f8748391ef3b149c08", + "size": 2652 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/messages/batches/retrieve", "status": "success", "path": "en/api/csharp/beta/messages/batches/retrieve.md", - "sha256": "72ca2f3136893184bf978b55c5f55f90966e2a1aae696e6413b2d43bd2ea8087", - "size": 5669 + "sha256": "d55c0b2d813491720a4ba423d19b8e2b7112272b6290e9578ad12c2d4d913619", + "size": 5903 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/certificates/create", "status": "success", "path": "en/api/csharp/beta/tunnels/certificates/create.md", - "sha256": "1deaa61231eda3ec2b9c73757f023443352935cb1c30433f65430205df5dc3d4", - "size": 3505 + "sha256": "4cc77aaaaa9c525fcb27ade9081edc78370b56e6d23bf8418ea19c8b79efa743", + "size": 3739 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/certificates/archive", "status": "success", "path": "en/api/csharp/beta/tunnels/certificates/archive.md", - "sha256": "8aef40734136c40d1b9f4d9a3fdd822abf6ea1005536d97ec0e6b6b6ceaf54ff", - "size": 3458 + "sha256": "84321d621b8bfbd79cff399e6f0d24aa1199100313b20091ba8dea733a03c85f", + "size": 3692 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/certificates/list", "status": "success", "path": "en/api/csharp/beta/tunnels/certificates/list.md", - "sha256": "dcf85c66d515c6c5ab49cb4921ac85b23e2198a17c5b2be8292d05d8f4edf1cd", - "size": 3884 + "sha256": "e4c89e5fab44e37249d09542bffe98d67b5102cbc332f891e168525e4a5e3df3", + "size": 4118 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/tunnels/certificates/retrieve", "status": "success", "path": "en/api/csharp/beta/tunnels/certificates/retrieve.md", - "sha256": "45e4834c039b3ca66d0f883608b69a7f1aeaff46a202fb285ec3e1667518a679", - "size": 3237 + "sha256": "af81bdbee7fe4880ea2e9fdb5bce39dad8cf2e7352ec725a6edc5bb0debb9928", + "size": 3471 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work/ack", "status": "success", "path": "en/api/csharp/beta/environments/work/ack.md", - "sha256": "6fc94c2927b45835f7a7eb3db7ba102417681db188d5eaa6b502de9a83734b38", - "size": 4474 + "sha256": "9f7df0f8f2d97b99b61c48b21b69f2e0ac238e5517f90dfb4d87e44b8fbf9911", + "size": 4708 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work/stats", "status": "success", "path": "en/api/csharp/beta/environments/work/stats.md", - "sha256": "a586364e7f2fa6136f1ccfc87286609d5444d7b23dd59f7307b16febc44a03ff", - "size": 2734 + "sha256": "d5125047ae35c31b145127742867a3f68f04ce685453d24d3488d6790b5c95b6", + "size": 2968 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work/poll", "status": "success", "path": "en/api/csharp/beta/environments/work/poll.md", - "sha256": "bd3dd07362ad2c0112a08a4cc94cba5bff2dd0af68d6415f34eaa392663d69eb", - "size": 4876 + "sha256": "5b77d36d58b30870891c141a9505e9c788c90605d0250824b68efd0885237b45", + "size": 5110 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work/stop", "status": "success", "path": "en/api/csharp/beta/environments/work/stop.md", - "sha256": "bc9a22acf6504404efbdfb4781682050e118235a54102e5b3bafe050982963b7", - "size": 4509 + "sha256": "87622204778679a21cc58b8134c328cebbd89618d4f23525044557a702826710", + "size": 4743 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work/update", "status": "success", "path": "en/api/csharp/beta/environments/work/update.md", - "sha256": "e823b3af817168da8d61ace096166b45590e560c9aa4e84a75091a4390f7e972", - "size": 4692 + "sha256": "020352c47992347dd7af083b7d6e7f9ec6a05a20f5dbaa3f14c5fd2929bc3c2b", + "size": 4926 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work/list", "status": "success", "path": "en/api/csharp/beta/environments/work/list.md", - "sha256": "cd5ed6945a16b695ec91e6c6c18fd689acccc7bd13532d277ffad5077ac7892a", - "size": 4732 + "sha256": "c03a2147fb4ab6676c28cae1d524bb9f78c1de74eb3389760c43612a33bbafc9", + "size": 4966 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work/heartbeat", "status": "success", "path": "en/api/csharp/beta/environments/work/heartbeat.md", - "sha256": "3a9bd4b4a577fb0f31e6b4e71f57b386682a779fd624eb543e0e3181ca81b7cd", - "size": 3437 + "sha256": "650c1e3d7854db2479b4b17b58c05d29ba22332c779fab5de0930390edb49f34", + "size": 3671 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/environments/work/retrieve", "status": "success", "path": "en/api/csharp/beta/environments/work/retrieve.md", - "sha256": "01847be7d7e10a55c7cb03887aa8db2ed998f2601479235d75a93b2a7a2d47b6", - "size": 4431 + "sha256": "5501b42bc1ad9f670f7ee05e1f0635d7e5b5607dc8a259ef16908496110784eb", + "size": 4665 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/agents/versions/list", "status": "success", "path": "en/api/csharp/beta/agents/versions/list.md", - "sha256": "6741e6531c98eb3068acc09ef54e8f76b05275bcce886d5e6e16c8bd7ef7c824", - "size": 17525 + "sha256": "3625444b999b6f207783c05529bdb117c9b14ea7da4f5754b9df43ad5f65f8a2", + "size": 17759 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/events/send", "status": "success", "path": "en/api/csharp/beta/sessions/events/send.md", - "sha256": "4c8c94f46da8faf6e6422da5d23a43c724755d944db13b2bca588586cb862b5f", - "size": 24142 + "sha256": "9f94e565d8566f368c8098012edaf9484cfe330f40e7838761edd51e087e7f93", + "size": 24376 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/events/stream", "status": "success", "path": "en/api/csharp/beta/sessions/events/stream.md", - "sha256": "5abcdefec67d5bd67c949bcba9738c6e00a42ae9d7873ef16296e2c7997dc7a1", - "size": 65297 + "sha256": "a014089eee1ed4ccf57f9518ac6765a80b080f37df5f19007bdf38f07810098d", + "size": 65531 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/events/list", "status": "success", "path": "en/api/csharp/beta/sessions/events/list.md", - "sha256": "1887d6dc6ba16a1c9c386177cb39b9c7265dc25da4216d1215b138d724956bc8", - "size": 65575 + "sha256": "45631c249a97e393093ff347b32ba02ff5aee8be4e480ee7a8e239c0ac2b6824", + "size": 65809 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/resources/add", "status": "success", "path": "en/api/csharp/beta/sessions/resources/add.md", - "sha256": "4844016b4a2f562d716e0f4a7b973aca889d4ad73681e9d9a310612b63f53747", - "size": 2857 + "sha256": "ca4a09c0d40113b22cdb5376ecce61a2641dbfed7190e6dc634eda230850891a", + "size": 3091 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/resources/update", "status": "success", "path": "en/api/csharp/beta/sessions/resources/update.md", - "sha256": "2d22b89fbc257499432c61c448c19efa0873feadb85d30c40921e410694eb147", - "size": 4918 + "sha256": "bc5b0c6d4b10952e4d75ffe8c5f07dc5c8c29399f2d170b525be2a9aefe1aadf", + "size": 5152 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/resources/list", "status": "success", "path": "en/api/csharp/beta/sessions/resources/list.md", - "sha256": "0652ba12d471f3d76b9ed04d8907d559feabe8e136b07c4e0c31bbe9c037d354", - "size": 5517 + "sha256": "9316dc41a1feadf7f19947866448e0fe782d59a2709217360aa16e13793a9cf6", + "size": 5751 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/resources/delete", "status": "success", "path": "en/api/csharp/beta/sessions/resources/delete.md", - "sha256": "d5f307438293ca508f60dd1646d0f72e53ba787f0740e55100b4efc01a96313b", - "size": 2295 + "sha256": "bb0c344ee67700ddefdfd3d4a0f785abd8947e4ab6b235b3fe3a0bb29f5c2c37", + "size": 2529 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/resources/retrieve", "status": "success", "path": "en/api/csharp/beta/sessions/resources/retrieve.md", - "sha256": "b97cf9771ebd05f47ec870481f7c13888e370cf04b254635e84fe85a4c5ab00f", - "size": 4675 + "sha256": "e854848e31d35719b4b05ffbb59673812c111e63703c42c7e677fcedf941795b", + "size": 4909 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/threads/events", "status": "success", "path": "en/api/csharp/beta/sessions/threads/events.md", - "sha256": "6e4d5a6d9ea1af3a0cf4c734f4577c736fce2c23808208e96a796fd846ae9175", - "size": 129906 + "sha256": "b9d8e8fde38ecf24f401f817dcfcdf254d09d8ff5621a5fda9b9d4d288dd5e7c", + "size": 130374 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/threads/archive", "status": "success", "path": "en/api/csharp/beta/sessions/threads/archive.md", - "sha256": "4ecaed57d159b120c2bcf6218d5712bc071023ef92be72e6486b75e5dc65fdf7", - "size": 20507 + "sha256": "4907da792973e7994217a3287eab40823087c58bf4e943d06929b208f1673222", + "size": 20840 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/threads/list", "status": "success", "path": "en/api/csharp/beta/sessions/threads/list.md", - "sha256": "67bc7d5beafc5ce8b0eb09959ce08657a6fbd2e0f6558d0411758179cb0e5cb3", - "size": 21698 + "sha256": "a56e734c6117967513c197f292ea2cac51358224c1a9c2e48190bba8cf4510bd", + "size": 22031 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/threads/retrieve", "status": "success", "path": "en/api/csharp/beta/sessions/threads/retrieve.md", - "sha256": "9679f94ded9ef4ce3bbbafa9b677fd13ec469a244647e7b4f2ab5ffe73bc3f3e", - "size": 20494 + "sha256": "448f2b89db220f4e2a34204814ce54bcb62367b59271336f1a39a6b4cea49ec0", + "size": 20827 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/threads/events/stream", "status": "success", "path": "en/api/csharp/beta/sessions/threads/events/stream.md", - "sha256": "991bc69adb0f396eb4541297ebf609579ec6a9c505b4ba2677714e8055b9b6cc", - "size": 65521 + "sha256": "4773791020a5caf693d83ea889dbbeefd317137876a196d372b63415f605fe98", + "size": 65755 }, { "url": "https://platform.claude.com/docs/en/api/csharp/beta/sessions/threads/events/list", "status": "success", "path": "en/api/csharp/beta/sessions/threads/events/list.md", - "sha256": "7a5fc2892bb516a0f13662eef7563365bd9748fa0dc85c3a9c4b8cd53f991a02", - "size": 64364 + "sha256": "6105b78d4a6e6be42ebf28878ccf006187fac70e04dfd3e17ec72251cc7279e9", + "size": 64598 }, { "url": "https://platform.claude.com/docs/en/api/csharp/messages/batches/results", @@ -20764,15 +21282,15 @@ "url": "https://code.claude.com/docs/en/slash-commands", "status": "success", "path": "en/docs/claude-code/slash-commands.md", - "sha256": "8635e0597dc1a135bbdadcf0389cc00d807376d8dd801a0220a4d42f39a3e57e", - "size": 96018 + "sha256": "adef846544405b16b010d6b666fd2d35b62853cec247c71e95bfe46a76ffdf5c", + "size": 96173 }, { "url": "https://code.claude.com/docs/en/desktop-changelog", "status": "success", "path": "en/docs/claude-code/desktop-changelog.md", - "sha256": "2ed26d7c1efde71300e02a5bf4c5d32fa8cb5227635ec29e418cc1532f4d2e89", - "size": 96947 + "sha256": "cebf7cc0df6add9b691e2b7153db056ead56e021271413c44c5e83e5fd438514", + "size": 97804 }, { "url": "https://code.claude.com/docs/en/ultraplan", @@ -26476,8 +26994,8 @@ "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-python/main/CHANGELOG.md", "status": "success", "path": "github/anthropic-sdk-python/CHANGELOG.md", - "sha256": "54b2ef339cc50969be795c98d7a2ab1c357b8d008942ee3030707c559936b4b1", - "size": 226918 + "sha256": "5b8b32c5299381d07f23f4d03436f9601e11767adf0666fa5edc0d4ae1077a73", + "size": 229208 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-python/main/CONTRIBUTING.md", @@ -26511,8 +27029,8 @@ "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-python/main/api.md", "status": "success", "path": "github/anthropic-sdk-python/api.md", - "sha256": "c3cb64ac0b468b517520f66bb70cf13f1e551995d98601cfd0762e48cc26ffea", - "size": 82894 + "sha256": "07d0a6a1cd4aee61836e10e7ed0af74412d2caa7767c33ab365f3d157d232098", + "size": 108121 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-python/main/examples/greeting-SKILL.md", @@ -26553,15 +27071,15 @@ "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-python/main/tools.md", "status": "success", "path": "github/anthropic-sdk-python/tools.md", - "sha256": "049465d10e135f712705376bb75ff419bcc310df904f553a5b9950e6f6d24f9b", - "size": 3220 + "sha256": "0ba0be0ab10f17108692ccbd774387b70a2adaf64ecae53092337e7f402320f6", + "size": 3484 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/CHANGELOG.md", "status": "success", "path": "github/anthropic-sdk-typescript/CHANGELOG.md", - "sha256": "aacc993f86ad7f98d96b7855033f58ad5dfb4ded86d0e8a4606173b4b76e272c", - "size": 205144 + "sha256": "830bf9ae784d6cf2e13e116e8c08060d965c56ff57dffc49c67dc1310e632f9b", + "size": 207961 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/CLAUDE.md", @@ -26602,8 +27120,15 @@ "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/api.md", "status": "success", "path": "github/anthropic-sdk-typescript/api.md", - "sha256": "044b3d7cdac80a6abad507bff1ddc8c98c8417cea76c0d769dcdceb1b7fc1ce6", - "size": 127711 + "sha256": "2d983d113086e00f4de70f048c53b87241dfdd105ceba9a0ee3c887294d271e7", + "size": 147696 + }, + { + "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/ecosystem-tests/README.md", + "status": "success", + "path": "github/anthropic-sdk-typescript/ecosystem-tests/README.md", + "sha256": "2668c4104b5938946d32cb3bce361e20d34a30b65299853cf3ed54bb540a118a", + "size": 3767 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/examples/greeting-SKILL.md", @@ -26616,8 +27141,8 @@ "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/helpers.md", "status": "success", "path": "github/anthropic-sdk-typescript/helpers.md", - "sha256": "e72feddd64747222553eca1cbac1fb7064181afda6c083ac1f89c15cf782ab1a", - "size": 21334 + "sha256": "b3e014929a8e11e156699612f610f8f320c0cbbdcfa4096c5968c038a3f4d389", + "size": 24222 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/packages/aws-sdk/CHANGELOG.md", @@ -26637,8 +27162,8 @@ "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/packages/bedrock-sdk/CHANGELOG.md", "status": "success", "path": "github/anthropic-sdk-typescript/packages/bedrock-sdk/CHANGELOG.md", - "sha256": "6d49da0c433a5e34bf25df9e709bbd8c75adbaef2495d05b7d2e21f406c2b881", - "size": 47197 + "sha256": "bef76ea481dc4c40a4800f8b176cd033df454ee55775af169b9707b6f7d4b84e", + "size": 47677 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/packages/bedrock-sdk/README.md", @@ -26665,8 +27190,8 @@ "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/packages/google-cloud-sdk/CHANGELOG.md", "status": "success", "path": "github/anthropic-sdk-typescript/packages/google-cloud-sdk/CHANGELOG.md", - "sha256": "f2914741ef524ff9815f5d0bc7993b04ff013cf0a3398652bbd1d36befc13fbf", - "size": 4558 + "sha256": "66dd0ba60ffe5f1aef40df7879a7c3676a6238871f2a5fd2a26f92f6b171a239", + "size": 4956 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/packages/google-cloud-sdk/README.md", @@ -26679,8 +27204,8 @@ "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/packages/vertex-sdk/CHANGELOG.md", "status": "success", "path": "github/anthropic-sdk-typescript/packages/vertex-sdk/CHANGELOG.md", - "sha256": "2a51d421c2325062d3e61f212975a3f312060507a96d6300817906305bee526c", - "size": 27414 + "sha256": "3358f8fae9cfe1d5ea46cf2060b53ab1880c7a6bccc4117be525dba7389c555a", + "size": 27788 }, { "url": "https://raw.githubusercontent.com/anthropics/anthropic-sdk-typescript/main/packages/vertex-sdk/README.md", @@ -26725,16 +27250,7 @@ "size": 170 } ], - "failures": [ - { - "url": "https://platform.claude.com/docs/en/api/ruby/beta/tunnels/certificates/list", - "error": "HTTP 503" - }, - { - "url": "https://platform.claude.com/docs/en/api/typescript/beta/messages/batches/create", - "error": "HTTP 503" - } - ], + "failures": [], "dead": [ { "url": "https://support.claude.com/en/articles/12650343-use-claude-for-excel", @@ -27114,11 +27630,11 @@ } ], "summary": { - "total": 3913, - "downloaded": 3817, + "total": 3986, + "downloaded": 3892, "skipped": 0, - "failed": 2, + "failed": 0, "dead": 94, - "success_rate": 99.9 + "success_rate": 100.0 } } \ No newline at end of file diff --git a/content/CHANGELOG.md b/content/CHANGELOG.md index 8862f0c08..3a9eb16f3 100644 --- a/content/CHANGELOG.md +++ b/content/CHANGELOG.md @@ -1,5 +1,41 @@ # Changelog +## 2.1.247 + +- Added the `SendFeedback` tool: when something goes wrong in a session, Claude can draft a feedback report for you to review and send from `/feedback` (turn off with the `feedbackDrafts` setting) +- Added `{id, text, cooldownSessions, priority}` entries, `tipsFile`, and `label` to `spinnerTipsOverride`, so organizations can rotate their own tips alongside the built-in ones +- Added a tip on Bash permission prompts pointing to auto mode, with a one-keystroke "Yes, and switch to auto mode" option +- Added `/claude-api cost-optimize` to profile an existing project's Claude API spend and work through cost levers (caching, token hygiene, batch, effort, model choice) one measured change at a time +- Updated the `/claude-api` skill with Admin API coverage (organization members, invites, workspaces, API keys, rate limit reports, workload identity federation, CMEK) +- Fixed fast arrow-key + Enter sequences acting on the row above the one you navigated to in history search, `/config`, `/mcp`, `/skills`, background tasks, and `/model` +- Fixed sub-agents dying on a first-call model 404: they now use the session's fallback model chain, and the error returned to the parent includes the error type, status, request id, and model +- Fixed a hook or background agent that printed megabytes of error output being able to overflow the conversation and wedge the session on "Prompt is too long" +- Fixed Ctrl keyboard shortcuts not firing under non-Latin (e.g. Cyrillic) keyboard layouts in kitty-protocol terminals +- Fixed text like `<35;150;7M` being inserted into the prompt when a mouse report arrived split across reads right after the escape prefix +- Fixed the Bash sandbox's after-command cleanup deleting a dotfile-managed `~/.claude/settings.json` symlink (nix/home-manager, stow) when it is repointed outside the sandbox's writable area +- Fixed `/terminal-setup` overwriting your entire Zed `keymap.json` instead of merging in its keybinding +- Fixed `/rename` silently confirming when the session registry could not be updated; it now says other sessions may still show the old name +- Fixed `/compact` and "Summarize from here" in sessions started with `--agent` summarizing under the default system prompt instead of the conversation's own +- Fixed a background session showing "opening…" forever in `claude agents` after its terminal host process died; the row now fails within seconds with the reason, and Enter restarts it +- Fixed unbounded memory growth when a hook's or background task's output file could not be written; the file now notes where output was lost +- Fixed `/install-github-app` over SSH: the copy shortcut now says how the sign-in URL was copied instead of always claiming success, and the URL appears immediately when no browser can open +- Fixed shell commands carried over from the foreground logging an internal error or showing a misleading `[exited with code -1]` line when they finish in background sessions +- Fixed a version-less marketplace plugin's live cache directory being deleted and recreated on a second-scope install, which could disrupt a running session using it +- Fixed Remote Control sessions started with `/remote-control` not reporting the working-tree diff to connected clients +- Fixed self-hosted runner sessions reporting `running` before Claude Code had started, which could trigger a premature "Claude is waiting for your input" notification from the Claude desktop app +- Fixed first-run setup exiting with "Unable to connect to Anthropic services" when managed settings configure Claude apps gateway sign-in and Anthropic endpoints are unreachable +- Fixed cloud sessions (Claude Code on the web, desktop and mobile apps) sometimes showing the previous permission mode when you switch modes right after sending a message +- Fixed cloud sessions going silent when the session's container restarts between turns while a background agent, shell, or monitor is still running — the resumed session now reports the lost work +- Improved plugin marketplace hardening: names containing control or invisible characters are rejected, and marketplace-supplied text in `/plugin` and `claude plugin` output is escape-safe +- Improved Bedrock, Vertex, and Foundry sessions (and any with telemetry disabled): Claude is now told when a configured MCP server failed to connect, instead of concluding its tools don't exist +- Changed Sonnet 5's default auto-compact window to its full 1M context, so sessions on the 1M window now auto-compact at about 967K tokens instead of about 934K +- Changed cross-session peer messages to collapse by default to a one-line `Message from @: ` preview; Ctrl+O expands the full body +- Changed terminal hyperlinks in rendered markdown: link targets that point at a network or automounter path, contain a control character, or lead with an invisible character now render as plain text +- Changed the prompt-footer PR badge to skip its GitHub re-check on terminal refocus when the last check is under a minute old +- Changed analytics to stay off from startup, not only after login, when managed settings force gateway login or a custom OAuth deployment is configured +- Changed Claude apps gateway sign-in requests to identify Claude Code (a `surface=claude_code` device-authorization parameter and a `claude-code/` User-Agent) +- Changed organization sign-in enforcement to exit at start when the administrator's managed settings cannot be read, even if host-supplied or per-user Windows registry settings exist + ## 2.1.246 - Added a startup warning for Bash allow rules with a wildcard before the subcommand (e.g. `Bash(git * main)`), since they also match options inserted before the subcommand diff --git a/content/claude-code-manifest.json b/content/claude-code-manifest.json index b74822394..ba244d287 100644 --- a/content/claude-code-manifest.json +++ b/content/claude-code-manifest.json @@ -6,25 +6,25 @@ "url": "https://github.com/anthropics/claude-code/issues" }, "dist": { - "shasum": "4222a707657362a9588eb194bb56c339193cbfd2", - "tarball": "https://registry.npmjs.org/@anthropic-ai/claude-code/-/claude-code-2.1.246.tgz", + "shasum": "c64ecfdfff0e8a7f7c79467b178344ec52e08fbe", + "tarball": "https://registry.npmjs.org/@anthropic-ai/claude-code/-/claude-code-2.1.247.tgz", "fileCount": 7, - "integrity": "sha512-E2PEKkal9D05dWnsc2fcPclJpEbJbnIE3D1vp33aPrsFbmdbqyNzEcc9/SeFIj53hvP/M5BuHygOFbeoBWEAOg==", + "integrity": "sha512-2Z2UQKom3x6GBQDYlFFi00KbRciqsuGL9CpK+IN3fXmmJb7IXVitrRZ6HZyUw0ixnckr814GIp0FUaXwDEbBrw==", "signatures": [ { - "sig": "MEUCIFg+x9zVDnGQevwMGtK61THvjT2SbC0ximwfpsouftxGAiEAvWqK1c1a/qi/NGhmNT5BRLMb0QPoYp0bus4luMqX9fM=", + "sig": "MEUCIQCTCj0fY9zWMr7bKZo/+kmpnYX9++NqBDjQAIBQk0MC4wIgD7Q67OtopvToafYzgG64y7jG0miGj6oRnKt3Qu7OySY=", "keyid": "SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U" }, { - "sig": "MEUCIAv6NdvjZ1ZiWV/Fz+HaQbQfJ/wa3Vq66wD9qq/K6dD5AiEAqKZvdS3HXLhiARySnrcT+8P11Fi961yrl71RisNZVHk=", + "sig": "MEUCIQCMIO2FOJk1Gxyrz0jEfSboFYCbkTCFpjcdDjHMFm3UbgIgQGoeBph5TrfVsTdD/puq+LgVCNto6Tkwig7KJvvTmyQ=", "keyid": "SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U" } ], - "unpackedSize": 179247 + "unpackedSize": 178324 }, "name": "@anthropic-ai/claude-code", "type": "module", - "_from": "file:staged-npm/anthropic-ai-claude-code-2.1.246.tgz", + "_from": "file:staged-npm/anthropic-ai-claude-code-2.1.247.tgz", "author": { "name": "Anthropic", "email": "support@anthropic.com" @@ -42,8 +42,8 @@ "email": "wolffiex@anthropic.com" }, "homepage": "https://github.com/anthropics/claude-code", - "_resolved": "/home/runner/work/claude-cli-internal/claude-cli-internal/staged-npm/anthropic-ai-claude-code-2.1.246.tgz", - "_integrity": "sha512-E2PEKkal9D05dWnsc2fcPclJpEbJbnIE3D1vp33aPrsFbmdbqyNzEcc9/SeFIj53hvP/M5BuHygOFbeoBWEAOg==", + "_resolved": "/home/runner/work/claude-cli-internal/claude-cli-internal/staged-npm/anthropic-ai-claude-code-2.1.247.tgz", + "_integrity": "sha512-2Z2UQKom3x6GBQDYlFFi00KbRciqsuGL9CpK+IN3fXmmJb7IXVitrRZ6HZyUw0ixnckr814GIp0FUaXwDEbBrw==", "_npmVersion": "11.17.0", "description": "Use Claude, Anthropic's AI assistant, right from your terminal. Claude can understand your codebase, edit files, run terminal commands, and handle entire workflows for you.", "directories": {}, @@ -106,19 +106,19 @@ "_hasShrinkwrap": false, "readmeFilename": "README.md", "optionalDependencies": { - "@anthropic-ai/claude-code-linux-x64": "2.1.246", - "@anthropic-ai/claude-code-win32-x64": "2.1.246", - "@anthropic-ai/claude-code-darwin-x64": "2.1.246", - "@anthropic-ai/claude-code-linux-arm64": "2.1.246", - "@anthropic-ai/claude-code-win32-arm64": "2.1.246", - "@anthropic-ai/claude-code-darwin-arm64": "2.1.246", - "@anthropic-ai/claude-code-linux-x64-musl": "2.1.246", - "@anthropic-ai/claude-code-linux-arm64-musl": "2.1.246" + "@anthropic-ai/claude-code-linux-x64": "2.1.247", + "@anthropic-ai/claude-code-win32-x64": "2.1.247", + "@anthropic-ai/claude-code-darwin-x64": "2.1.247", + "@anthropic-ai/claude-code-linux-arm64": "2.1.247", + "@anthropic-ai/claude-code-win32-arm64": "2.1.247", + "@anthropic-ai/claude-code-darwin-arm64": "2.1.247", + "@anthropic-ai/claude-code-linux-x64-musl": "2.1.247", + "@anthropic-ai/claude-code-linux-arm64-musl": "2.1.247" }, "_npmOperationalInternal": { - "tmp": "tmp/claude-code_2.1.246_1787685454325_0.6828537139820177", + "tmp": "tmp/claude-code_2.1.247_1787767320957_0.43571757369009734", "host": "s3://npm-registry-packages-npm-production" }, - "_id": "@anthropic-ai/claude-code@2.1.246", - "version": "2.1.246" + "_id": "@anthropic-ai/claude-code@2.1.247", + "version": "2.1.247" } \ No newline at end of file diff --git a/content/claude/claude-tag/admins/add-connections.md b/content/claude/claude-tag/admins/add-connections.md index 62201c060..a9d1fc548 100644 --- a/content/claude/claude-tag/admins/add-connections.md +++ b/content/claude/claude-tag/admins/add-connections.md @@ -150,21 +150,7 @@ Domain entries allow hosts one at a time. For a scope whose work needs more of t A new environment's network access level is Trusted access, which allows a [documented set of package registries and developer hosts](https://code.claude.com/docs/en/cloud-environments#default-allowed-domains). A channel can already reach hosts like `pypi.org` and `registry.npmjs.org` with no domain entry. -To give a scope broader access, create an environment with a more permissive level and pin it on the scope. - - - - From the **Cloud environments** page in [admin settings](https://claude.ai/admin-settings), add an [organization-shared environment](https://code.claude.com/docs/en/cloud-environments#organization-shared-environments) and set its network access level. **Full access** allows any domain; see [Network access in the Claude Code docs](https://code.claude.com/docs/en/cloud-environments#network-access) for the other levels. This step takes an Owner or admin. - - Don't create the environment at [`claude.ai/code`](https://claude.ai/code): environments you create there belong to your individual account, so they never appear in the picker. - - - - Open the scope's **Advanced** section and use the **Environment** picker. With nothing pinned, sessions use the organization default. - - - -The environment must be scoped to the organization, not an individual account. If sessions don't pick up the one you pinned, see [the environment troubleshooting entry](/docs/claude-tag/admins/troubleshooting#channel-sessions-use-the-wrong-environment-or-can%E2%80%99t-find-one). +To give a scope broader access, create an organization-shared environment with a more permissive level and set it on the scope, as described in [Configure the environment for a scope](/docs/claude-tag/admins/customize#configure-the-environment-for-a-scope). **Full access** allows any domain; see [Network access in the Claude Code docs](https://code.claude.com/docs/en/cloud-environments#network-access) for the other levels. ### Allow all hosts diff --git a/content/claude/claude-tag/admins/attach-to-scope.md b/content/claude/claude-tag/admins/attach-to-scope.md index 32aeabca2..ffaf51297 100644 --- a/content/claude/claude-tag/admins/attach-to-scope.md +++ b/content/claude/claude-tag/admins/attach-to-scope.md @@ -120,13 +120,13 @@ A new instruction applies to sessions started after you save it. Claude reads it By default, anyone in a channel who is also a member of your Claude organization can edit that channel's instructions from the **Configure** link in Claude's reply footer. The **Channel member edits** setting in a scope's **Advanced** settings controls this. -| Option | Effect | -| :---------- | :-------------------------------------------------------------------------------------------------------- | -| **Inherit** | Follow the parent scope's setting | -| **Allow** | Members can edit channel instructions from the Configure link | -| **Block** | The Configure page is read-only for members, with a note that only admins can change channel instructions | +| Option | Effect | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Inherit** | Follow the parent scope's setting | +| **Allow** | Members can edit channel instructions from the Configure link | +| **Block** | The Configure page is read-only for members, with a note that only admins can change channel instructions. Claude also declines to make a model the channel default when anyone asks in a thread | -A chain of scopes that all inherit resolves to **Allow**. Set **Block** at the workspace or Default Slack access scope to lock channel instructions across every channel beneath it. A [channel manager](/docs/claude-tag/admins/restrict-access#delegate-channel-setup-to-channel-managers) can still edit instructions in a channel assigned to them when **Block** is set. +A chain of scopes that all inherit resolves to **Allow**. Set **Block** at the workspace or Default Slack access scope to lock channel instructions across every channel beneath it. A [channel manager](/docs/claude-tag/admins/restrict-access#delegate-channel-setup-to-channel-managers) can still edit instructions and the default model from the Configure page in a channel assigned to them when **Block** is set. ## Verify the bundle is live diff --git a/content/claude/claude-tag/admins/audit.md b/content/claude/claude-tag/admins/audit.md index b8e19c6ad..a083dff7d 100644 --- a/content/claude/claude-tag/admins/audit.md +++ b/content/claude/claude-tag/admins/audit.md @@ -12,7 +12,7 @@ export const BetaNote = () => Claude Tag is in public beta. Features and b Use this page to review what Claude Tag is doing across your organization: which routines are scheduled, what memory it has saved, and where to find a record of each action it took. -The Audit page opens for Owners and Admins in your Claude organization; the other trails on this page are visible to anyone with access to the underlying surface. +The Audit page opens for Owners in your Claude organization; the other trails on this page are visible to anyone with access to the underlying surface. Claude Tag activity is auditable in four places: @@ -28,7 +28,7 @@ The Audit page, labeled **Activity** in the admin console's left nav and page he | Tab | What it shows | | :----------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Scheduled work** | Every routine across your organization, with a **Scope** filter and a per-row **⋮** menu (View details, Pause/Resume, Delete) | -| **Memory** | A link to each scope's memory files, where you can read what Claude has saved for that workspace or channel (you can also edit or delete them there) | +| **Memory** | Each scope's memory files, where you can read what Claude has saved for that workspace or channel. Owners can also edit or delete entries there. | | **Network events** | An hourly JSON export of outbound calls Claude made through Agent Proxy. Git and MCP traffic are not included in this export. Select a date and hour to download. | Each routine on the **Scheduled work** tab shows **Created by** (the member who set it up) in its **View details** dialog. There is no per-action log of every task and who asked; for that, use the trails below. diff --git a/content/claude/claude-tag/admins/configure-github.md b/content/claude/claude-tag/admins/configure-github.md index 5a21a5993..f4e827ee8 100644 --- a/content/claude/claude-tag/admins/configure-github.md +++ b/content/claude/claude-tag/admins/configure-github.md @@ -100,7 +100,10 @@ Repository skills apply only in sessions that have the repository. To give a ski ### Install project dependencies -Every session runs in an isolated sandbox with a standard set of preinstalled tools. The sandbox is the same for every repository; there is no setup script or custom image to configure. If a project needs something the standard set doesn't include, such as a specific language runtime or a database client, add the install commands to the repository's `CLAUDE.md`. +Every session runs in an isolated sandbox with a standard set of preinstalled tools. There are two places to add what a project needs beyond that set, such as a specific language runtime or a database client: + +* **For every session in a channel**, an admin adds the install commands to the setup script of the environment the channel's sessions run on. See [Configure the environment for a scope](/docs/claude-tag/admins/customize#configure-the-environment-for-a-scope). +* **For one repository**, add the install commands to the repository's `CLAUDE.md`. Claude follows `CLAUDE.md` as guidance when it starts work that needs it, not as an unconditional setup step. Write each install as a precondition of the work it supports, for example "install the SDK before building or running tests", so Claude runs it when a task touches that code. The sandbox is fresh for every session, so the installs repeat each time Claude works in the repository. diff --git a/content/claude/claude-tag/admins/customize.md b/content/claude/claude-tag/admins/customize.md index 4c053b320..10e2b733b 100644 --- a/content/claude/claude-tag/admins/customize.md +++ b/content/claude/claude-tag/admins/customize.md @@ -25,16 +25,16 @@ Connections and plugins decide what Claude *can do*; instructions and memory sha Access and organization-wide behavior are set at [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag), per scope (a scope is a channel, a workspace, or your whole organization), so the same agent can work differently in different channels. Most controls below are Owner-only. -| Setting | What it does | More | -| :-------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- | -| Custom instructions | Standing guidance read in every session on a scope, like team conventions. Outranks channel memory. | [Add custom instructions](/docs/claude-tag/admins/attach-to-scope#add-custom-instructions) | -| Respond automatically | Whether Claude replies to a channel's messages without an @-mention. Channel members can change it too, from Slack or the channel's Configure page. | [Turn automatic replies on or off](/docs/claude-tag/users/when-claude-responds#turn-automatic-replies-on-or-off) | -| Plugins | Bundles of skills that teach Claude how to use a specific tool | [Attach plugins](/docs/claude-tag/admins/add-connections#attach-plugins) | -| Connections | Which systems it can reach from each channel | [Add connections](/docs/claude-tag/admins/add-connections) | -| Default model | Which Claude model handles sessions in a scope | [Choose the model for a scope](#choose-the-model-for-a-scope) | -| Auto mode allow rules | Actions pre-approved in a scope's sessions that Claude's permission checker would otherwise flag or stop | [Auto mode allow rules](#auto-mode-allow-rules) | -| Environment | Which cloud environment a scope's sessions run in. The picker shows [organization-shared cloud environments](https://code.claude.com/docs/en/cloud-environments#organization-shared-environments), plus runner pools for organizations that use [self-hosted environments](https://code.claude.com/docs/en/self-hosted-environments-quickstart). Environments on an individual account never appear, because Claude runs channel sessions with no user account attached. | [Channel environment troubleshooting](/docs/claude-tag/admins/troubleshooting#channel-sessions-use-the-wrong-environment-or-can%E2%80%99t-find-one) | -| Claude Tag version | Which generation answers (New, Legacy, or Off) in a scope | [Migrate from the earlier Claude in Slack](/docs/claude-tag/admins/workspaces#set-the-version-for-a-scope) | +| Setting | What it does | More | +| :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- | +| Custom instructions | Standing guidance read in every session on a scope, like team conventions. Outranks channel memory. | [Add custom instructions](/docs/claude-tag/admins/attach-to-scope#add-custom-instructions) | +| Respond automatically | Whether Claude replies to a channel's messages without an @-mention. Channel members can change it too, from Slack or the channel's Configure page. | [Turn automatic replies on or off](/docs/claude-tag/users/when-claude-responds#turn-automatic-replies-on-or-off) | +| Plugins | Bundles of skills that teach Claude how to use a specific tool | [Attach plugins](/docs/claude-tag/admins/add-connections#attach-plugins) | +| Connections | Which systems it can reach from each channel | [Add connections](/docs/claude-tag/admins/add-connections) | +| Default model | Which Claude model handles sessions in a scope | [Choose the model for a scope](#choose-the-model-for-a-scope) | +| Auto mode allow rules | Actions pre-approved in a scope's sessions that Claude's permission checker would otherwise flag or stop | [Auto mode allow rules](#auto-mode-allow-rules) | +| Environment | Which cloud environment a scope's sessions run in | [Configure the environment for a scope](#configure-the-environment-for-a-scope) | +| Claude Tag version | Which generation answers (New, Legacy, or Off) in a scope | [Migrate from the earlier Claude in Slack](/docs/claude-tag/admins/workspaces#set-the-version-for-a-scope) | ### Channel connections are separate from personal connectors @@ -70,7 +70,7 @@ To keep sessions on a model you chose, set a specific model at the organization The setting applies to new sessions; threads already underway keep the model they started with. The footer of each Claude reply in Slack names the model that handled it, so you can confirm what a scope is running. -Channel members can also change the model from Slack, with no admin involved. Asking Claude in a thread switches that thread, and asking it to make a model the channel default changes what new threads in the channel start on. See [choose the model Claude Tag uses](/docs/claude-tag/users/models). +Channel members can also change the model from Slack. Asking Claude in a thread switches that thread, and asking it to make a model the channel default changes what new threads in the channel start on, unless the scope's [Channel member edits](/docs/claude-tag/admins/attach-to-scope#restrict-who-can-set-channel-instructions) setting is **Block**. See [choose the model Claude Tag uses](/docs/claude-tag/users/models). ### Models your organization allows @@ -81,11 +81,52 @@ Claude Tag's model lists come from the models your organization makes available A change to the allowed list applies to new sessions, like a change to the **Default model**; a thread already underway keeps its model until someone in it asks Claude to switch. -## Where to change a scope's environment +## Configure the environment for a scope -The environment is the sandboxed compute configuration a scope's sessions run in. You create environments in one place and pin one per scope in another. An Owner or admin creates environments on the **Cloud environments** page in [admin settings](https://claude.ai/admin-settings), as [organization-shared environments](https://code.claude.com/docs/en/cloud-environments#organization-shared-environments). You then pin one per scope, in the **Environment** picker in the scope's **Advanced** section on [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag), for **Default Slack access**, a workspace, or a channel. A channel with no pin of its own inherits the nearest pin above it; with nothing pinned anywhere, sessions use the **Organization default**. +Claude runs every channel session in a sandbox that starts with a standard set of tools. When a channel's work needs something that sandbox doesn't have, such as a language runtime, a database client, a set of environment variables, or broader web access, give the channel an environment. An environment is an [organization-shared cloud environment](https://code.claude.com/docs/en/cloud-environments#organization-shared-environments): you create it once, then choose it on a scope, meaning a channel, a workspace, or **Default Slack access**. Both steps take an Owner; a [channel manager](/docs/claude-tag/admins/restrict-access#delegate-channel-setup-to-channel-managers) can't change a channel's environment. -A change applies to new sessions; after you pin an environment, start a fresh thread to pick it up. To give a channel broader network access through its environment, see [broad web access through the environment](/docs/claude-tag/admins/add-connections#broad-web-access-through-the-environment). If sessions don't pick up the environment you pinned, see [channel sessions use the wrong environment](/docs/claude-tag/admins/troubleshooting#channel-sessions-use-the-wrong-environment-or-can%E2%80%99t-find-one). +### Decide what goes in the environment + +An environment carries a setup script, environment variables, and a network access level. Not everything a channel needs belongs there, so match each need to its place before you create one: + +| What the channel needs | Where to put it | +| :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| A tool installed before Claude starts, such as a runtime or a database client | The environment's setup script, a Bash script whose installs are on disk before Claude starts work | +| A value every session should see, such as a deployment target or a feature flag | The environment's environment variables, as `KEY=value` pairs, one per line | +| Web access without a credential | The environment's network access level; see [broad web access through the environment](/docs/claude-tag/admins/add-connections#broad-web-access-through-the-environment) | +| An API key, token, or other credential | A [connection](/docs/claude-tag/admins/add-connections), never an environment variable | +| Setup for one repository, such as installing its dependencies | That repository's `CLAUDE.md`; see [install project dependencies](/docs/claude-tag/admins/configure-github#install-project-dependencies) | + +Keep credentials out of environment variables because every session on the environment reads them and Claude can print them. There is no separate secrets store. A connection stores the credential outside the sandbox and attaches it to matching requests at the network layer, so Claude uses the service without holding the raw value. [Agent Proxy](/docs/claude-tag/concepts/agent-identity#agent-proxy) describes how. A connection also travels with the access bundle, so you choose channel by channel which sessions can use it. Repository-specific setup goes in `CLAUDE.md` so the people who maintain the repository keep it current. Claude reads it when it starts work in that repository. + +### Create the environment and choose it on a scope + +Creating the environment and choosing it on a scope happen on two different admin pages. Choose it on a channel to change only that channel's sessions, on a workspace to cover every channel in the workspace where you haven't chosen one, or on **Default Slack access** to cover every workspace. + + + + From the **Cloud environments** page in [admin settings](https://claude.ai/admin-settings), add an [organization-shared environment](https://code.claude.com/docs/en/cloud-environments#organization-shared-environments) and fill in its setup script, environment variables, and network access level. + + + + Open [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag), select the **Slack** tab under **Claude Tag's access**, and select the scope's row: the **Slack** row for **Default Slack access**, or the workspace or channel. Expand **Advanced** and pick the environment in the **Environment** picker. + + + + Start a fresh thread in the channel and ask Claude to use what you added, such as running the tool your setup script installed. Threads already underway keep the environment they started on, so an existing thread won't show the change. + + + +### Which environment a channel's sessions use + +When a session starts, Claude uses the first environment it finds, in this order: + +1. The channel's **Environment** setting +2. The workspace's **Environment** setting +3. The **Environment** setting on **Default Slack access** +4. The [organization's default environment](https://code.claude.com/docs/en/cloud-environments#the-default-environment), which an Owner chooses under **Cloud sessions** at [`claude.ai/admin-settings/claude-code`](https://claude.ai/admin-settings/claude-code) + +If you haven't chosen an environment on a scope, its picker shows **Organization default**, but sessions there may still run on an environment you chose on the workspace or on **Default Slack access**. In a channel where Claude runs with [channel-only access](/docs/claude-tag/admins/restrict-access#how-channel-only-works) because a guest is present, sessions run on the standard environment regardless of these settings. If a channel's sessions aren't on the environment you expect, see [channel sessions use the wrong environment](/docs/claude-tag/admins/troubleshooting#channel-sessions-use-the-wrong-environment-or-can%E2%80%99t-find-one). ## Auto mode allow rules diff --git a/content/claude/claude-tag/admins/restrict-access.md b/content/claude/claude-tag/admins/restrict-access.md index cd794895c..c70050b11 100644 --- a/content/claude/claude-tag/admins/restrict-access.md +++ b/content/claude/claude-tag/admins/restrict-access.md @@ -78,13 +78,13 @@ Six ways to stop Claude Tag from responding, ordered from quietest to most compl 1. **Ask it to stay quiet.** Saying "stay quiet in this thread unless tagged" stops Claude following an active thread. 2. **Remove it from the channel.** Run `/remove @Claude`. It can no longer read or post there. 3. **Set the scope's Claude Tag version to Off.** Claude stops responding in that scope even if someone invites it back; an @-mention gets a disabled notice instead of a reply. The control is on the scope's panel at [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag), and only an Owner can change it. -4. **Detach the scope.** The channel loses its elevated access and falls back to inherited baselines. +4. **Remove the channel's scope.** Choose **Remove this scope** from the scope's options menu. Claude keeps answering in the channel with the access it inherits from its workspace, and deletes the channel's sessions, memory, routines, and published artifacts; see [what each action deletes](/docs/claude-tag/concepts/data-lifecycle#actions-in-claude). To stop it answering as well, run `/remove @Claude` or set the scope's version to **Off** first. 5. **Delete the bundle.** This revokes its credentials everywhere it was attached (the credentials are removed; memory, routines, and transcripts are not). Running sessions may keep a revoked credential for a short window before the change propagates. 6. **Uninstall the app.** This removes Claude from the workspace and deletes the workspace's Claude data the same way [disconnecting the workspace](/docs/claude-tag/admins/workspaces#revoke-a-pairing) does. To keep Claude out of channels by name ahead of time, add a [blocked channel pattern](#block-or-auto-join-channels-by-name) instead. -Steps 1–4 do not delete any data. Step 5 (deleting a bundle) removes the credentials in that bundle; memory, routines, and session transcripts are unaffected. Removing Claude from a channel stops it responding there; the channel's memory and routines remain on record, and re-adding it restores them. To delete data without uninstalling, use the dedicated controls at [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag). +Steps 1–3 do not delete any data. Step 4 (removing the scope) deletes the channel's data. Step 5 (deleting a bundle) removes the credentials in that bundle; memory, routines, and session transcripts are unaffected. Removing Claude from a channel stops it responding there; the channel's memory and routines remain on record, and re-adding it restores them. To delete data without uninstalling, use the dedicated controls at [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag). ### Limit Claude Tag to specific channels @@ -145,6 +145,7 @@ Under every value, guests in the channel can read what Claude posts there. In an * No repositories, including any in a bundle attached to the channel, and no connectors set directly on the channel. * No instructions set on the workspace or the organization. Instructions set on the channel itself still apply. * No memory, including this channel's own, and no skills. +* No [environment set on the scope](/docs/claude-tag/admins/customize#configure-the-environment-for-a-scope). The session runs on the standard environment, so that environment's setup script, environment variables, and network access level don't apply while a guest is present. Claude decides this when a conversation starts. When no guest is in the channel, new conversations get its usual full access, as under **Allow**. A guest can talk to Claude by mentioning `@Claude` or by replying in a thread Claude started after a guest was in the channel, and Claude answers them. In a thread Claude began before the first guest joined, Claude stops replying while a guest is present, and a guest who writes there gets the same notice as under **Restrict**; start a new thread instead. While a guest is present, Claude replies only to mentions and to threads it's already part of; it doesn't pick up other channel messages on its own, even where [**Respond automatically**](/docs/claude-tag/users/when-claude-responds#turn-automatic-replies-on-or-off) is on. A guest can't approve a tool or permission request, or restart, mute, fork, or stop the session. If a guest clicks approve, nothing is granted and a workspace member has to ask Claude again. @@ -278,18 +279,19 @@ The [Audit page](/docs/claude-tag/admins/audit) at [`claude.ai/admin-settings/cl Creating bundles, binding them to scopes, and pairing workspaces need an Owner. A [channel manager](#delegate-channel-setup-to-channel-managers) configures only the channels assigned to them. Everything else happens inside the channel and is open to its members. The table lists each action and who can take it. -| Action | Owner | Channel manager | Channel member | -| :-------------------------------------------------------------------- | :------------------ | :---------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- | -| Pair a workspace | Yes | No | No | -| Create, rename, delete, or bind an Access bundle | Yes | Only to create a bundle for an assigned channel | No | -| Edit a bundle's Repositories, Plugins, or Instructions tab | Yes | No | No | -| Edit a bundle's Credentials or Domains tab | Yes | Credentials tab only, in a bundle created for an assigned channel | No | -| Add a channel manager | Yes | No | No | -| Set a channel's default model or repositories from the Configure page | Yes | Yes, in assigned channels | No | -| Write channel memory | Yes, in the channel | Yes, in the channel | Yes | -| Set channel instructions from the Configure link | Yes | Yes, in assigned channels | Yes, unless the scope's [Channel member edits](/docs/claude-tag/admins/attach-to-scope#restrict-who-can-set-channel-instructions) setting blocks it | -| Create, list, or disable a scheduled job in the channel | Yes, in the channel | Yes, in the channel | Yes | -| Remove Claude from a channel | Yes | Yes, with `/remove`, unless your Slack admin restricts it | Yes, with `/remove`, unless your Slack admin restricts it | +| Action | Owner | Channel manager | Channel member | +| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------ | :---------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- | +| Pair a workspace | Yes | No | No | +| Create, rename, delete, or bind an Access bundle | Yes | Only to create a bundle for an assigned channel | No | +| Edit a bundle's Repositories, Plugins, or Instructions tab | Yes | No | No | +| Edit a bundle's Credentials or Domains tab | Yes | Credentials tab only, in a bundle created for an assigned channel | No | +| Add a channel manager | Yes | No | No | +| Set a channel's default model or repositories from the Configure page | Yes | Yes, in assigned channels | No | +| Set a channel's default model by asking Claude in a thread, unless the scope's [Channel member edits](/docs/claude-tag/admins/attach-to-scope#restrict-who-can-set-channel-instructions) setting is **Block** | Yes | Yes | Yes | +| Write channel memory | Yes, in the channel | Yes, in the channel | Yes | +| Set channel instructions from the Configure link | Yes | Yes, in assigned channels | Yes, unless the scope's [Channel member edits](/docs/claude-tag/admins/attach-to-scope#restrict-who-can-set-channel-instructions) setting blocks it | +| Create, list, or disable a scheduled job in the channel | Yes, in the channel | Yes, in the channel | Yes | +| Remove Claude from a channel | Yes | Yes, with `/remove`, unless your Slack admin restricts it | Yes, with `/remove`, unless your Slack admin restricts it | Scheduled jobs run with the channel's credentials, so a member creating one can't reach anything the channel itself can't. diff --git a/content/claude/claude-tag/admins/troubleshooting.md b/content/claude/claude-tag/admins/troubleshooting.md index 21a1f11e5..49d38918b 100644 --- a/content/claude/claude-tag/admins/troubleshooting.md +++ b/content/claude/claude-tag/admins/troubleshooting.md @@ -613,7 +613,7 @@ Sessions in a channel start on an environment you didn't expect, or session star **What it means** -Each scope at [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag), on the **Slack** tab under **Claude Tag's access**, has an **Environment** picker (in the scope's **Advanced** section) that pins the Claude Code environment or runner pool that sessions in that scope use. A channel with no pin of its own inherits the nearest pin above it; with nothing pinned anywhere, sessions use the **Organization default**. The picker only lists environments scoped to the organization; an environment created under an individual account doesn't appear, because channel sessions run with no user account attached. +Sessions run on the environment or runner pool set on the nearest scope above them, or on the organization's default environment when none is set; [Configure the environment for a scope](/docs/claude-tag/admins/customize#configure-the-environment-for-a-scope) covers the picker. The picker only lists environments scoped to the organization; an environment created under an individual account doesn't appear, because channel sessions run with no user account attached. **How to resolve** diff --git a/content/claude/claude-tag/admins/workspaces.md b/content/claude/claude-tag/admins/workspaces.md index cdf2fa223..b15849e6c 100644 --- a/content/claude/claude-tag/admins/workspaces.md +++ b/content/claude/claude-tag/admins/workspaces.md @@ -74,7 +74,7 @@ In the **Connected workspaces** list, select **Disconnect** on the workspace's r * Its scopes, with their instructions and bundle bindings * The links between members' Slack and Claude accounts - Deletion starts as soon as you confirm and runs to completion in the background. This can't be undone. Routines a person set up in a direct message with Claude belong to that person's account and keep running; an admin can delete them from the [**Scheduled work** tab](/docs/claude-tag/admins/audit). + Deletion starts as soon as you confirm and runs to completion in the background. This can't be undone. Routines a person set up in a direct message with Claude belong to that person's account and keep running; an Owner can delete them from the [**Scheduled work** tab](/docs/claude-tag/admins/audit). Access bundles belong to your organization, not to a workspace, so they stay available to attach to other scopes; only their bindings to the deleted scopes go. diff --git a/content/claude/claude-tag/concepts/for-claude-code-users.md b/content/claude/claude-tag/concepts/for-claude-code-users.md index 5ecc56479..9d61a4f1c 100644 --- a/content/claude/claude-tag/concepts/for-claude-code-users.md +++ b/content/claude/claude-tag/concepts/for-claude-code-users.md @@ -29,7 +29,7 @@ A session begins with a fresh sandbox and no repository checked out. Your reposi ### How hooks run in the sandbox -Hooks run inside the sandbox, and every session runs on the same standard sandbox image, no matter which repository it clones. If a hook calls a command that the image doesn't include, add an install step for it to the repository's `CLAUDE.md`, as described in [Install project dependencies](/docs/claude-tag/admins/configure-github#install-project-dependencies). +Hooks run inside the sandbox. If a hook calls a command the sandbox doesn't include, ask an admin to add it to the setup script of the [environment the channel's sessions run on](/docs/claude-tag/admins/customize#configure-the-environment-for-a-scope). For a command only one repository needs, add an install step to that repository's `CLAUDE.md`, as described in [Install project dependencies](/docs/claude-tag/admins/configure-github#install-project-dependencies). ## Local settings versus admin settings @@ -41,15 +41,16 @@ The settings on your machine never load into a session, because a session runs i The table shows what takes the place of each setting from your machine. Where a counterpart exists, an admin sets it for the whole channel. -| Claude Code setting on your machine | In Claude Tag | -| :--------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `/model` | An admin sets the [default model per channel](/docs/claude-tag/admins/customize#choose-the-model-for-a-scope), and you can [switch models in a thread](/docs/claude-tag/users/models) | -| Effort level | Not configurable. Sessions run at the model's default effort. | -| MCP servers in `.mcp.json` | Not loaded, even when `.mcp.json` is checked into the repository. A session reaches external services only through the [connections an admin set for the channel](/docs/claude-tag/admins/add-connections), and each connection holds that service's credentials. | -| Secrets and API keys in your environment | An admin provisions them as channel connections. The raw key never enters the sandbox. It is [added to requests at the network layer](/docs/claude-tag/concepts/agent-identity#agent-proxy). | -| Environment variables and a personal `settings.json` | No counterpart. Every session runs on the same standard sandbox image, so there is no per-person environment to customize. Put non-secret setup in `CLAUDE.md` as [install steps](/docs/claude-tag/admins/configure-github#install-project-dependencies), and ask an admin to add secrets as connections. | -| A setup script for your workspace | No counterpart. Use `CLAUDE.md` install steps instead. | -| Permission prompts | Sessions run in auto mode, where Claude's permission checker reviews each action and can stop it. An admin pre-approves routine actions with [auto mode allow rules](/docs/claude-tag/admins/customize#auto-mode-allow-rules) instead of you approving in the moment. | +| Claude Code setting on your machine | In Claude Tag | +| :--------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `/model` | An admin sets the [default model per channel](/docs/claude-tag/admins/customize#choose-the-model-for-a-scope), and you can [switch models in a thread](/docs/claude-tag/users/models) | +| Effort level | Not configurable. Sessions run at the model's default effort. | +| MCP servers in `.mcp.json` | Not loaded, even when `.mcp.json` is checked into the repository. A session reaches external services only through the [connections an admin set for the channel](/docs/claude-tag/admins/add-connections), and each connection holds that service's credentials. | +| Secrets and API keys in your environment | An admin provisions them as channel connections. The raw key never enters the sandbox. It is [added to requests at the network layer](/docs/claude-tag/concepts/agent-identity#agent-proxy). | +| Environment variables | An admin sets them on the [environment the channel's sessions run on](/docs/claude-tag/admins/customize#configure-the-environment-for-a-scope), and every session in the channel reads them. There is no per-person environment to customize. The values are readable in every session on the environment, so ask an admin to add secrets as connections instead. | +| A personal `settings.json` | Not loaded. | +| A setup script for your workspace | An admin sets a setup script on the [environment the channel's sessions run on](/docs/claude-tag/admins/customize#configure-the-environment-for-a-scope), and what it installs is in place when each session in the channel starts. For setup that belongs to one repository, use `CLAUDE.md` [install steps](/docs/claude-tag/admins/configure-github#install-project-dependencies) instead. | +| Permission prompts | Sessions run in auto mode, where Claude's permission checker reviews each action and can stop it. An admin pre-approves routine actions with [auto mode allow rules](/docs/claude-tag/admins/customize#auto-mode-allow-rules) instead of you approving in the moment. | To change what a session can reach, ask an admin to [add a connection](/docs/claude-tag/admins/add-connections). The change applies to every session in the channel. diff --git a/content/claude/claude-tag/concepts/settings-map.md b/content/claude/claude-tag/concepts/settings-map.md index 246e5516d..cc1787faf 100644 --- a/content/claude/claude-tag/concepts/settings-map.md +++ b/content/claude/claude-tag/concepts/settings-map.md @@ -20,7 +20,7 @@ Claude Tag's settings live on claude.ai, split across a few pages that each own | The **Configure** link in the footer of any Claude reply in a channel | Channel members (unless an admin restricts editing) and [channel managers](/docs/claude-tag/admins/restrict-access#delegate-channel-setup-to-channel-managers) for their assigned channels | One channel's instructions and whether Claude replies there without an @-mention. Channel managers also set the channel's default model, repositories, and connections | | [Customize > Connectors](https://claude.ai/customize/connectors) on your own claude.ai account | You | Which of your personal tools apply in [DMs](/docs/claude-tag/concepts/agent-identity#direct-message-channels) | -Channel memory and routines aren't in the table because you change them by talking to Claude in the channel; see [what anyone can change from the channel](/docs/claude-tag/admins/customize#change-behavior-from-the-channel). Admins can review both, as each scope's memory files and scheduled work, from [the Audit page](/docs/claude-tag/admins/audit), labeled **Activity** in the console. +Channel memory and routines aren't in the table because you change them by talking to Claude in the channel; see [what anyone can change from the channel](/docs/claude-tag/admins/customize#change-behavior-from-the-channel). Owners can review both, as each scope's memory files and scheduled work, from [the Audit page](/docs/claude-tag/admins/audit), labeled **Activity** in the console. ## The Claude Tag admin page diff --git a/content/claude/claude-tag/users/getting-started.md b/content/claude/claude-tag/users/getting-started.md index a0d1b8bb1..956831dca 100644 --- a/content/claude/claude-tag/users/getting-started.md +++ b/content/claude/claude-tag/users/getting-started.md @@ -53,11 +53,11 @@ When a person first invites Claude to a channel, it posts a short intro on its o The footer under each reply names the model that handled it. You can [choose a different model](/docs/claude-tag/users/models) yourself, and admins [set the default model for each channel](/docs/claude-tag/admins/customize#choose-the-model-for-a-scope). In a channel, the footer also has a **Configure** link; open it to [tailor how Claude works in this channel](/docs/claude-tag/users/good-habits#configure-claude-for-a-channel). Replies in DMs and in org-shared channels have no Configure link. -| If you see | It means | Do this | -| :------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Typing `@Claude` doesn't show **Claude** with an **APP** badge in the suggestion list | The Claude app isn't installed in your workspace | Ask your Slack admin to install the Claude app, and send them [the installation guide](/docs/claude-tag/admins/pair-workspace#install-and-pair) | -| The mention sends but Claude doesn't reply | Setup isn't finished for this channel | Ask your Claude organization admin to enable Claude Tag for this channel, and send them [the setup guide](/docs/claude-tag/admins/setup-overview) with the channel name | -| Claude replies "I couldn't find a Claude Code environment for your account" | Your own claude.ai account has no cloud environment yet; this appears in DMs, which run on your account rather than the organization's | Sign in at [claude.ai/code](https://claude.ai/code) once, then try again | +| If you see | It means | Do this | +| :------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Typing `@Claude` doesn't show **Claude** with an **APP** badge in the suggestion list | The Claude app isn't installed in your workspace | Ask your Slack admin to install the Claude app, and send them [the installation guide](/docs/claude-tag/admins/pair-workspace#install-and-pair) | +| The mention sends but Claude doesn't reply | Setup isn't finished for this channel | Ask your Claude organization admin to enable Claude Tag for this channel, and send them [the setup guide](/docs/claude-tag/admins/setup-overview) with the channel name | +| Claude replies "I couldn't find a Claude Code environment for your account" | Claude couldn't resolve an environment for this DM; DMs run on your account rather than the organization's | Mention Claude again. If it keeps happening, see [I get an environment error in a DM](/docs/claude-tag/users/troubleshooting#i-get-an-environment-error-in-a-dm) | ## Hand Claude a task diff --git a/content/claude/claude-tag/users/memory.md b/content/claude/claude-tag/users/memory.md index 31b1aca17..b132a11ee 100644 --- a/content/claude/claude-tag/users/memory.md +++ b/content/claude/claude-tag/users/memory.md @@ -66,7 +66,7 @@ Two habits keep memory useful over time: * **After correcting an entry, have Claude record the fix.** "Update your memory for this channel so this doesn't happen again" turns a one-time fix into a standing one. * **Prune what your work has outgrown.** Entries written weeks ago can describe a repository, owner, or convention that no longer exists; review the memory list when the channel's work shifts. -An Admin in your Claude organization can view a scope's memory files at [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag), under the scope's options menu; only an Owner can edit or delete them. +An Owner in your Claude organization can view, edit, or delete a scope's memory files at [`claude.ai/admin-settings/claude-tag`](https://claude.ai/admin-settings/claude-tag), under the scope's options menu. ## Related resources diff --git a/content/claude/claude-tag/users/models.md b/content/claude/claude-tag/users/models.md index 71353cd18..b21eed3f0 100644 --- a/content/claude/claude-tag/users/models.md +++ b/content/claude/claude-tag/users/models.md @@ -34,7 +34,7 @@ To change what new threads in a channel start on, ask for the channel, not just @Claude use Sonnet for this thread, and make it the default model for this channel. ``` -Claude sets the channel's default model, which applies to new threads in that channel. Threads already underway keep the model they started with until someone in them asks Claude to switch. +Claude sets the channel's default model, which applies to new threads in that channel. Threads already underway keep the model they started with until someone in them asks Claude to switch. If an admin has set the scope's **Channel member edits** setting to **Block**, Claude declines to set the channel default; ask for the thread alone instead. Admins set the same default from claude.ai, per workspace or channel; see [choose the model for a scope](/docs/claude-tag/admins/customize#choose-the-model-for-a-scope). diff --git a/content/claude/claude-tag/users/use-cases/work-with-github.md b/content/claude/claude-tag/users/use-cases/work-with-github.md index 392651aaa..26571eeba 100644 --- a/content/claude/claude-tag/users/use-cases/work-with-github.md +++ b/content/claude/claude-tag/users/use-cases/work-with-github.md @@ -28,7 +28,7 @@ Check that the channel has the connection below. Ask `@Claude what can you acces | :--------- | :------- | :----------------------------------------------------------------- | | Code | GitHub | Required. Reads granted repositories and opens draft pull requests | -The same workflows apply to other source control systems. For GitLab, an admin [connects it with an access token](/docs/claude-tag/admins/connections/gitlab) instead of the GitHub App, and Claude clones its repositories the same way. +The GitHub connection is what lets Claude clone a repository. For GitLab, an admin [connects it with an access token](/docs/claude-tag/admins/connections/gitlab), and Claude reads projects, manages issues, and comments on merge requests through the GitLab API. If Claude replies that a repository isn't configured, the repository wasn't granted for this channel. An admin can [verify GitHub access](/docs/claude-tag/admins/configure-github#verify-github-access). After the grant changes, start a fresh thread and name the repository in the first message. diff --git a/content/claude/cowork/changelog.md b/content/claude/cowork/changelog.md index 3d868b01b..63f1b8f2e 100644 --- a/content/claude/cowork/changelog.md +++ b/content/claude/cowork/changelog.md @@ -6,6 +6,42 @@ > Release notes for Claude Desktop + + **General** + + * No user-facing changes. + + **Code** + + * No user-facing changes. + + **Cowork** + + * No user-facing changes. + + **3P** + + * No user-facing changes. + + + + **General** + + * No user-facing changes. + + **Code** + + * No user-facing changes. + + **Cowork** + + * No user-facing changes. + + **3P** + + * No user-facing changes. + + **General** @@ -22,7 +58,7 @@ **3P** - * No user-facing changes. + * Added support for the `inferenceModelPricing` rates and the `inferenceModelPricingMultiplier` discount in the Usage page's cost estimate; in 1.37937.0 the estimate always used Anthropic list price. @@ -60,7 +96,7 @@ * Added `skipWebFetchPreflight`. When enabled, Code sessions no longer contact api.anthropic.com before fetching a web page, which fixes page fetches failing on networks that block that host. Off by default. * Added `userPluginMarketplacesEnabled` and `userPluginUploadsEnabled`, which control whether members can add their own plugin marketplaces and upload their own plugins; when off, the add options are hidden and adds are refused. Unset keys change nothing. * Added Code tab features already available in the standard app: the Files panel with Show in Files, emoji autocomplete and inline prompt suggestions in the composer, interactive MCP app widgets in the conversation, and letting Claude read output from the integrated terminal panel. - * Added cost estimates to the Usage page: `inferenceModelPricingEnabled` shows an estimated cost alongside token counts, priced at Anthropic list price; `inferenceModelPricing` supplies per-model rates and `inferenceModelPricingMultiplier` scales every estimate (a number between 0 and 1). The two rate keys take effect in a future release; until then estimates use list price. Off by default. + * Added cost estimates to the Usage page: `inferenceModelPricingEnabled` shows an estimated cost alongside token counts, priced at Anthropic list price; `inferenceModelPricing` supplies per-model rates and `inferenceModelPricingMultiplier` scales every estimate (a number between 0 and 1). The two rate keys take effect from 1.37937.1; in 1.37937.0 estimates use list price. Off by default. * Added suggestions for plugins and skills from your organization's own library in chat. * Added support for plugin marketplace credential helpers that return a username or `authtype=Bearer`, so marketplaces hosted on Bitbucket Data Center or behind GitLab deploy tokens can authenticate. * Added the `disableDesktopLocalSessions` setting to Claude Code's `managed-settings.json`, which turns off Code sessions that run on the device itself so the Code tab offers only remote environments such as SSH; the environment menu shows Local greyed out with a "Disabled by your organization" explanation. diff --git a/content/claude/government/config/overview.md b/content/claude/government/config/overview.md index 63117d167..b27400cec 100644 --- a/content/claude/government/config/overview.md +++ b/content/claude/government/config/overview.md @@ -26,7 +26,12 @@ Settings combine across the chain in one of three ways, and the kind is fixed pe A **lock** prevents levels below from changing a setting. When you lock a setting at your level it shows as **Enforced** to you, and levels below see it as **Managed**, which means it is read-only for them. Any value a lower level had previously set is ignored while your lock is in place, and it comes back into effect if you later remove the lock. -A tenant lock makes the setting read-only for every organization. A lock you set at the organization level prevents any group-level value within your organization from taking priority over it. +How far a lock reaches depends on where you set it: + +* **On the tenant Config page**, the lock reaches everyone in the tenant. The setting becomes read-only for every organization and at both group levels. +* **On a tenant-wide group setting**, the lock reaches the people that group's settings apply to. They get the locked value even if their organization has set a different one, and organizations cannot set their own value for that group while the lock is in place. Other people in those organizations are not affected. + +A group lock does not keep anyone on that group's settings. If someone in the group also belongs to a higher-priority group that has any configuration, that group's settings apply to them instead and the lock does not, as described under [When someone belongs to more than one group](#when-someone-belongs-to-more-than-one-group). **Locked by Anthropic** is the **Managed** state when the lock was applied by Anthropic at the application level rather than by your own tenant. It appears on features that are not available in Claude for Government, and only Anthropic can change or unlock those settings. @@ -76,19 +81,25 @@ In addition to setting values for your whole tenant or organization, you can set There are two kinds of group level: -* **Tenant-wide group settings** sit between the tenant and the organization in the chain. A value set here takes priority over the tenant default for the group's members, in every organization they belong to. Tenant administrators manage these. +* **Tenant-wide group settings** sit between the tenant and the organization in the chain. A value set here takes priority over the tenant default for the group's members, in every organization. Tenant administrators manage these. * **Organization group settings** are scoped to one organization. A value set here applies only to people who are both a member of the group and a member of that organization, and it is the most specific level in the chain. Organization owners manage these for their own organization and see the same list of groups the tenant does. To edit settings for a group, open the scope bar above the settings list and choose the group's name from the dropdown. The page switches to show the same settings editor, now scoped to that group. Editing, saving, resetting, and locking all work the same way as at the other levels. Anything locked at a higher level still shows as **Managed** here and cannot be changed. +You can also add connectors for a group's members from the **Connectors** card while the page is scoped to the group. See [Who receives a connector](/docs/government/connectors/overview#who-receives-a-connector) for which members a group's connectors reach. + ### When someone belongs to more than one group -Only one group's settings apply to any given person. When someone is a member of more than one group, the settings from their highest-priority group that has any configuration are used, and the other groups are ignored for that person. The priority order is set by a tenant administrator on the [Identity and access](/docs/government/tenant-admin/identity-and-access) page by dragging the groups into the order they want. The same priority order is used wherever configuration is resolved for a person; seat-tier group mappings on the [Provisioning](/docs/government/org-admin/provisioning) page use a separate fixed order. At the organization level the priority order is shown for reference and cannot be reordered there. +Only one group's settings apply to any given person. When someone is a member of more than one group, the settings from their highest-priority group that has any configuration are used, and the other groups are ignored for that person. A group has configuration for a person once any setting is set or locked for it, either as a tenant-wide group setting or as an organization group setting in that person's organization. + +When a higher-priority group gains configuration for someone, it takes the place of the lower-priority group that applied to them before, and the lower-priority group's settings, including locked ones, stop applying to them. Removing a group's last setting, changing the priority order, or changing someone's group memberships in your identity provider can change which group applies to a person in the same way. + +The priority order is set by a tenant administrator on the [Identity and access](/docs/government/tenant-admin/identity-and-access) page by dragging the groups into the order they want. The same priority order is used wherever configuration is resolved for a person; seat-tier group mappings on the [Provisioning](/docs/government/org-admin/provisioning) page use a separate fixed order. At the organization level the priority order is shown for reference and cannot be reordered there. If no groups appear in the scope bar dropdown, none have been synced from the identity provider yet. Connect SCIM on the Identity and access page and push groups from your directory, and they will appear automatically. - Two settings, **Organization instructions** and **Organization Analytics connector**, can be set at the tenant and organization levels but not at either group level. + The **Organization instructions** and **Organization Analytics connector** settings can be set at the tenant and organization levels, but not at either group level. The **Plugins** card is read-only when you view a group, and the group's members receive the plugins added for their organization and tenant. ## What differs between the tenant and organization levels @@ -99,7 +110,7 @@ The Config page shows the same list of settings at both levels, and almost all o * **Preview impact appears only at the tenant level.** See [Previewing impact](#previewing-impact) above. * **Group priority is set at the tenant level.** Organization owners see the priority order for reference but cannot change it. * **Tenant administrators can open any organization's Config page** and act on that organization's behalf. Organization owners see only their own organization. -* **Inherited plugins are labeled at the organization level.** Plugins the tenant has added appear under a **From levels above** heading on the organization page; see [Tool and connector cards](/docs/government/config/settings#tool-and-connector-cards). +* **Inherited connectors and plugins are labeled at the organization level.** Connectors and plugins the tenant has added appear on the organization page with an **Inherited from your tenant** badge; see [The Connectors card](/docs/government/connectors/overview#the-connectors-card) and [Tool and connector cards](/docs/government/config/settings#tool-and-connector-cards). For more detail see [Config at the tenant level](/docs/government/tenant-admin/configuration) and [Config at the organization level](/docs/government/org-admin/configuration). diff --git a/content/claude/government/connectors/overview.md b/content/claude/government/connectors/overview.md index ddba8e9f6..b53de1468 100644 --- a/content/claude/government/connectors/overview.md +++ b/content/claude/government/connectors/overview.md @@ -14,9 +14,23 @@ A **connector** is a link between Claude and an external service. The service ru ## The Connectors card -The **Connectors** card appears on your [tenant](/docs/government/tenant-admin/configuration) or [organization](/docs/government/org-admin/configuration) Config page alongside the built-in connector cards. It lists every connector you have added, with each one's name, address, the products it applies to, and a summary of how many of its tools are allowed. Click **Add connector** to open the wizard, or click the edit icon next to a connector to change it. +The **Connectors** card appears on your [tenant](/docs/government/tenant-admin/configuration) or [organization](/docs/government/org-admin/configuration) Config page alongside the built-in connector cards, and on the Config page for each [directory group](/docs/government/config/overview#group-specific-settings). It lists the connectors added at the level you are viewing and the connectors that level inherits, with each one's name, address, the products it applies to, and a summary of how many of its tools are allowed. Click **Add connector** to open the wizard, or click the edit icon next to a connector added at this level to change it. -Connectors are set at the tenant or organization level. When you are viewing a group scope, the card is read-only and points you to the organization or tenant settings where connectors are configured. +An inherited connector has a badge that says where it comes from, such as **Inherited from your tenant** or **Inherited from your organization**, in place of the edit and remove controls. To change an inherited connector for the members at your level, click **Add connector** and create one with the same name. The inherited connector's details and stored secret are not copied, so you enter the server address and authentication again. Your entry then replaces the inherited one in the list and takes priority over it, as described under [Who receives a connector](#who-receives-a-connector). + +## Who receives a connector + +Who receives a connector depends on where you add it: + +* On the tenant Config page, it reaches the members of every organization in the tenant. +* On an organization's Config page, it reaches every member of that organization. +* On the Config page for a [directory group](/docs/government/config/overview#group-specific-settings), it reaches that group's members: in every organization when you open the group from the tenant Config page (a tenant-wide group setting), or only in one organization when you open the group from that organization's Config page (an organization group setting). + +In every case it is delivered only to the products you select, with the tool policy you set. + +When the same connector name is added at more than one level, each member receives only the entry from the most specific level that applies to them: the organization's group settings first, then the organization, then the tenant-wide group settings, then the tenant. That entry replaces the others as a whole, including its address, authentication, products, and tool policy. You cannot remove a connector inherited from a level above, but you can stop it from reaching the members at your level by adding one with the same name and selecting no products under **Apply to**. + +A connector added for a group does not always reach every member of the group. Someone who belongs to more than one directory group receives group settings, connectors included, from only one of them: their [highest-priority group](/docs/government/config/overview#when-someone-belongs-to-more-than-one-group) that has any configuration. Adding a group's first connector or deleting its last one can therefore change which group, and so which group settings, apply to some members. The group's Config page shows a note when this could happen. To check which group applies to a particular member, use the person lookup described under [Comparing settings across levels](/docs/government/config/overview#comparing-settings-across-levels). ## Adding a connector @@ -57,4 +71,4 @@ Click **Save** to create the connector. It appears in the **Connectors** card an ## Editing and removing a connector -Click the edit icon next to a connector in the card to open the same wizard with its current values filled in. Changing the authentication method clears any stored secret and the app details saved for **OAuth (pre-registered app)**. Click the remove button next to a connector to delete it; it is withdrawn from every product at the next refresh. +Click the edit icon next to a connector in the card to open the same wizard with its current values filled in. Changing the authentication method clears any stored secret and the app details saved for **OAuth (pre-registered app)**. Click the remove button next to a connector to delete it; it is withdrawn from every product at the next refresh. If you delete a connector that takes priority over an inherited connector with the same name, the inherited connector applies again from that refresh. diff --git a/content/claude/government/org-admin/configuration.md b/content/claude/government/org-admin/configuration.md index 5a6a7fd91..55bfd0528 100644 --- a/content/claude/government/org-admin/configuration.md +++ b/content/claude/government/org-admin/configuration.md @@ -18,7 +18,7 @@ The Config page works the same way at the tenant and organization levels, with t **Settings only the tenant can change.** [Let organizations manage their own seat tiers](/docs/government/config/settings#let-organizations-manage-their-own-seat-tiers) and [Compliance API](/docs/government/config/settings#compliance-api) are always read-only here, regardless of whether they are locked. -**Inherited plugins.** Plugins the tenant has added are labeled **Inherited from your tenant** and cannot be changed from here. See [Tool and connector cards](/docs/government/config/settings#tool-and-connector-cards). +**Inherited connectors and plugins.** Connectors and plugins the tenant has added are labeled **Inherited from your tenant** and cannot be changed from here. A connector or plugin you add with the same name takes priority over the inherited one for your members. See [The Connectors card](/docs/government/connectors/overview#the-connectors-card) and [Tool and connector cards](/docs/government/config/settings#tool-and-connector-cards). **Group settings within your organization.** A value you set for a directory group at this level applies only to people who are both a member of the group and a member of your organization, and it is the most specific level in the chain. Group priority is set by your tenant administrator and is shown here for reference; you cannot reorder it from the organization portal. See [Group-specific settings](/docs/government/config/overview#group-specific-settings). diff --git a/content/claude/third-party/claude-desktop/configuration-changelog.md b/content/claude/third-party/claude-desktop/configuration-changelog.md index d4b9c94a5..565695011 100644 --- a/content/claude/third-party/claude-desktop/configuration-changelog.md +++ b/content/claude/third-party/claude-desktop/configuration-changelog.md @@ -8,6 +8,14 @@ Configuration keys by Claude Desktop release. Each section lists keys added in that release, with the MDM key name (for plist/registry deployment) and the equivalent JSON shape (for local-file or bootstrap remote configuration). + + No configuration changes in this release. + + + + No configuration changes in this release. + + No configuration changes in this release. diff --git a/content/en/agents-and-tools/mcp-connector.md b/content/en/agents-and-tools/mcp-connector.md index 5709c4d65..c9b0538d0 100644 --- a/content/en/agents-and-tools/mcp-connector.md +++ b/content/en/agents-and-tools/mcp-connector.md @@ -8,8 +8,7 @@ description: Connect to remote MCP servers directly from the Messages API withou - Status: Beta - [Beta header](https://platform.claude.com/docs/en/api/beta-headers): `mcp-client-2025-11-20` - [ZDR](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention): not eligible -- Platforms: Claude API (beta), Claude Platform on AWS (beta), Microsoft Foundry (beta) [1]; not available on Amazon Bedrock, Google Cloud -1. On [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry), the MCP connector requires a [Hosted on Anthropic deployment](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#additional-features-not-supported-when-hosted-on-azure). +- Platforms: Claude API (beta), Claude Platform on AWS (beta), Microsoft Foundry (beta); not available on Amazon Bedrock, Google Cloud Claude's Model Context Protocol (MCP) connector feature enables you to connect to remote MCP servers directly from the Messages API without a separate MCP client. diff --git a/content/en/agents-and-tools/tool-use/browser-use-tool.md b/content/en/agents-and-tools/tool-use/browser-use-tool.md index 26c1ab234..a3bde02f6 100644 --- a/content/en/agents-and-tools/tool-use/browser-use-tool.md +++ b/content/en/agents-and-tools/tool-use/browser-use-tool.md @@ -7,7 +7,7 @@ description: Let Claude navigate, read, and interact with webpages in your own b ## Compatibility - [ZDR](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention): eligible (excludes [Covered Models](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#model-specific-data-retention-requirements)) - Supported models: `claude-fable-5`, `claude-mythos-5`, `claude-opus-5`, `claude-sonnet-5`, `claude-opus-4-8` -- Platforms: Claude API; not available on Claude Platform on AWS, Amazon Bedrock, Google Cloud, Microsoft Foundry +- Platforms: Claude API, Google Cloud; not available on Claude Platform on AWS, Amazon Bedrock, Microsoft Foundry The browser use tool lets Claude navigate, read, and interact with webpages in a browser that your application runs. It works with the page both through its structure (the accessibility tree, elements, forms, and tabs) and through pixels (screenshots and viewport coordinates), whereas the [computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) works with a whole desktop through screenshots and coordinates alone. It's an Anthropic-defined [client toolset](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-reference#client-toolsets): one `browser_toolset_20260801` entry in your `tools` array gives Claude 27 member tools by default, such as `navigate`, `read_page`, `left_click`, and `screenshot`, plus four more (`javascript_exec`, `file_upload`, `read_console`, and `read_network`) when you [enable them](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool#enable-optional-member-tools). Your application runs every call against its own browser automation; nothing runs on Anthropic's side. It isn't currently available in [Claude Managed Agents](https://platform.claude.com/docs/en/managed-agents/tools). This page says "your application" for the agent loop that calls the Messages API and "your executor" for the part of it that drives the browser and produces tool results. @@ -17,7 +17,7 @@ With browser use, Claude reads and acts on live webpages, so everything a page s ## Quick start -The browser use tool is available on the Claude API with no beta header: add one entry of type `browser_toolset_20260801`, with no `name`, to the `tools` array of a [Messages API](https://platform.claude.com/docs/en/api/messages/create) request. +The browser use tool is available on the Claude API and [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai): add one entry of type `browser_toolset_20260801`, with no `name`, to the `tools` array of a [Messages API](https://platform.claude.com/docs/en/api/messages/create) request. ```bash cURL @@ -1529,7 +1529,7 @@ The API validates the toolset entry and every member `tool_use` and `tool_result ## Limitations -* **Platform availability:** Browser use is available on the Claude API only. +* **Platform availability:** Browser use is available on the Claude API and [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai). * **Whole-input streaming only:** When you stream, each member's `input` arrives as one complete `input_json_delta` ([Client toolsets](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-reference#client-toolsets)). * **Element references are best-effort:** Highly dynamic pages (virtualized lists, canvas-rendered interfaces, pages that re-render on scroll) might not expose stable references, and Claude falls back to screenshots and coordinate clicks there. * **`read_console` and `read_network` depend on your browser automation:** They report only what it can capture, and only from the moment it attached to a tab. diff --git a/content/en/agents-and-tools/tool-use/computer-use-tool.md b/content/en/agents-and-tools/tool-use/computer-use-tool.md index 395d344c4..70ab11915 100644 --- a/content/en/agents-and-tools/tool-use/computer-use-tool.md +++ b/content/en/agents-and-tools/tool-use/computer-use-tool.md @@ -7,9 +7,9 @@ description: Give Claude screenshot, mouse, and keyboard control of a desktop en ## Compatibility - [ZDR](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention): eligible (excludes [Covered Models](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#model-specific-data-retention-requirements)) - Supported models: `claude-fable-5`, `claude-mythos-5`, `claude-opus-5`, `claude-sonnet-5`, `claude-opus-4-8` -- Platforms: Claude API, Claude Platform on AWS (beta), Amazon Bedrock (beta), Google Cloud (beta), Microsoft Foundry (beta) +- Platforms: Claude API, Claude Platform on AWS (beta), Amazon Bedrock (beta), Google Cloud, Microsoft Foundry (beta) - Claude Opus 4.7, Claude Opus 4.6, Claude Sonnet 4.6, and Claude Opus 4.5 support computer use only through the earlier `computer_20251124` tool version, which requires a beta header; see [Earlier tool versions](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#earlier-tool-versions). -- Platforms other than the Claude API currently offer only the [earlier beta tool versions](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#earlier-tool-versions). +- Platforms other than the Claude API and Google Cloud currently offer only the [earlier beta tool versions](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#earlier-tool-versions). Claude can interact with computer environments through the computer use tool, which provides screenshot capabilities and mouse/keyboard control for autonomous desktop interaction. @@ -18,7 +18,7 @@ The computer use tool is an Anthropic-defined [client toolset](https://platform. For tasks that stay inside webpages, the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) is the closer fit: its member tools read and act on the page itself, and it doesn't need a full desktop environment. - Computer use is available on the Claude API as the `computer_toolset_20260801` toolset, with no beta header; see [Compatibility](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#compatibility) for the supported models. + Computer use is available on the Claude API and [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai) as the `computer_toolset_20260801` toolset; see [Compatibility](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#compatibility) for the supported models. Existing `computer_20251124` integrations keep working, and earlier tool versions remain available in beta for models and platforms that don't support the toolset. See [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124) to upgrade, or [Earlier tool versions](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#earlier-tool-versions) for the beta headers. diff --git a/content/en/agents-and-tools/tool-use/web-fetch-tool.md b/content/en/agents-and-tools/tool-use/web-fetch-tool.md index 5dd4c60e4..e69869343 100644 --- a/content/en/agents-and-tools/tool-use/web-fetch-tool.md +++ b/content/en/agents-and-tools/tool-use/web-fetch-tool.md @@ -12,7 +12,7 @@ The web fetch tool allows Claude to retrieve full content from specified web pag The latest web fetch tool version (`web_fetch_20260318`) supports **dynamic filtering** with Claude Fable 5, Claude Opus 4.8, Claude Mythos 5, [Claude Mythos Preview](https://anthropic.com/glasswing), Claude Opus 4.7, Claude Opus 4.6, Claude Sonnet 5, and Claude Sonnet 4.6. Claude can write and execute code to filter fetched content before it reaches the context window, keeping only relevant information and discarding the rest. This reduces token consumption while maintaining response quality. `web_fetch_20260318` also adds [response inclusion](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool#response-inclusion) control for agentic workflows. The previous versions (`web_fetch_20260309` for dynamic filtering and [cache bypass](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool#cache-bypass), `web_fetch_20260209` for dynamic filtering only, `web_fetch_20250910` for basic fetch) remain available. -Web fetch (with and without dynamic filtering) is available on the Claude API, [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). On Microsoft Foundry, web fetch requires a [Hosted on Anthropic deployment](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#additional-features-not-supported-when-hosted-on-azure). It is not currently available on Amazon Bedrock or Google Cloud. +Web fetch (with and without dynamic filtering) is available on the Claude API, [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). On Microsoft Foundry, deployments [hosted on Azure](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#additional-features-not-supported-when-hosted-on-azure) support only the basic web fetch tool (`web_fetch_20250910`, without dynamic filtering). Deployments hosted on Anthropic support all versions. Web fetch is not currently available on Amazon Bedrock or Google Cloud. For [Claude Mythos Preview](https://anthropic.com/glasswing), web fetch is available on the Claude API and Microsoft Foundry. It is not currently available for Mythos Preview on Amazon Bedrock or Google Cloud. diff --git a/content/en/agents-and-tools/tool-use/web-search-tool.md b/content/en/agents-and-tools/tool-use/web-search-tool.md index 3d6fef328..6910e9acf 100644 --- a/content/en/agents-and-tools/tool-use/web-search-tool.md +++ b/content/en/agents-and-tools/tool-use/web-search-tool.md @@ -63,7 +63,7 @@ Dynamic filtering runs web search from inside [code execution](https://platform. To call web search directly, without dynamic filtering, set `allowed_callers: ["direct"]`. Models that don't support programmatic tool calling require this setting. Without it, the API returns a 400 error that tells you to set it. - The web search tool (with and without dynamic filtering) is available on the Claude API, [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). On Microsoft Foundry, web search requires a [Hosted on Anthropic deployment](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#additional-features-not-supported-when-hosted-on-azure). On Google Cloud, only the basic web search tool (without dynamic filtering) is available. Web search is not available on Amazon Bedrock. + The web search tool (with and without dynamic filtering) is available on the Claude API, [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). On Microsoft Foundry, deployments [hosted on Azure](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#additional-features-not-supported-when-hosted-on-azure) support only the basic web search tool (`web_search_20250305`, without dynamic filtering). Deployments hosted on Anthropic support all versions. On Google Cloud, only the basic web search tool (without dynamic filtering) is available. Web search is not available on Amazon Bedrock. The following examples use `web_search_20260318`: diff --git a/content/en/api/beta.md b/content/en/api/beta.md index 210f8ddc6..f20eea6ff 100644 --- a/content/en/api/beta.md +++ b/content/en/api/beta.md @@ -4,11 +4,11 @@ ### Anthropic Beta -- `AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` +- `AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -78,6 +78,20 @@ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Beta API Error - `BetaAPIError object` @@ -436,7 +450,7 @@ The Models API response can be used to determine which models are available for - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -506,6 +520,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaModelInfo` @@ -770,7 +798,7 @@ The Models API response can be used to determine information about a specific mo - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -840,6 +868,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaModelInfo object` @@ -1083,7 +1125,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1153,6 +1195,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -2833,7 +2889,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -2841,6 +2897,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -2849,7 +2907,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -2857,6 +2915,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `Default = "default"` - `inference_geo: optional string or null` @@ -6367,12 +6427,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -6682,12 +6744,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: number` The cumulative number of output tokens which were used. @@ -7034,7 +7098,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -7104,6 +7168,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -8708,7 +8786,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -8716,6 +8794,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -8724,7 +8804,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -8732,6 +8812,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice: optional BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -10768,7 +10850,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -10838,6 +10920,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -12538,7 +12634,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12546,6 +12642,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -12554,7 +12652,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12562,6 +12660,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `Default = "default"` - `inference_geo: optional string or null` @@ -14837,7 +14937,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -14907,6 +15007,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch object` @@ -15083,7 +15197,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -15153,6 +15267,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaMessageBatch` @@ -15338,7 +15466,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -15408,6 +15536,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch object` @@ -15575,7 +15717,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -15645,6 +15787,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDeletedMessageBatch object` @@ -15704,7 +15860,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -15774,6 +15930,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatchIndividualResponse object` @@ -17209,12 +17379,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -17599,7 +17771,7 @@ Create Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -17669,6 +17841,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `model: BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams` @@ -18996,7 +19182,7 @@ List Agents - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -19066,6 +19252,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaManagedAgentsAgent` @@ -19717,7 +19917,7 @@ Get Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -19787,6 +19987,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent object` @@ -20421,7 +20635,7 @@ Update Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -20491,6 +20705,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `description: optional string or null` @@ -21791,7 +22019,7 @@ Archive Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -21861,6 +22089,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent object` @@ -22510,7 +22752,7 @@ List Agent Versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -22580,6 +22822,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaManagedAgentsAgent` @@ -23221,7 +23477,7 @@ Create a new environment with the specified configuration. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -23291,6 +23547,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `name: string` @@ -23343,7 +23613,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: optional boolean or null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` @@ -23355,6 +23625,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string or null` Ubuntu/Debian packages to install @@ -23656,7 +23928,7 @@ List environments with pagination support. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -23726,6 +23998,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaEnvironment` @@ -23945,7 +24231,7 @@ Retrieve a specific environment by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -24015,6 +24301,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironment object` @@ -24225,7 +24525,7 @@ Update an existing environment's configuration. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -24295,6 +24595,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null` @@ -24341,7 +24655,7 @@ Update an existing environment's configuration. - `allow_package_managers: optional boolean or null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` @@ -24353,6 +24667,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string or null` Ubuntu/Debian packages to install @@ -24629,7 +24945,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -24699,6 +25015,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironmentDeleteResponse object` @@ -24752,7 +25082,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -24822,6 +25152,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironment object` @@ -25039,7 +25383,7 @@ Retrieve detailed information about a specific work item. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -25109,6 +25453,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork object` @@ -25259,7 +25617,7 @@ Long poll for work items in the queue. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -25329,6 +25687,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"Anthropic-Worker-ID": optional string` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -25471,7 +25843,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -25541,6 +25913,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork object` @@ -25690,7 +26076,7 @@ Record a heartbeat for a work item to maintain the lease. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -25760,6 +26146,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkHeartbeatResponse object` @@ -25842,7 +26242,7 @@ Stop a work item, initiating graceful or forced shutdown. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -25912,6 +26312,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `force: optional boolean` @@ -26070,7 +26484,7 @@ List work items in an environment. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -26140,6 +26554,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkListResponse object` @@ -26287,7 +26715,7 @@ Update work item metadata with merge semantics. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -26357,6 +26785,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `metadata: map[string]` @@ -26503,7 +26945,7 @@ Get statistics about the work queue for an environment. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -26573,6 +27015,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkQueueStats object` @@ -26642,7 +27098,7 @@ Create Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -26712,6 +27168,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams` @@ -28813,7 +29283,7 @@ List Sessions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -28883,6 +29353,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsSession` @@ -29952,7 +30436,7 @@ Get Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -30022,6 +30506,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSession object` @@ -31077,7 +31575,7 @@ Update Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -31147,6 +31645,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `agent: optional BetaManagedAgentsSessionAgentUpdate` @@ -32646,7 +33158,7 @@ Delete Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -32716,6 +33228,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedSession object` @@ -32763,7 +33289,7 @@ Archive Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -32833,6 +33359,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSession object` @@ -33939,7 +34479,7 @@ List Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -34009,6 +34549,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsSessionEvent` @@ -36200,7 +36754,7 @@ Send Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -36270,6 +36824,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `events: array of BetaManagedAgentsEventParams` @@ -37151,7 +37719,7 @@ Stream Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -37221,6 +37789,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` @@ -39450,7 +40032,7 @@ Add Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -39520,6 +40102,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `file_id: string` @@ -39618,7 +40214,7 @@ List Session Resources - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -39688,6 +40284,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaManagedAgentsSessionResource` @@ -39859,7 +40469,7 @@ Get Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -39929,6 +40539,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsGitHubRepositoryResource object` @@ -40079,7 +40703,7 @@ Update Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -40149,6 +40773,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `authorization_token: string` @@ -40311,7 +40949,7 @@ Delete Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -40381,6 +41019,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeleteSessionResource object` @@ -40442,7 +41094,7 @@ List Session Threads - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -40512,6 +41164,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsSessionThread` @@ -40524,7 +41190,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -41271,7 +41937,7 @@ Get Session Thread - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -41341,6 +42007,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread object` @@ -41353,7 +42033,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -42091,7 +42771,7 @@ Archive Session Thread - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -42161,6 +42841,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread object` @@ -42173,7 +42867,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -42926,7 +43620,7 @@ List Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -42996,6 +43690,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsSessionEvent` @@ -45188,7 +45896,7 @@ Stream Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -45258,6 +45966,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` @@ -47483,7 +48205,7 @@ Create Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -47553,6 +48275,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `agent: string or BetaManagedAgentsAgentParams` @@ -48618,7 +49354,7 @@ List Deployments - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -48688,6 +49424,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaManagedAgentsDeployment` @@ -49307,7 +50057,7 @@ Get Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -49377,6 +50127,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment object` @@ -49987,7 +50751,7 @@ Update Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -50057,6 +50821,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `agent: optional string or BetaManagedAgentsAgentParams` @@ -51071,7 +51849,7 @@ Archive Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -51141,6 +51919,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment object` @@ -51752,7 +52544,7 @@ Run Deployment Now - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -51822,6 +52614,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeploymentRun object` @@ -52099,7 +52905,7 @@ Pause Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -52169,6 +52975,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment object` @@ -52780,7 +53600,7 @@ Unpause Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -52850,6 +53670,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment object` @@ -53511,7 +54345,7 @@ List Deployment Runs - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -53581,6 +54415,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaManagedAgentsDeploymentRun` @@ -53866,7 +54714,7 @@ Get Deployment Run - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -53936,6 +54784,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeploymentRun object` @@ -54210,7 +55072,7 @@ Create Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -54280,6 +55142,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `display_name: string` @@ -54392,7 +55268,7 @@ List Vaults - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -54462,6 +55338,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsVault` @@ -54552,7 +55442,7 @@ Get Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -54622,6 +55512,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsVault object` @@ -54703,7 +55607,7 @@ Update Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -54773,6 +55677,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `display_name: optional string or null` @@ -54873,7 +55791,7 @@ Delete Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -54943,6 +55861,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedVault object` @@ -54992,7 +55924,7 @@ Archive Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -55062,6 +55994,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsVault object` @@ -55146,7 +56092,7 @@ Create Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -55216,6 +56162,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams` @@ -55624,7 +56584,7 @@ List Credentials - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -55694,6 +56654,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsCredential` @@ -55909,7 +56883,7 @@ Get Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -55979,6 +56953,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential object` @@ -56185,7 +57173,7 @@ Update Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -56255,6 +57243,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams` @@ -56602,7 +57604,7 @@ Delete Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -56672,6 +57674,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedCredential object` @@ -56723,7 +57739,7 @@ Archive Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -56793,6 +57809,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential object` @@ -57000,7 +58030,7 @@ Validate Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -57070,6 +58100,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredentialValidation object` @@ -57213,7 +58257,7 @@ Create a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -57283,6 +58327,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `name: string` @@ -57415,7 +58473,7 @@ List memory stores - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -57485,6 +58543,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsMemoryStore` @@ -57580,7 +58652,7 @@ Retrieve a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -57650,6 +58722,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryStore object` @@ -57736,7 +58822,7 @@ Update a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -57806,6 +58892,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `description: optional string or null` @@ -57912,7 +59012,7 @@ Delete a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -57982,6 +59082,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedMemoryStore object` @@ -58031,7 +59145,7 @@ Archive a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -58101,6 +59215,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryStore object` @@ -58200,7 +59328,7 @@ Create a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -58270,6 +59398,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `content: string or null` @@ -58314,7 +59456,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -58411,7 +59553,7 @@ List memories - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -58481,6 +59623,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsMemoryListItem` @@ -58517,7 +59673,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -58610,7 +59766,7 @@ Retrieve a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -58680,6 +59836,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemory object` @@ -58712,7 +59882,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -58786,7 +59956,7 @@ Update a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -58856,6 +60026,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `content: optional string or null` @@ -58910,7 +60094,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -58982,7 +60166,7 @@ Delete a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -59052,11 +60236,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedMemory object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -59161,7 +60359,7 @@ List memory versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -59231,6 +60429,20 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsMemoryVersion` @@ -59249,7 +60461,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -59421,7 +60633,7 @@ Retrieve a memory version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -59491,11 +60703,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -59509,7 +60735,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -59662,7 +60888,7 @@ Redact a memory version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -59732,11 +60958,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -59750,7 +60990,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -59900,7 +61140,7 @@ Upload File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -59970,6 +61210,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters (form-data) - `file: string` @@ -60101,7 +61355,7 @@ List Files - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -60171,6 +61425,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaFileMetadata` @@ -60299,7 +61567,7 @@ Download File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -60369,6 +61637,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Example ```bash @@ -60398,7 +61680,7 @@ Get File Metadata - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -60468,6 +61750,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaFileMetadata object` @@ -60573,7 +61869,7 @@ Delete File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -60643,6 +61939,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDeletedFile object` @@ -60694,7 +62004,7 @@ Create Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -60764,6 +62074,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters (form-data) - `files: array of string` @@ -60887,7 +62211,7 @@ List Skills - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -60957,6 +62281,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of object` @@ -61069,7 +62407,7 @@ Get Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -61139,6 +62477,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `id: string` @@ -61229,7 +62581,7 @@ Delete Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -61299,6 +62651,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `id: string` @@ -61358,7 +62724,7 @@ Create Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -61428,6 +62794,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters (form-data) - `files: array of string` @@ -61544,7 +62924,7 @@ List Skill Versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -61614,6 +62994,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of object` @@ -61732,7 +63126,7 @@ Download a skill version's content as a zip archive. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -61802,6 +63196,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Example ```bash @@ -61839,7 +63247,7 @@ Get Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -61909,6 +63317,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `id: string` @@ -62009,7 +63431,7 @@ Delete Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -62079,6 +63501,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `id: string` @@ -62134,7 +63570,7 @@ Create User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -62204,6 +63640,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `access_type: optional "application" or "passthrough"` @@ -62377,7 +63827,7 @@ List User Profiles - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -62447,6 +63897,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaUserProfile` @@ -62574,7 +64038,7 @@ Get User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -62644,6 +64108,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaUserProfile object` @@ -62760,7 +64238,7 @@ Update User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -62830,6 +64308,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `access_type: optional "application" or "passthrough" or null` @@ -62986,7 +64478,7 @@ Create Enrollment URL - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -63056,6 +64548,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaUserProfileEnrollmentURL object` @@ -63110,7 +64616,7 @@ Create a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -63180,6 +64686,20 @@ Create a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `inputs: array of BetaDreamInput` @@ -63515,7 +65035,7 @@ List Dreams - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -63585,6 +65105,20 @@ List Dreams - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaDream` @@ -63807,7 +65341,7 @@ Get a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -63877,6 +65411,20 @@ Get a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDream object` @@ -64094,7 +65642,7 @@ Cancel a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -64164,6 +65712,20 @@ Cancel a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDream object` @@ -64382,7 +65944,7 @@ Archive a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -64452,6 +66014,20 @@ Archive a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDream object` @@ -64670,7 +66246,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -64740,6 +66316,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `display_name: optional string or null` @@ -64824,7 +66414,7 @@ Fetches a tunnel by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -64894,6 +66484,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnel object` @@ -64980,7 +66584,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -65050,6 +66654,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaTunnel` @@ -65133,7 +66751,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -65203,6 +66821,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnel object` @@ -65278,7 +66910,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -65348,6 +66980,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelToken object` @@ -65404,7 +67050,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -65474,6 +67120,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `reason: optional string or null` @@ -65541,7 +67201,10050 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `ca_certificate_pem: string` + + PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. + + maxLength: 8192 + +#### Returns + +- `BetaTunnelCertificate object` + + A CA certificate attached to a tunnel. + + - `id: string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: string or null` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: string` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: string or null` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: string` + + ID of the tunnel the certificate is registered against. + + - `type: "tunnel_certificate"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "ca_certificate_pem": "ca_certificate_pem" + }' +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### Get Tunnel Certificate + +**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Fetches a tunnel certificate by ID. + +#### Path parameters + +- `tunnel_id: string` + +- `certificate_id: string` + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaTunnelCertificate object` + + A CA certificate attached to a tunnel. + + - `id: string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: string or null` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: string` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: string or null` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: string` + + ID of the tunnel the certificate is registered against. + + - `type: "tunnel_certificate"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### List Tunnel Certificates + +**GET** `/v1/tunnels/{tunnel_id}/certificates` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. + +#### Path parameters + +- `tunnel_id: string` + +#### Query parameters + +- `include_archived: optional boolean` + + Whether to include archived certificates in the results. Defaults to false. + +- `limit: optional number` + + Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + + format: int32 + +- `page: optional string` + + Opaque pagination cursor from a previous `list_tunnel_certificates` response. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaTunnelCertificate` + + List of certificates, ordered by created_at descending. + + - `id: string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: string or null` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: string` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: string or null` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: string` + + ID of the tunnel the certificate is registered against. + + - `type: "tunnel_certificate"` + +- `next_page: string or null` + + Pagination cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \ + -H 'anthropic-version: 2023-06-01' \ + -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" + } + ], + "next_page": "next_page" +} +``` + +### Archive Tunnel Certificate + +**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. + +#### Path parameters + +- `tunnel_id: string` + +- `certificate_id: string` + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaTunnelCertificate object` + + A CA certificate attached to a tunnel. + + - `id: string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: string or null` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: string` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: string or null` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: string` + + ID of the tunnel the certificate is registered against. + + - `type: "tunnel_certificate"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +## Beta › Organization + +### Get Current Organization + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Returns + +- `BetaOrganization object` + + - `id: string` + + ID of the Organization. + + format: uuid + + - `name: string` + + Name of the Organization. + + - `type: "organization"` + + Object type. + + For Organizations, this is always `"organization"`. + + default: organization + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/me \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `created_by_user_id: optional string` + + Filter by the ID of the User who created the object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `status: optional "active" or "archived" or "expired" or "inactive"` + + Filter by API key status. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + +- `workspace_id: optional string` + + Filter by Workspace ID. + +#### Returns + +- `data: array of BetaAPIKey` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Path parameters + +- `api_key_id: string` + + ID of the API key. + +#### Returns + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Path parameters + +- `api_key_id: string` + + ID of the API key. + +#### Body parameters + +- `name: optional string or null` + + Name of the API key. + + maxLength: 500, minLength: 1 + +- `status: optional "active" or "archived" or "inactive" or null` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"inactive"` + +#### Returns + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Body parameters + +- `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +- `display_name: optional string or null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: optional "us"` + + Data residency geo. Only `us` is supported. + +#### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `data: array of BetaExternalKey` + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Body parameters + +- `display_name: optional string or null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: optional "us" or null` + + Data residency geo. Only `us` is supported. + +- `provider_config: optional BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam or null` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +#### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `id: string` + + ID of the deleted External Key. + +- `type: "external_key_deleted"` + + default: external_key_deleted + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `error: string or null` + + Error message when status is `failure`. Null otherwise. + +- `status: "failure" or "success"` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"failure"` + + - `"success"` + +- `type: "external_key_validation"` + + default: external_key_validation + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `issuer_url: string` + + The `iss` claim value to match against. + + minLength: 1 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained. Defaults to OIDC discovery. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_url": "x", + "name": "x" + }' +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationIssuer` + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to update. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `issuer_url: optional string or null` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline or null` + + Replaces the entire JWKS configuration. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `jwks_polling_disabled: optional boolean or null` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to archive. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `issuer_id: string` + + Tagged ID of the federation issuer. + +- `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: string` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `applies_to_all_workspaces: optional boolean` + + When true, enable this rule for every workspace in the org (including workspaces created later). + +- `attributes: optional map[string] or null` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `token_lifetime_seconds: optional number` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_id": "issuer_id", + "match": {}, + "name": "x", + "oauth_scope": "x", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `issuer_id: optional string` + + Filter to rules referencing this federation issuer. + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationRule` + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to update. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `applies_to_all_workspaces: optional boolean or null` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `attributes: optional map[string] or null` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `match: optional BetaFederationRuleMatch or null` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: optional string or null` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: optional BetaServiceAccountTarget or null` + + Bind to a fixed service account by ID. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `token_lifetime_seconds: optional number or null` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to archive. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_id: string` + + Tagged ID of the workspace to enable this rule for. + +#### Returns + +- `BetaFederationRuleWorkspace object` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id" + }' +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +- `next_page: string or null` + + Opaque cursor for the next page; null when there are no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +- `workspace_id: string` + + ID of the workspace to disable for. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `federation_rule_id: string` + + Tagged ID of the federation rule. + +- `type: "federation_rule_workspace_deleted"` + + default: federation_rule_workspace_deleted + +- `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Body parameters + +- `email: string` + + Email of the User. + + format: email + +- `role: "billing" or "claude_code_user" or "developer" or 2 more` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +- `rbac_group_ids: optional array of string` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "email": "user@emaildomain.com", + "role": "user" + }' +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: optional string` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +- `statuses: optional array of "accepted" or "expired" or "pending"` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `"accepted"` + + - `"expired"` + + - `"pending"` + +#### Returns + +- `data: array of BetaOrganizationInvite` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Path parameters + +- `invite_id: string` + + ID of the Invite. + +#### Returns + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Path parameters + +- `invite_id: string` + + ID of the Invite. + +#### Returns + +- `id: string` + + ID of the Invite. + +- `type: "invite_deleted"` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + + default: invite_deleted + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `organization_role: optional "admin" or "developer"` + + Org-level role. Defaults to `developer`. + + - `"admin"` + + - `"developer"` + +#### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "name": "ci-deploy-bot" + }' +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaServiceAccount` + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Path parameters + +- `service_account_id: string` + + ID of the service account to update. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `organization_role: optional "admin" or "developer" or null` + + Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `"admin"` + + - `"developer"` + +#### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account to archive. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_id: string` + + Tagged workspace ID to add the service account to. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +- `workspace_id: string` + + ID of the workspace. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: optional string` + + Filter by user email. + + format: email + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `data: array of BetaOrganizationUser` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Path parameters + +- `user_id: string` + + ID of the User. + +#### Returns + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Path parameters + +- `user_id: string` + + ID of the User. + +#### Body parameters + +- `role: "billing" or "claude_code_user" or "developer" or 2 more` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +#### Returns + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "role": "user" + }' +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Path parameters + +- `user_id: string` + + ID of the User. + +#### Returns + +- `id: string` + + ID of the User. + +- `type: "user_deleted"` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + + default: user_deleted + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `include_archived: optional boolean` + + Whether to include Workspaces that have been archived in the response + + default: false + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +#### Returns + +- `data: array of BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `name: string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `data_residency: optional BetaDataResidencyCreateConfig or null` + + Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + + - `workspace_geo: optional "us" or null` + + Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. + +- `display_color: optional string or null` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: optional string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `tags: optional map[string] or null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "name": "x", + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "tags": { + "env": "prod", + "team": "platform" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +#### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Path parameters + +- `workspace_id: string` + +#### Body parameters + +- `data_residency: optional BetaDataResidencyUpdateConfig or null` + + Data residency configuration for the workspace. + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + +- `display_color: optional string` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: optional string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `name: optional string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `tags: optional map[string] or null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "tags": { + "env": "prod", + "team": "platform" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Path parameters + +- `workspace_id: string` + +#### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Path parameters + +- `workspace_id: string` + + The ID of the workspace. + +#### Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `data: array of BetaWorkspaceRateLimit` + + Rate-limit entries for the workspace, one per group that has at least one override. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaWorkspaceRateLimitValue` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: number or null` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: string` + + The `id` of the RateLimit group this override applies to. + + - `type: "workspace_rate_limit"` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `workspace_id: string` + + ID of the Workspace this override applies to. + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +#### Returns + +- `data: array of BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +#### Body parameters + +- `user_id: string` + + ID of the User. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Body parameters + +- `workspace_role: BetaWorkspaceRole` + + New workspace role for the User. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Returns + +- `type: "workspace_member_deleted"` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + +- `user_id: string` + + ID of the User. + +- `workspace_id: string` + + ID of the Workspace. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -65611,62 +77314,86 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters -- `ca_certificate_pem: string` +- `service_account_id: string` - PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. + Tagged service account ID to add. - maxLength: 8192 +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` #### Returns -- `BetaTunnelCertificate object` +- `BetaServiceAccountWorkspaceMember object` - A CA certificate attached to a tunnel. + - `created_by_actor_id: string or null` - - `id: string` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `implicit: boolean or null` - - `archived_at: string or null` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `service_account_id: string` - format: date-time + Tagged service account ID (`svac_...`). - - `created_at: string` + - `type: "service_account_workspace_member"` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `workspace_id: string` - - `expires_at: string or null` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `workspace_role: BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `fingerprint: string` + - `"workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `"workspace_billing"` - - `tunnel_id: string` + - `"workspace_developer"` - ID of the tunnel the certificate is registered against. + - `"workspace_restricted_developer"` - - `type: "tunnel_certificate"` + - `"workspace_user"` #### Example ```bash -curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \ +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ - "ca_certificate_pem": "ca_certificate_pem" + "service_account_id": "service_account_id", + "workspace_role": "workspace_admin" }' ``` @@ -65674,29 +77401,39 @@ curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \ ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Get Tunnel Certificate +### Get Service Account Workspace Member -**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Fetches a tunnel certificate by ID. +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. #### Path parameters -- `tunnel_id: string` +- `workspace_id: string` -- `certificate_id: string` + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. #### Headers @@ -65706,7 +77443,7 @@ Fetches a tunnel certificate by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -65776,50 +77513,63 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `BetaTunnelCertificate object` +- `BetaServiceAccountWorkspaceMember object` - A CA certificate attached to a tunnel. + - `created_by_actor_id: string or null` - - `id: string` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `implicit: boolean or null` - - `archived_at: string or null` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `service_account_id: string` - format: date-time + Tagged service account ID (`svac_...`). - - `created_at: string` + - `type: "service_account_workspace_member"` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `workspace_id: string` - - `expires_at: string or null` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `workspace_role: BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `fingerprint: string` + - `"workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `"workspace_billing"` - - `tunnel_id: string` + - `"workspace_developer"` - ID of the tunnel the certificate is registered against. + - `"workspace_restricted_developer"` - - `type: "tunnel_certificate"` + - `"workspace_user"` #### Example ```bash -curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \ +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` @@ -65827,43 +77577,39 @@ curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_I ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### List Tunnel Certificates +### Update Service Account Workspace Member -**GET** `/v1/tunnels/{tunnel_id}/certificates` +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. +Change a service account's role in a workspace. -#### Path parameters - -- `tunnel_id: string` +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. -#### Query parameters - -- `include_archived: optional boolean` - - Whether to include archived certificates in the results. Defaults to false. - -- `limit: optional number` +#### Path parameters - Maximum number of certificates to return per page. Defaults to 20, maximum 1000. +- `workspace_id: string` - format: int32 + ID of the workspace. -- `page: optional string` +- `service_account_id: string` - Opaque pagination cursor from a previous `list_tunnel_certificates` response. + ID of the service account. #### Headers @@ -65873,7 +77619,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -65943,89 +77689,120 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` -#### Returns + - `"compact-2026-01-12"` -- `data: array of BetaTunnelCertificate` + - `"computer-use-2025-11-24"` - List of certificates, ordered by created_at descending. + - `"mcp-tunnels-2026-06-22"` - - `id: string` + - `"structured-outputs-2025-11-13"` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `"task-budgets-2026-03-13"` - - `archived_at: string or null` + - `"thinking-display-updates-2026-08-18"` - A timestamp in RFC 3339 format + - `"ce-user-management-2026-07-13"` - format: date-time +#### Body parameters - - `created_at: string` +- `workspace_role: BetaNoBillingWorkspaceRole` - A timestamp in RFC 3339 format + New role for the service account in this workspace. - format: date-time + - `"workspace_admin"` - - `expires_at: string or null` + - `"workspace_developer"` - A timestamp in RFC 3339 format + - `"workspace_restricted_developer"` - format: date-time + - `"workspace_user"` - - `fingerprint: string` +#### Returns - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. +- `BetaServiceAccountWorkspaceMember object` - - `tunnel_id: string` + - `created_by_actor_id: string or null` - ID of the tunnel the certificate is registered against. + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - - `type: "tunnel_certificate"` + - `implicit: boolean or null` -- `next_page: string or null` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - Pagination cursor for the next page, or null if no more results. + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` #### Example ```bash -curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \ +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ - -H "X-Api-Key: $ANTHROPIC_API_KEY" + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' ``` ##### Response (200) ```json { - "data": [ - { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" - } - ], - "next_page": "next_page" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Archive Tunnel Certificate +### Delete Service Account Workspace Member -**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. #### Path parameters -- `tunnel_id: string` +- `workspace_id: string` -- `certificate_id: string` + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. #### Headers @@ -66035,7 +77812,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -66105,51 +77882,160 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `BetaTunnelCertificate object` +- `service_account_id: string` - A CA certificate attached to a tunnel. + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Rate Limits + +### List Organization Rate Limits + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `model: optional string` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `data: array of BetaOrganizationRateLimit` + + Rate-limit entries for the organization, one per group. - `id: string` - Unique identifier for the certificate, prefixed with `tcrt_`. + Stable identifier for this rate-limit group within the organization. - - `archived_at: string or null` + - `group_type: "batch" or "files" or "model_group" or 3 more` - A timestamp in RFC 3339 format + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. - format: date-time + - `"batch"` - - `created_at: string` + - `"files"` - A timestamp in RFC 3339 format + - `"model_group"` - format: date-time + - `"skills"` - - `expires_at: string or null` + - `"token_count"` - A timestamp in RFC 3339 format + - `"web_search"` - format: date-time + - `limits: array of BetaOrganizationRateLimitValue` - - `fingerprint: string` + The limiter values that apply to this group. - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `type: string` - - `tunnel_id: string` + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - ID of the tunnel the certificate is registered against. + - `value: number` - - `type: "tunnel_certificate"` + The configured limit value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: "rate_limit"` + + Object type. Always `rate_limit` for organization rate-limit entries. + + default: rate_limit + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. #### Example ```bash -curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \ - -X POST \ +curl https://api.anthropic.com/v1/organizations/rate_limits \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` @@ -66157,12 +78043,22 @@ curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_I ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" } ``` diff --git a/content/en/api/beta/agents.md b/content/en/api/beta/agents.md index 54e1fca26..dc720e633 100644 --- a/content/en/api/beta/agents.md +++ b/content/en/api/beta/agents.md @@ -14,7 +14,7 @@ Create Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `model: BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams` @@ -1411,7 +1425,7 @@ List Agents - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1481,6 +1495,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaManagedAgentsAgent` @@ -2132,7 +2160,7 @@ Get Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2202,6 +2230,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsAgent object` @@ -2836,7 +2878,7 @@ Update Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2906,6 +2948,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `description: optional string or null` @@ -4206,7 +4262,7 @@ Archive Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -4276,6 +4332,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsAgent object` @@ -8665,7 +8735,7 @@ List Agent Versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -8735,6 +8805,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaManagedAgentsAgent` diff --git a/content/en/api/beta/agents/archive.md b/content/en/api/beta/agents/archive.md index d230e90f3..ac2855875 100644 --- a/content/en/api/beta/agents/archive.md +++ b/content/en/api/beta/agents/archive.md @@ -16,7 +16,7 @@ Archive Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsAgent object` diff --git a/content/en/api/beta/agents/create.md b/content/en/api/beta/agents/create.md index 4b4901d5e..6dd7e69a4 100644 --- a/content/en/api/beta/agents/create.md +++ b/content/en/api/beta/agents/create.md @@ -12,7 +12,7 @@ Create Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `model: BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams` diff --git a/content/en/api/beta/agents/list.md b/content/en/api/beta/agents/list.md index 627ec641c..61b1d07e1 100644 --- a/content/en/api/beta/agents/list.md +++ b/content/en/api/beta/agents/list.md @@ -40,7 +40,7 @@ List Agents - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -110,6 +110,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaManagedAgentsAgent` diff --git a/content/en/api/beta/agents/retrieve.md b/content/en/api/beta/agents/retrieve.md index 9c546ebda..5e20334ff 100644 --- a/content/en/api/beta/agents/retrieve.md +++ b/content/en/api/beta/agents/retrieve.md @@ -24,7 +24,7 @@ Get Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsAgent object` diff --git a/content/en/api/beta/agents/update.md b/content/en/api/beta/agents/update.md index 964e85afa..50da5f042 100644 --- a/content/en/api/beta/agents/update.md +++ b/content/en/api/beta/agents/update.md @@ -16,7 +16,7 @@ Update Agent - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `description: optional string or null` diff --git a/content/en/api/beta/agents/versions.md b/content/en/api/beta/agents/versions.md index 1bceda379..121fb5306 100644 --- a/content/en/api/beta/agents/versions.md +++ b/content/en/api/beta/agents/versions.md @@ -30,7 +30,7 @@ List Agent Versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaManagedAgentsAgent` diff --git a/content/en/api/beta/agents/versions/list.md b/content/en/api/beta/agents/versions/list.md index ad4f78dd7..0df6f0858 100644 --- a/content/en/api/beta/agents/versions/list.md +++ b/content/en/api/beta/agents/versions/list.md @@ -28,7 +28,7 @@ List Agent Versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaManagedAgentsAgent` diff --git a/content/en/api/beta/deployment_runs.md b/content/en/api/beta/deployment_runs.md index 5bb61f035..ee6c935c3 100644 --- a/content/en/api/beta/deployment_runs.md +++ b/content/en/api/beta/deployment_runs.md @@ -66,7 +66,7 @@ List Deployment Runs - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -136,6 +136,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaManagedAgentsDeploymentRun` @@ -421,7 +435,7 @@ Get Deployment Run - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -491,6 +505,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeploymentRun object` diff --git a/content/en/api/beta/deployment_runs/list.md b/content/en/api/beta/deployment_runs/list.md index 168c70792..4e402eb10 100644 --- a/content/en/api/beta/deployment_runs/list.md +++ b/content/en/api/beta/deployment_runs/list.md @@ -64,7 +64,7 @@ List Deployment Runs - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -134,6 +134,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/beta/deployment_runs/retrieve.md b/content/en/api/beta/deployment_runs/retrieve.md index 203a9c74d..da270280b 100644 --- a/content/en/api/beta/deployment_runs/retrieve.md +++ b/content/en/api/beta/deployment_runs/retrieve.md @@ -16,7 +16,7 @@ Get Deployment Run - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeploymentRun object` diff --git a/content/en/api/beta/deployments.md b/content/en/api/beta/deployments.md index c8e0fdc80..b0d042ea0 100644 --- a/content/en/api/beta/deployments.md +++ b/content/en/api/beta/deployments.md @@ -14,7 +14,7 @@ Create Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `agent: string or BetaManagedAgentsAgentParams` @@ -1149,7 +1163,7 @@ List Deployments - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1219,6 +1233,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaManagedAgentsDeployment` @@ -1838,7 +1866,7 @@ Get Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1908,6 +1936,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment object` @@ -2518,7 +2560,7 @@ Update Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2588,6 +2630,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `agent: optional string or BetaManagedAgentsAgentParams` @@ -3602,7 +3658,7 @@ Archive Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -3672,6 +3728,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment object` @@ -4283,7 +4353,7 @@ Run Deployment Now - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -4353,6 +4423,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeploymentRun object` @@ -4630,7 +4714,7 @@ Pause Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -4700,6 +4784,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment object` @@ -5311,7 +5409,7 @@ Unpause Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -5381,6 +5479,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment object` diff --git a/content/en/api/beta/deployments/archive.md b/content/en/api/beta/deployments/archive.md index f6131f43a..2d2726256 100644 --- a/content/en/api/beta/deployments/archive.md +++ b/content/en/api/beta/deployments/archive.md @@ -16,7 +16,7 @@ Archive Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment object` diff --git a/content/en/api/beta/deployments/create.md b/content/en/api/beta/deployments/create.md index 9c329e091..7233a1675 100644 --- a/content/en/api/beta/deployments/create.md +++ b/content/en/api/beta/deployments/create.md @@ -12,7 +12,7 @@ Create Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `agent: string or BetaManagedAgentsAgentParams` diff --git a/content/en/api/beta/deployments/list.md b/content/en/api/beta/deployments/list.md index 5670c547a..c500c3c6e 100644 --- a/content/en/api/beta/deployments/list.md +++ b/content/en/api/beta/deployments/list.md @@ -52,7 +52,7 @@ List Deployments - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -122,6 +122,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaManagedAgentsDeployment` diff --git a/content/en/api/beta/deployments/pause.md b/content/en/api/beta/deployments/pause.md index 6404af258..8bfdefeb4 100644 --- a/content/en/api/beta/deployments/pause.md +++ b/content/en/api/beta/deployments/pause.md @@ -16,7 +16,7 @@ Pause Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment object` diff --git a/content/en/api/beta/deployments/retrieve.md b/content/en/api/beta/deployments/retrieve.md index 2f3fef026..0dede5552 100644 --- a/content/en/api/beta/deployments/retrieve.md +++ b/content/en/api/beta/deployments/retrieve.md @@ -16,7 +16,7 @@ Get Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment object` diff --git a/content/en/api/beta/deployments/run.md b/content/en/api/beta/deployments/run.md index ccf9e1b19..80210a6ce 100644 --- a/content/en/api/beta/deployments/run.md +++ b/content/en/api/beta/deployments/run.md @@ -16,7 +16,7 @@ Run Deployment Now - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeploymentRun object` diff --git a/content/en/api/beta/deployments/unpause.md b/content/en/api/beta/deployments/unpause.md index 02526607c..5c4203d86 100644 --- a/content/en/api/beta/deployments/unpause.md +++ b/content/en/api/beta/deployments/unpause.md @@ -16,7 +16,7 @@ Unpause Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment object` diff --git a/content/en/api/beta/deployments/update.md b/content/en/api/beta/deployments/update.md index ded726ca0..a05d6c135 100644 --- a/content/en/api/beta/deployments/update.md +++ b/content/en/api/beta/deployments/update.md @@ -16,7 +16,7 @@ Update Deployment - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `agent: optional string or BetaManagedAgentsAgentParams` diff --git a/content/en/api/beta/dreams.md b/content/en/api/beta/dreams.md index fed200a6c..bde79e10b 100644 --- a/content/en/api/beta/dreams.md +++ b/content/en/api/beta/dreams.md @@ -14,7 +14,7 @@ Create a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `inputs: array of BetaDreamInput` @@ -419,7 +433,7 @@ List Dreams - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -489,6 +503,20 @@ List Dreams - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaDream` @@ -711,7 +739,7 @@ Get a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -781,6 +809,20 @@ Get a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaDream object` @@ -998,7 +1040,7 @@ Cancel a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1068,6 +1110,20 @@ Cancel a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaDream object` @@ -1286,7 +1342,7 @@ Archive a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1356,6 +1412,20 @@ Archive a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaDream object` diff --git a/content/en/api/beta/dreams/archive.md b/content/en/api/beta/dreams/archive.md index cb66f92ae..023c52a01 100644 --- a/content/en/api/beta/dreams/archive.md +++ b/content/en/api/beta/dreams/archive.md @@ -16,7 +16,7 @@ Archive a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaDream object` diff --git a/content/en/api/beta/dreams/cancel.md b/content/en/api/beta/dreams/cancel.md index 52a67d2ec..b96568601 100644 --- a/content/en/api/beta/dreams/cancel.md +++ b/content/en/api/beta/dreams/cancel.md @@ -16,7 +16,7 @@ Cancel a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Cancel a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaDream object` diff --git a/content/en/api/beta/dreams/create.md b/content/en/api/beta/dreams/create.md index ea139d22d..763f9dd5e 100644 --- a/content/en/api/beta/dreams/create.md +++ b/content/en/api/beta/dreams/create.md @@ -12,7 +12,7 @@ Create a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `inputs: array of BetaDreamInput` diff --git a/content/en/api/beta/dreams/list.md b/content/en/api/beta/dreams/list.md index 97925978b..1e9c4bcad 100644 --- a/content/en/api/beta/dreams/list.md +++ b/content/en/api/beta/dreams/list.md @@ -54,7 +54,7 @@ List Dreams - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -124,6 +124,20 @@ List Dreams - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaDream` diff --git a/content/en/api/beta/dreams/retrieve.md b/content/en/api/beta/dreams/retrieve.md index 8fba205f1..bfa836fb5 100644 --- a/content/en/api/beta/dreams/retrieve.md +++ b/content/en/api/beta/dreams/retrieve.md @@ -16,7 +16,7 @@ Get a Dream - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaDream object` diff --git a/content/en/api/beta/environments.md b/content/en/api/beta/environments.md index f9aed2a90..af5d3330d 100644 --- a/content/en/api/beta/environments.md +++ b/content/en/api/beta/environments.md @@ -14,7 +14,7 @@ Create a new environment with the specified configuration. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `name: string` @@ -136,7 +150,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: optional boolean or null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` @@ -148,6 +162,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string or null` Ubuntu/Debian packages to install @@ -449,7 +465,7 @@ List environments with pagination support. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -519,6 +535,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaEnvironment` @@ -738,7 +768,7 @@ Retrieve a specific environment by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -808,6 +838,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironment object` @@ -1018,7 +1062,7 @@ Update an existing environment's configuration. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1088,6 +1132,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null` @@ -1134,7 +1192,7 @@ Update an existing environment's configuration. - `allow_package_managers: optional boolean or null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` @@ -1146,6 +1204,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string or null` Ubuntu/Debian packages to install @@ -1422,7 +1482,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1492,6 +1552,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironmentDeleteResponse object` @@ -1545,7 +1619,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1615,6 +1689,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironment object` @@ -1928,7 +2016,7 @@ curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/archive \ - `allow_package_managers: optional boolean or null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` @@ -1940,6 +2028,8 @@ curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/archive \ When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string or null` Ubuntu/Debian packages to install @@ -2161,7 +2251,7 @@ curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/archive \ - `allow_package_managers: optional boolean or null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` @@ -2211,6 +2301,8 @@ curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/archive \ When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string or null` Ubuntu/Debian packages to install @@ -2295,7 +2387,7 @@ Retrieve detailed information about a specific work item. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2365,6 +2457,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork object` @@ -2515,7 +2621,7 @@ Long poll for work items in the queue. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2585,6 +2691,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"Anthropic-Worker-ID": optional string` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -2727,7 +2847,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2797,6 +2917,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork object` @@ -2946,7 +3080,7 @@ Record a heartbeat for a work item to maintain the lease. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -3016,6 +3150,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkHeartbeatResponse object` @@ -3098,7 +3246,7 @@ Stop a work item, initiating graceful or forced shutdown. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -3168,6 +3316,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `force: optional boolean` @@ -3326,7 +3488,7 @@ List work items in an environment. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -3396,6 +3558,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkListResponse object` @@ -3543,7 +3719,7 @@ Update work item metadata with merge semantics. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -3613,6 +3789,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `metadata: map[string]` @@ -3759,7 +3949,7 @@ Get statistics about the work queue for an environment. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -3829,6 +4019,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkQueueStats object` diff --git a/content/en/api/beta/environments/archive.md b/content/en/api/beta/environments/archive.md index e28a7a5cb..cd2d596c2 100644 --- a/content/en/api/beta/environments/archive.md +++ b/content/en/api/beta/environments/archive.md @@ -16,7 +16,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironment object` diff --git a/content/en/api/beta/environments/create.md b/content/en/api/beta/environments/create.md index cd3654c4b..781adfa74 100644 --- a/content/en/api/beta/environments/create.md +++ b/content/en/api/beta/environments/create.md @@ -12,7 +12,7 @@ Create a new environment with the specified configuration. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `name: string` @@ -134,7 +148,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: optional boolean or null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` @@ -146,6 +160,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string or null` Ubuntu/Debian packages to install diff --git a/content/en/api/beta/environments/delete.md b/content/en/api/beta/environments/delete.md index eca20b52c..f1889c4ff 100644 --- a/content/en/api/beta/environments/delete.md +++ b/content/en/api/beta/environments/delete.md @@ -16,7 +16,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironmentDeleteResponse object` diff --git a/content/en/api/beta/environments/list.md b/content/en/api/beta/environments/list.md index 905052f73..a373ec205 100644 --- a/content/en/api/beta/environments/list.md +++ b/content/en/api/beta/environments/list.md @@ -30,7 +30,7 @@ List environments with pagination support. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaEnvironment` diff --git a/content/en/api/beta/environments/retrieve.md b/content/en/api/beta/environments/retrieve.md index 6793d3e53..c615cb659 100644 --- a/content/en/api/beta/environments/retrieve.md +++ b/content/en/api/beta/environments/retrieve.md @@ -16,7 +16,7 @@ Retrieve a specific environment by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironment object` diff --git a/content/en/api/beta/environments/update.md b/content/en/api/beta/environments/update.md index 0d1f23272..9ba0469f4 100644 --- a/content/en/api/beta/environments/update.md +++ b/content/en/api/beta/environments/update.md @@ -16,7 +16,7 @@ Update an existing environment's configuration. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null` @@ -132,7 +146,7 @@ Update an existing environment's configuration. - `allow_package_managers: optional boolean or null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` @@ -144,6 +158,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string or null` Ubuntu/Debian packages to install diff --git a/content/en/api/beta/environments/work.md b/content/en/api/beta/environments/work.md index fe644a5e7..7144f5514 100644 --- a/content/en/api/beta/environments/work.md +++ b/content/en/api/beta/environments/work.md @@ -22,7 +22,7 @@ Retrieve detailed information about a specific work item. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWork object` @@ -242,7 +256,7 @@ Long poll for work items in the queue. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -312,6 +326,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"Anthropic-Worker-ID": optional string` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -454,7 +482,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -524,6 +552,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWork object` @@ -673,7 +715,7 @@ Record a heartbeat for a work item to maintain the lease. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -743,6 +785,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWorkHeartbeatResponse object` @@ -825,7 +881,7 @@ Stop a work item, initiating graceful or forced shutdown. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -895,6 +951,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `force: optional boolean` @@ -1053,7 +1123,7 @@ List work items in an environment. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1123,6 +1193,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWorkListResponse object` @@ -1270,7 +1354,7 @@ Update work item metadata with merge semantics. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1340,6 +1424,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `metadata: map[string]` @@ -1486,7 +1584,7 @@ Get statistics about the work queue for an environment. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1556,6 +1654,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWorkQueueStats object` diff --git a/content/en/api/beta/environments/work/ack.md b/content/en/api/beta/environments/work/ack.md index 8ec383594..0c76ee130 100644 --- a/content/en/api/beta/environments/work/ack.md +++ b/content/en/api/beta/environments/work/ack.md @@ -20,7 +20,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWork object` diff --git a/content/en/api/beta/environments/work/heartbeat.md b/content/en/api/beta/environments/work/heartbeat.md index 95414511e..a1b117aba 100644 --- a/content/en/api/beta/environments/work/heartbeat.md +++ b/content/en/api/beta/environments/work/heartbeat.md @@ -30,7 +30,7 @@ Record a heartbeat for a work item to maintain the lease. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWorkHeartbeatResponse object` diff --git a/content/en/api/beta/environments/work/list.md b/content/en/api/beta/environments/work/list.md index 2ebb4606e..457d3ae51 100644 --- a/content/en/api/beta/environments/work/list.md +++ b/content/en/api/beta/environments/work/list.md @@ -30,7 +30,7 @@ List work items in an environment. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWorkListResponse object` diff --git a/content/en/api/beta/environments/work/poll.md b/content/en/api/beta/environments/work/poll.md index 8184e4665..78a1053bd 100644 --- a/content/en/api/beta/environments/work/poll.md +++ b/content/en/api/beta/environments/work/poll.md @@ -32,7 +32,7 @@ Long poll for work items in the queue. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"Anthropic-Worker-ID": optional string` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console diff --git a/content/en/api/beta/environments/work/retrieve.md b/content/en/api/beta/environments/work/retrieve.md index 3417d94b1..31c93c9f7 100644 --- a/content/en/api/beta/environments/work/retrieve.md +++ b/content/en/api/beta/environments/work/retrieve.md @@ -20,7 +20,7 @@ Retrieve detailed information about a specific work item. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWork object` diff --git a/content/en/api/beta/environments/work/stats.md b/content/en/api/beta/environments/work/stats.md index bff58ed90..d13f2b7ae 100644 --- a/content/en/api/beta/environments/work/stats.md +++ b/content/en/api/beta/environments/work/stats.md @@ -16,7 +16,7 @@ Get statistics about the work queue for an environment. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWorkQueueStats object` diff --git a/content/en/api/beta/environments/work/stop.md b/content/en/api/beta/environments/work/stop.md index 8b8d1672b..8aa0f1e65 100644 --- a/content/en/api/beta/environments/work/stop.md +++ b/content/en/api/beta/environments/work/stop.md @@ -20,7 +20,7 @@ Stop a work item, initiating graceful or forced shutdown. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `force: optional boolean` diff --git a/content/en/api/beta/environments/work/update.md b/content/en/api/beta/environments/work/update.md index 8e3ca4d5f..d7e9d0663 100644 --- a/content/en/api/beta/environments/work/update.md +++ b/content/en/api/beta/environments/work/update.md @@ -20,7 +20,7 @@ Update work item metadata with merge semantics. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `metadata: map[string]` diff --git a/content/en/api/beta/files.md b/content/en/api/beta/files.md index 4a2622721..7d2cd2f76 100644 --- a/content/en/api/beta/files.md +++ b/content/en/api/beta/files.md @@ -14,7 +14,7 @@ Upload File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters (form-data) - `file: string` @@ -215,7 +229,7 @@ List Files - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -285,6 +299,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaFileMetadata` @@ -413,7 +441,7 @@ Download File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -483,6 +511,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Example ```bash @@ -512,7 +554,7 @@ Get File Metadata - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -582,6 +624,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaFileMetadata object` @@ -687,7 +743,7 @@ Delete File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -757,6 +813,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaDeletedFile object` diff --git a/content/en/api/beta/files/delete.md b/content/en/api/beta/files/delete.md index 5fdbde21a..9b341ec6f 100644 --- a/content/en/api/beta/files/delete.md +++ b/content/en/api/beta/files/delete.md @@ -18,7 +18,7 @@ Delete File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaDeletedFile object` diff --git a/content/en/api/beta/files/download.md b/content/en/api/beta/files/download.md index 2f3fc53b1..af46c680e 100644 --- a/content/en/api/beta/files/download.md +++ b/content/en/api/beta/files/download.md @@ -18,7 +18,7 @@ Download File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Example ```bash diff --git a/content/en/api/beta/files/list.md b/content/en/api/beta/files/list.md index 17f7b4779..f13cbdc63 100644 --- a/content/en/api/beta/files/list.md +++ b/content/en/api/beta/files/list.md @@ -34,7 +34,7 @@ List Files - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaFileMetadata` diff --git a/content/en/api/beta/files/retrieve_metadata.md b/content/en/api/beta/files/retrieve_metadata.md index 37e6b7ba6..c80e7f27e 100644 --- a/content/en/api/beta/files/retrieve_metadata.md +++ b/content/en/api/beta/files/retrieve_metadata.md @@ -18,7 +18,7 @@ Get File Metadata - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaFileMetadata object` diff --git a/content/en/api/beta/files/upload.md b/content/en/api/beta/files/upload.md index 60d0486e2..30b4c3fb3 100644 --- a/content/en/api/beta/files/upload.md +++ b/content/en/api/beta/files/upload.md @@ -12,7 +12,7 @@ Upload File - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters (form-data) - `file: string` diff --git a/content/en/api/beta/memory_stores.md b/content/en/api/beta/memory_stores.md index 0008eb3dd..83e17ab70 100644 --- a/content/en/api/beta/memory_stores.md +++ b/content/en/api/beta/memory_stores.md @@ -14,7 +14,7 @@ Create a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `name: string` @@ -216,7 +230,7 @@ List memory stores - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -286,6 +300,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsMemoryStore` @@ -381,7 +409,7 @@ Retrieve a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -451,6 +479,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryStore object` @@ -537,7 +579,7 @@ Update a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -607,6 +649,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `description: optional string or null` @@ -713,7 +769,7 @@ Delete a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -783,6 +839,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedMemoryStore object` @@ -832,7 +902,7 @@ Archive a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -902,6 +972,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryStore object` @@ -1057,7 +1141,7 @@ Create a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1127,6 +1211,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `content: string or null` @@ -1171,7 +1269,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1268,7 +1366,7 @@ List memories - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1338,6 +1436,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsMemoryListItem` @@ -1374,7 +1486,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1467,7 +1579,7 @@ Retrieve a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1537,6 +1649,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemory object` @@ -1569,7 +1695,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1643,7 +1769,7 @@ Update a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1713,6 +1839,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `content: optional string or null` @@ -1767,7 +1907,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1839,7 +1979,7 @@ Delete a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1909,11 +2049,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedMemory object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -2018,7 +2172,7 @@ List memory versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2088,6 +2242,20 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsMemoryVersion` @@ -2106,7 +2274,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -2278,7 +2446,7 @@ Retrieve a memory version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2348,11 +2516,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -2366,7 +2548,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -2519,7 +2701,7 @@ Redact a memory version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2589,11 +2771,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -2607,7 +2803,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/beta/memory_stores/archive.md b/content/en/api/beta/memory_stores/archive.md index 907eeab7a..fd402cba4 100644 --- a/content/en/api/beta/memory_stores/archive.md +++ b/content/en/api/beta/memory_stores/archive.md @@ -16,7 +16,7 @@ Archive a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryStore object` diff --git a/content/en/api/beta/memory_stores/create.md b/content/en/api/beta/memory_stores/create.md index b95a3cc6c..0b8e19000 100644 --- a/content/en/api/beta/memory_stores/create.md +++ b/content/en/api/beta/memory_stores/create.md @@ -12,7 +12,7 @@ Create a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `name: string` diff --git a/content/en/api/beta/memory_stores/delete.md b/content/en/api/beta/memory_stores/delete.md index 3b2982245..cf00c2beb 100644 --- a/content/en/api/beta/memory_stores/delete.md +++ b/content/en/api/beta/memory_stores/delete.md @@ -16,7 +16,7 @@ Delete a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedMemoryStore object` diff --git a/content/en/api/beta/memory_stores/list.md b/content/en/api/beta/memory_stores/list.md index addf524ed..7123576b0 100644 --- a/content/en/api/beta/memory_stores/list.md +++ b/content/en/api/beta/memory_stores/list.md @@ -40,7 +40,7 @@ List memory stores - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -110,6 +110,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsMemoryStore` diff --git a/content/en/api/beta/memory_stores/memories.md b/content/en/api/beta/memory_stores/memories.md index 3bd2bb85a..c0e949f10 100644 --- a/content/en/api/beta/memory_stores/memories.md +++ b/content/en/api/beta/memory_stores/memories.md @@ -28,7 +28,7 @@ Create a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `content: string or null` @@ -142,7 +156,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -239,7 +253,7 @@ List memories - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -309,6 +323,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsMemoryListItem` @@ -345,7 +373,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -438,7 +466,7 @@ Retrieve a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -508,6 +536,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemory object` @@ -540,7 +582,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -614,7 +656,7 @@ Update a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -684,6 +726,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `content: optional string or null` @@ -738,7 +794,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -810,7 +866,7 @@ Delete a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -880,11 +936,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedMemory object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -937,7 +1007,7 @@ curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memories/$MEMOR - `BetaManagedAgentsDeletedMemory object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -1093,7 +1163,7 @@ curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memories/$MEMOR - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1147,7 +1217,7 @@ curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memories/$MEMOR - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/beta/memory_stores/memories/create.md b/content/en/api/beta/memory_stores/memories/create.md index b14d5af83..a63902448 100644 --- a/content/en/api/beta/memory_stores/memories/create.md +++ b/content/en/api/beta/memory_stores/memories/create.md @@ -26,7 +26,7 @@ Create a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `content: string or null` @@ -140,7 +154,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/beta/memory_stores/memories/delete.md b/content/en/api/beta/memory_stores/memories/delete.md index e8d4ddf2f..82c549f9e 100644 --- a/content/en/api/beta/memory_stores/memories/delete.md +++ b/content/en/api/beta/memory_stores/memories/delete.md @@ -24,7 +24,7 @@ Delete a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -94,11 +94,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedMemory object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` diff --git a/content/en/api/beta/memory_stores/memories/list.md b/content/en/api/beta/memory_stores/memories/list.md index b52bf651d..16da09143 100644 --- a/content/en/api/beta/memory_stores/memories/list.md +++ b/content/en/api/beta/memory_stores/memories/list.md @@ -46,7 +46,7 @@ List memories - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -116,6 +116,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsMemoryListItem` @@ -152,7 +166,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/beta/memory_stores/memories/retrieve.md b/content/en/api/beta/memory_stores/memories/retrieve.md index a82b2012e..a34ad279b 100644 --- a/content/en/api/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/beta/memory_stores/memories/retrieve.md @@ -28,7 +28,7 @@ Retrieve a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemory object` @@ -130,7 +144,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/beta/memory_stores/memories/update.md b/content/en/api/beta/memory_stores/memories/update.md index 434605b85..11a98a618 100644 --- a/content/en/api/beta/memory_stores/memories/update.md +++ b/content/en/api/beta/memory_stores/memories/update.md @@ -28,7 +28,7 @@ Update a memory - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `content: optional string or null` @@ -152,7 +166,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/beta/memory_stores/memory_versions.md b/content/en/api/beta/memory_stores/memory_versions.md index 042357ee8..a6d7d274d 100644 --- a/content/en/api/beta/memory_stores/memory_versions.md +++ b/content/en/api/beta/memory_stores/memory_versions.md @@ -76,7 +76,7 @@ List memory versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -146,6 +146,20 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsMemoryVersion` @@ -164,7 +178,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -336,7 +350,7 @@ Retrieve a memory version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -406,11 +420,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -424,7 +452,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -577,7 +605,7 @@ Redact a memory version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -647,11 +675,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -665,7 +707,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -873,7 +915,7 @@ curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memory_versions - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -887,7 +929,7 @@ curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memory_versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/beta/memory_stores/memory_versions/list.md b/content/en/api/beta/memory_stores/memory_versions/list.md index d7080db58..53a5caa9c 100644 --- a/content/en/api/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/beta/memory_stores/memory_versions/list.md @@ -74,7 +74,7 @@ List memory versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -144,6 +144,20 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsMemoryVersion` @@ -162,7 +176,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/beta/memory_stores/memory_versions/redact.md b/content/en/api/beta/memory_stores/memory_versions/redact.md index 446ffb446..8be37d34b 100644 --- a/content/en/api/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/beta/memory_stores/memory_versions/redact.md @@ -18,7 +18,7 @@ Redact a memory version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,11 +88,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -106,7 +120,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/beta/memory_stores/memory_versions/retrieve.md index 97190563a..823b8728f 100644 --- a/content/en/api/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/beta/memory_stores/memory_versions/retrieve.md @@ -28,7 +28,7 @@ Retrieve a memory version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,11 +98,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryVersion object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -116,7 +130,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/beta/memory_stores/retrieve.md b/content/en/api/beta/memory_stores/retrieve.md index 2dbd0e51f..96282d4d6 100644 --- a/content/en/api/beta/memory_stores/retrieve.md +++ b/content/en/api/beta/memory_stores/retrieve.md @@ -16,7 +16,7 @@ Retrieve a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryStore object` diff --git a/content/en/api/beta/memory_stores/update.md b/content/en/api/beta/memory_stores/update.md index 5601829ed..1302992fe 100644 --- a/content/en/api/beta/memory_stores/update.md +++ b/content/en/api/beta/memory_stores/update.md @@ -16,7 +16,7 @@ Update a memory store - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `description: optional string or null` diff --git a/content/en/api/beta/messages.md b/content/en/api/beta/messages.md index aa5bc872d..8747ccc28 100644 --- a/content/en/api/beta/messages.md +++ b/content/en/api/beta/messages.md @@ -18,7 +18,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -1768,7 +1782,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1776,6 +1790,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -1784,7 +1800,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1792,6 +1808,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `Default = "default"` - `inference_geo: optional string or null` @@ -5302,12 +5320,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -5617,12 +5637,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: number` The cumulative number of output tokens which were used. @@ -5969,7 +5991,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -6039,6 +6061,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -7643,7 +7679,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -7651,6 +7687,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -7659,7 +7697,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -7667,6 +7705,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice: optional BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -18166,7 +18206,7 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18174,6 +18214,8 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -18182,7 +18224,7 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18190,6 +18232,8 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `"omitted"` + - `"updates"` + ### Beta Fallback Refusal Trigger - `BetaFallbackRefusalTrigger object` @@ -18378,7 +18422,7 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18386,6 +18430,8 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -18394,7 +18440,7 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18402,6 +18448,8 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `"omitted"` + - `"updates"` + - `Default = "default"` ### Beta File Document Source @@ -18541,12 +18589,14 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -20805,12 +20855,14 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -21146,12 +21198,14 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -24672,12 +24726,14 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -26394,12 +26450,14 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -28070,12 +28128,14 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -28379,12 +28439,14 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: number` The cumulative number of output tokens which were used. @@ -30633,7 +30695,7 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30641,6 +30703,8 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `"omitted"` + - `"updates"` + ### Beta Thinking Config Disabled - `BetaThinkingConfigDisabled object` @@ -30663,7 +30727,7 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30671,6 +30735,8 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `"omitted"` + - `"updates"` + ### Beta Thinking Config Param - `BetaThinkingConfigParam = BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigAdaptive` @@ -30695,7 +30761,7 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30703,6 +30769,8 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -30711,7 +30779,7 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30719,6 +30787,8 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ - `"omitted"` + - `"updates"` + ### Beta Thinking Delta - `BetaThinkingDelta object` @@ -34565,12 +34635,14 @@ curl https://api.anthropic.com/v1/messages/count_tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -36746,7 +36818,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -36816,6 +36888,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -38516,7 +38602,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -38524,6 +38610,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -38532,7 +38620,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -38540,6 +38628,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `Default = "default"` - `inference_geo: optional string or null` @@ -40815,7 +40905,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -40885,6 +40975,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch object` @@ -41061,7 +41165,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -41131,6 +41235,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaMessageBatch` @@ -41316,7 +41434,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -41386,6 +41504,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch object` @@ -41553,7 +41685,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -41623,6 +41755,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDeletedMessageBatch object` @@ -41682,7 +41828,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -41752,6 +41898,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatchIndividualResponse object` @@ -43187,12 +43347,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. diff --git a/content/en/api/beta/messages/batches.md b/content/en/api/beta/messages/batches.md index 9ddedda00..242cf9c32 100644 --- a/content/en/api/beta/messages/batches.md +++ b/content/en/api/beta/messages/batches.md @@ -18,7 +18,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -1788,7 +1802,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1796,6 +1810,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -1804,7 +1820,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1812,6 +1828,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `Default = "default"` - `inference_geo: optional string or null` @@ -4087,7 +4105,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -4157,6 +4175,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaMessageBatch object` @@ -4333,7 +4365,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -4403,6 +4435,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaMessageBatch` @@ -4588,7 +4634,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -4658,6 +4704,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaMessageBatch object` @@ -4825,7 +4885,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -4895,6 +4955,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaDeletedMessageBatch object` @@ -4954,7 +5028,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -5024,6 +5098,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaMessageBatchIndividualResponse object` @@ -6459,12 +6547,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -8520,12 +8610,14 @@ curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/results \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -10352,12 +10444,14 @@ curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/results \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -12136,12 +12230,14 @@ curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/results \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. diff --git a/content/en/api/beta/messages/batches/cancel.md b/content/en/api/beta/messages/batches/cancel.md index 7244d2a5a..5e228ad51 100644 --- a/content/en/api/beta/messages/batches/cancel.md +++ b/content/en/api/beta/messages/batches/cancel.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaMessageBatch object` diff --git a/content/en/api/beta/messages/batches/create.md b/content/en/api/beta/messages/batches/create.md index 40ea0b2ce..6d83fb8cd 100644 --- a/content/en/api/beta/messages/batches/create.md +++ b/content/en/api/beta/messages/batches/create.md @@ -16,7 +16,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -1786,7 +1800,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1794,6 +1808,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -1802,7 +1818,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1810,6 +1826,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `Default = "default"` - `inference_geo: optional string or null` diff --git a/content/en/api/beta/messages/batches/delete.md b/content/en/api/beta/messages/batches/delete.md index c9a5fb4d8..63089e251 100644 --- a/content/en/api/beta/messages/batches/delete.md +++ b/content/en/api/beta/messages/batches/delete.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaDeletedMessageBatch object` diff --git a/content/en/api/beta/messages/batches/list.md b/content/en/api/beta/messages/batches/list.md index 53850c5ed..29296f45a 100644 --- a/content/en/api/beta/messages/batches/list.md +++ b/content/en/api/beta/messages/batches/list.md @@ -32,7 +32,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaMessageBatch` diff --git a/content/en/api/beta/messages/batches/results.md b/content/en/api/beta/messages/batches/results.md index e3e03406c..1c33c8f63 100644 --- a/content/en/api/beta/messages/batches/results.md +++ b/content/en/api/beta/messages/batches/results.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaMessageBatchIndividualResponse object` @@ -1527,12 +1541,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. diff --git a/content/en/api/beta/messages/batches/retrieve.md b/content/en/api/beta/messages/batches/retrieve.md index 6c2c6e62a..19d0f1283 100644 --- a/content/en/api/beta/messages/batches/retrieve.md +++ b/content/en/api/beta/messages/batches/retrieve.md @@ -20,7 +20,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaMessageBatch object` diff --git a/content/en/api/beta/messages/count_tokens.md b/content/en/api/beta/messages/count_tokens.md index 9f969096f..84a659805 100644 --- a/content/en/api/beta/messages/count_tokens.md +++ b/content/en/api/beta/messages/count_tokens.md @@ -16,7 +16,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -1690,7 +1704,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1698,6 +1712,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -1706,7 +1722,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1714,6 +1730,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice: optional BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. diff --git a/content/en/api/beta/messages/create.md b/content/en/api/beta/messages/create.md index 01451633e..569c13d3b 100644 --- a/content/en/api/beta/messages/create.md +++ b/content/en/api/beta/messages/create.md @@ -16,7 +16,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -1766,7 +1780,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "enabled"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1774,6 +1788,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled object` - `type: "disabled"` @@ -1782,7 +1798,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "adaptive"` - - `display: optional "summarized" or "omitted" or null` + - `display: optional "summarized" or "omitted" or "updates" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1790,6 +1806,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `Default = "default"` - `inference_geo: optional string or null` @@ -5300,12 +5318,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage object` Token usage for a sampling iteration. @@ -5615,12 +5635,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: number` The cumulative number of output tokens which were used. diff --git a/content/en/api/beta/models.md b/content/en/api/beta/models.md index f418db737..252ae0616 100644 --- a/content/en/api/beta/models.md +++ b/content/en/api/beta/models.md @@ -34,7 +34,7 @@ The Models API response can be used to determine which models are available for - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaModelInfo` @@ -368,7 +382,7 @@ The Models API response can be used to determine information about a specific mo - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -438,6 +452,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaModelInfo object` diff --git a/content/en/api/beta/models/list.md b/content/en/api/beta/models/list.md index f314d1793..9a2e60988 100644 --- a/content/en/api/beta/models/list.md +++ b/content/en/api/beta/models/list.md @@ -32,7 +32,7 @@ The Models API response can be used to determine which models are available for - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaModelInfo` diff --git a/content/en/api/beta/models/retrieve.md b/content/en/api/beta/models/retrieve.md index 9ad70505e..a32ccd461 100644 --- a/content/en/api/beta/models/retrieve.md +++ b/content/en/api/beta/models/retrieve.md @@ -20,7 +20,7 @@ The Models API response can be used to determine information about a specific mo - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaModelInfo object` diff --git a/content/en/api/beta/organization.md b/content/en/api/beta/organization.md new file mode 100644 index 000000000..b427a11e8 --- /dev/null +++ b/content/en/api/beta/organization.md @@ -0,0 +1,10225 @@ +# Organization + +## Get Current Organization + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +### Returns + +- `BetaOrganization object` + + - `id: string` + + ID of the Organization. + + format: uuid + + - `name: string` + + Name of the Organization. + + - `type: "organization"` + + Object type. + + For Organizations, this is always `"organization"`. + + default: organization + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/me \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Domain types + +### Beta Organization + +- `BetaOrganization object` + + - `id: string` + + ID of the Organization. + + format: uuid + + - `name: string` + + Name of the Organization. + + - `type: "organization"` + + Object type. + + For Organizations, this is always `"organization"`. + + default: organization + +### Beta Organization Role + +- `BetaOrganizationRole = "admin" or "billing" or "claude_code_user" or 6 more` + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + +## Organization › API Keys + +### List API Keys + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `created_by_user_id: optional string` + + Filter by the ID of the User who created the object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `status: optional "active" or "archived" or "expired" or "inactive"` + + Filter by API key status. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + +- `workspace_id: optional string` + + Filter by Workspace ID. + +#### Returns + +- `data: array of BetaAPIKey` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Path parameters + +- `api_key_id: string` + + ID of the API key. + +#### Returns + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Path parameters + +- `api_key_id: string` + + ID of the API key. + +#### Body parameters + +- `name: optional string or null` + + Name of the API key. + + maxLength: 500, minLength: 1 + +- `status: optional "active" or "archived" or "inactive" or null` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"inactive"` + +#### Returns + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Organization › External Keys + +### Create External Key + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Body parameters + +- `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +- `display_name: optional string or null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: optional "us"` + + Data residency geo. Only `us` is supported. + +#### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `data: array of BetaExternalKey` + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Body parameters + +- `display_name: optional string or null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: optional "us" or null` + + Data residency geo. Only `us` is supported. + +- `provider_config: optional BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam or null` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +#### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `id: string` + + ID of the deleted External Key. + +- `type: "external_key_deleted"` + + default: external_key_deleted + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `error: string or null` + + Error message when status is `failure`. Null otherwise. + +- `status: "failure" or "success"` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"failure"` + + - `"success"` + +- `type: "external_key_validation"` + + default: external_key_validation + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Organization › Federation › Issuers + +### Create Federation Issuer + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `issuer_url: string` + + The `iss` claim value to match against. + + minLength: 1 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained. Defaults to OIDC discovery. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_url": "x", + "name": "x" + }' +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationIssuer` + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to update. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `issuer_url: optional string or null` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline or null` + + Replaces the entire JWKS configuration. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `jwks_polling_disabled: optional boolean or null` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to archive. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Organization › Federation › Rules + +### Create Federation Rule + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `issuer_id: string` + + Tagged ID of the federation issuer. + +- `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: string` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `applies_to_all_workspaces: optional boolean` + + When true, enable this rule for every workspace in the org (including workspaces created later). + +- `attributes: optional map[string] or null` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `token_lifetime_seconds: optional number` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_id": "issuer_id", + "match": {}, + "name": "x", + "oauth_scope": "x", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `issuer_id: optional string` + + Filter to rules referencing this federation issuer. + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationRule` + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to update. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `applies_to_all_workspaces: optional boolean or null` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `attributes: optional map[string] or null` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `match: optional BetaFederationRuleMatch or null` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: optional string or null` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: optional BetaServiceAccountTarget or null` + + Bind to a fixed service account by ID. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `token_lifetime_seconds: optional number or null` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to archive. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_id: string` + + Tagged ID of the workspace to enable this rule for. + +#### Returns + +- `BetaFederationRuleWorkspace object` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id" + }' +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +- `next_page: string or null` + + Opaque cursor for the next page; null when there are no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +- `workspace_id: string` + + ID of the workspace to disable for. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `federation_rule_id: string` + + Tagged ID of the federation rule. + +- `type: "federation_rule_workspace_deleted"` + + default: federation_rule_workspace_deleted + +- `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Organization › Invites + +### Create Invite + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Body parameters + +- `email: string` + + Email of the User. + + format: email + +- `role: "billing" or "claude_code_user" or "developer" or 2 more` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +- `rbac_group_ids: optional array of string` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "email": "user@emaildomain.com", + "role": "user" + }' +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: optional string` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +- `statuses: optional array of "accepted" or "expired" or "pending"` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `"accepted"` + + - `"expired"` + + - `"pending"` + +#### Returns + +- `data: array of BetaOrganizationInvite` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Path parameters + +- `invite_id: string` + + ID of the Invite. + +#### Returns + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Path parameters + +- `invite_id: string` + + ID of the Invite. + +#### Returns + +- `id: string` + + ID of the Invite. + +- `type: "invite_deleted"` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + + default: invite_deleted + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Organization › Service Accounts + +### Create Service Account + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `organization_role: optional "admin" or "developer"` + + Org-level role. Defaults to `developer`. + + - `"admin"` + + - `"developer"` + +#### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "name": "ci-deploy-bot" + }' +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaServiceAccount` + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Path parameters + +- `service_account_id: string` + + ID of the service account to update. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `organization_role: optional "admin" or "developer" or null` + + Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `"admin"` + + - `"developer"` + +#### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account to archive. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_id: string` + + Tagged workspace ID to add the service account to. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +- `workspace_id: string` + + ID of the workspace. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Organization › Users + +### List Users + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: optional string` + + Filter by user email. + + format: email + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `data: array of BetaOrganizationUser` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Path parameters + +- `user_id: string` + + ID of the User. + +#### Returns + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Path parameters + +- `user_id: string` + + ID of the User. + +#### Body parameters + +- `role: "billing" or "claude_code_user" or "developer" or 2 more` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +#### Returns + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "role": "user" + }' +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Path parameters + +- `user_id: string` + + ID of the User. + +#### Returns + +- `id: string` + + ID of the User. + +- `type: "user_deleted"` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + + default: user_deleted + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Organization › Workspaces + +### List Workspaces + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `include_archived: optional boolean` + + Whether to include Workspaces that have been archived in the response + + default: false + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +#### Returns + +- `data: array of BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `name: string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `data_residency: optional BetaDataResidencyCreateConfig or null` + + Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + + - `workspace_geo: optional "us" or null` + + Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. + +- `display_color: optional string or null` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: optional string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `tags: optional map[string] or null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "name": "x", + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "tags": { + "env": "prod", + "team": "platform" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +#### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Path parameters + +- `workspace_id: string` + +#### Body parameters + +- `data_residency: optional BetaDataResidencyUpdateConfig or null` + + Data residency configuration for the workspace. + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + +- `display_color: optional string` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: optional string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `name: optional string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `tags: optional map[string] or null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "tags": { + "env": "prod", + "team": "platform" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Path parameters + +- `workspace_id: string` + +#### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Path parameters + +- `workspace_id: string` + + The ID of the workspace. + +#### Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `data: array of BetaWorkspaceRateLimit` + + Rate-limit entries for the workspace, one per group that has at least one override. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaWorkspaceRateLimitValue` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: number or null` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: string` + + The `id` of the RateLimit group this override applies to. + + - `type: "workspace_rate_limit"` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `workspace_id: string` + + ID of the Workspace this override applies to. + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Organization › Workspaces › Members + +### List Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +#### Returns + +- `data: array of BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +#### Body parameters + +- `user_id: string` + + ID of the User. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Body parameters + +- `workspace_role: BetaWorkspaceRole` + + New workspace role for the User. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Returns + +- `type: "workspace_member_deleted"` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + +- `user_id: string` + + ID of the User. + +- `workspace_id: string` + + ID of the Workspace. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `service_account_id: string` + + Tagged service account ID to add. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "service_account_id": "service_account_id", + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Get Service Account Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Update Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_role: BetaNoBillingWorkspaceRole` + + New role for the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Delete Service Account Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Organization › Rate Limits + +### List Organization Rate Limits + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `model: optional string` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `data: array of BetaOrganizationRateLimit` + + Rate-limit entries for the organization, one per group. + + - `id: string` + + Stable identifier for this rate-limit group within the organization. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaOrganizationRateLimitValue` + + The limiter values that apply to this group. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The configured limit value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: "rate_limit"` + + Object type. Always `rate_limit` for organization rate-limit entries. + + default: rate_limit + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/rate_limits \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/api_keys.md b/content/en/api/beta/organization/api_keys.md new file mode 100644 index 000000000..57908aa65 --- /dev/null +++ b/content/en/api/beta/organization/api_keys.md @@ -0,0 +1,779 @@ +# API Keys + +## List API Keys + +**GET** `/v1/organizations/api_keys` + +List API Keys + +### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `created_by_user_id: optional string` + + Filter by the ID of the User who created the object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `status: optional "active" or "archived" or "expired" or "inactive"` + + Filter by API key status. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + +- `workspace_id: optional string` + + Filter by Workspace ID. + +### Returns + +- `data: array of BetaAPIKey` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +## Get API Key + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +### Path parameters + +- `api_key_id: string` + + ID of the API key. + +### Returns + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Update API Key + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +### Path parameters + +- `api_key_id: string` + + ID of the API key. + +### Body parameters + +- `name: optional string or null` + + Name of the API key. + + maxLength: 500, minLength: 1 + +- `status: optional "active" or "archived" or "inactive" or null` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"inactive"` + +### Returns + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +#### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Domain types + +### Beta API Key + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +### Beta API Key Created By + +- `BetaAPIKeyCreatedBy object` + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + +### Beta API Key Organization Scope + +- `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + +### Beta API Key Service Account Actor + +- `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + +### Beta API Key User Actor + +- `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + +### Beta API Key Workspace Scope + +- `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. diff --git a/content/en/api/beta/organization/api_keys/list.md b/content/en/api/beta/organization/api_keys/list.md new file mode 100644 index 000000000..e3d3109ef --- /dev/null +++ b/content/en/api/beta/organization/api_keys/list.md @@ -0,0 +1,221 @@ +# List API Keys + +**GET** `/v1/organizations/api_keys` + +List API Keys + +## Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `created_by_user_id: optional string` + + Filter by the ID of the User who created the object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `status: optional "active" or "archived" or "expired" or "inactive"` + + Filter by API key status. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + +- `workspace_id: optional string` + + Filter by Workspace ID. + +## Returns + +- `data: array of BetaAPIKey` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` diff --git a/content/en/api/beta/organization/api_keys/retrieve.md b/content/en/api/beta/organization/api_keys/retrieve.md new file mode 100644 index 000000000..78ac7b3ac --- /dev/null +++ b/content/en/api/beta/organization/api_keys/retrieve.md @@ -0,0 +1,170 @@ +# Get API Key + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +## Path parameters + +- `api_key_id: string` + + ID of the API key. + +## Returns + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` diff --git a/content/en/api/beta/organization/api_keys/update.md b/content/en/api/beta/organization/api_keys/update.md new file mode 100644 index 000000000..92054dd1f --- /dev/null +++ b/content/en/api/beta/organization/api_keys/update.md @@ -0,0 +1,190 @@ +# Update API Key + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +## Path parameters + +- `api_key_id: string` + + ID of the API key. + +## Body parameters + +- `name: optional string or null` + + Name of the API key. + + maxLength: 500, minLength: 1 + +- `status: optional "active" or "archived" or "inactive" or null` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"inactive"` + +## Returns + +- `BetaAPIKey object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy or null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string or null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string or null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string or null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` diff --git a/content/en/api/beta/organization/external_keys.md b/content/en/api/beta/organization/external_keys.md new file mode 100644 index 000000000..9b2a09480 --- /dev/null +++ b/content/en/api/beta/organization/external_keys.md @@ -0,0 +1,1067 @@ +# External Keys + +## Create External Key + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +### Body parameters + +- `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +- `display_name: optional string or null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: optional "us"` + + Data residency geo. Only `us` is supported. + +### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws" + } + }' +``` + +#### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +## List External Keys + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Returns + +- `data: array of BetaExternalKey` + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +## Get External Key + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +## Update External Key + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +### Body parameters + +- `display_name: optional string or null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: optional "us" or null` + + Data residency geo. Only `us` is supported. + +- `provider_config: optional BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam or null` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +### Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +#### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +## Delete External Key + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +### Returns + +- `id: string` + + ID of the deleted External Key. + +- `type: "external_key_deleted"` + + default: external_key_deleted + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +## Validate External Key + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +### Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +### Returns + +- `error: string or null` + + Error message when status is `failure`. Null otherwise. + +- `status: "failure" or "success"` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"failure"` + + - `"success"` + +- `type: "external_key_validation"` + + default: external_key_validation + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Domain types + +### Beta AWS External Key Config + +- `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + +### Beta Azure External Key Config + +- `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +### Beta Azure External Key Config Param + +- `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +### Beta External Key + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +### Beta External Key Attached Attachment + +- `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + +### Beta External Key Unattached Attachment + +- `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + +### Beta GCP External Key Config + +- `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + +### External Key Delete Response + +- `ExternalKeyDeleteResponse object` + + - `id: string` + + ID of the deleted External Key. + + - `type: "external_key_deleted"` + + default: external_key_deleted + +### External Key Validate Response + +- `ExternalKeyValidateResponse object` + + Result of a validation roundtrip against the customer's KMS. + + HTTP 200 for both outcomes — the operation completed; `status` says + whether the key works. + + - `error: string or null` + + Error message when status is `failure`. Null otherwise. + + - `status: "failure" or "success"` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"failure"` + + - `"success"` + + - `type: "external_key_validation"` + + default: external_key_validation diff --git a/content/en/api/beta/organization/external_keys/create.md b/content/en/api/beta/organization/external_keys/create.md new file mode 100644 index 000000000..fb521c866 --- /dev/null +++ b/content/en/api/beta/organization/external_keys/create.md @@ -0,0 +1,210 @@ +# Create External Key + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +## Body parameters + +- `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +- `display_name: optional string or null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: optional "us"` + + Data residency geo. Only `us` is supported. + +## Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws" + } + }' +``` + +### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` diff --git a/content/en/api/beta/organization/external_keys/delete.md b/content/en/api/beta/organization/external_keys/delete.md new file mode 100644 index 000000000..c4b4916be --- /dev/null +++ b/content/en/api/beta/organization/external_keys/delete.md @@ -0,0 +1,43 @@ +# Delete External Key + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +## Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +## Returns + +- `id: string` + + ID of the deleted External Key. + +- `type: "external_key_deleted"` + + default: external_key_deleted + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` diff --git a/content/en/api/beta/organization/external_keys/list.md b/content/en/api/beta/organization/external_keys/list.md new file mode 100644 index 000000000..28e857d46 --- /dev/null +++ b/content/en/api/beta/organization/external_keys/list.md @@ -0,0 +1,155 @@ +# List External Keys + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +## Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Returns + +- `data: array of BetaExternalKey` + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/external_keys/retrieve.md b/content/en/api/beta/organization/external_keys/retrieve.md new file mode 100644 index 000000000..ae42e4a31 --- /dev/null +++ b/content/en/api/beta/organization/external_keys/retrieve.md @@ -0,0 +1,145 @@ +# Get External Key + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +## Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +## Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` diff --git a/content/en/api/beta/organization/external_keys/update.md b/content/en/api/beta/organization/external_keys/update.md new file mode 100644 index 000000000..7c7acd51b --- /dev/null +++ b/content/en/api/beta/organization/external_keys/update.md @@ -0,0 +1,217 @@ +# Update External Key + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +## Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +## Body parameters + +- `display_name: optional string or null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: optional "us" or null` + + Data residency geo. Only `us` is supported. + +- `provider_config: optional BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam or null` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam object` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +## Returns + +- `BetaExternalKey object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment object` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment object` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string or null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string or null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string or null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string or null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` diff --git a/content/en/api/beta/organization/external_keys/validate.md b/content/en/api/beta/organization/external_keys/validate.md new file mode 100644 index 000000000..32bd6ab7b --- /dev/null +++ b/content/en/api/beta/organization/external_keys/validate.md @@ -0,0 +1,55 @@ +# Validate External Key + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +## Path parameters + +- `external_key_id: string` + + ID of the External Key. + + maxLength: 2048 + +## Returns + +- `error: string or null` + + Error message when status is `failure`. Null otherwise. + +- `status: "failure" or "success"` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"failure"` + + - `"success"` + +- `type: "external_key_validation"` + + default: external_key_validation + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` diff --git a/content/en/api/beta/organization/federation.md b/content/en/api/beta/organization/federation.md new file mode 100644 index 000000000..419b174e4 --- /dev/null +++ b/content/en/api/beta/organization/federation.md @@ -0,0 +1,3816 @@ +# Federation + +## Federation › Issuers + +### Create Federation Issuer + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `issuer_url: string` + + The `iss` claim value to match against. + + minLength: 1 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained. Defaults to OIDC discovery. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_url": "x", + "name": "x" + }' +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationIssuer` + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to update. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `issuer_url: optional string or null` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline or null` + + Replaces the entire JWKS configuration. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `jwks_polling_disabled: optional boolean or null` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to archive. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Federation › Rules + +### Create Federation Rule + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `issuer_id: string` + + Tagged ID of the federation issuer. + +- `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: string` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `applies_to_all_workspaces: optional boolean` + + When true, enable this rule for every workspace in the org (including workspaces created later). + +- `attributes: optional map[string] or null` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `token_lifetime_seconds: optional number` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_id": "issuer_id", + "match": {}, + "name": "x", + "oauth_scope": "x", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account" + } + }' +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `issuer_id: optional string` + + Filter to rules referencing this federation issuer. + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationRule` + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to update. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `applies_to_all_workspaces: optional boolean or null` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `attributes: optional map[string] or null` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `match: optional BetaFederationRuleMatch or null` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: optional string or null` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: optional BetaServiceAccountTarget or null` + + Bind to a fixed service account by ID. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `token_lifetime_seconds: optional number or null` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to archive. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_id: string` + + Tagged ID of the workspace to enable this rule for. + +#### Returns + +- `BetaFederationRuleWorkspace object` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id" + }' +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +- `next_page: string or null` + + Opaque cursor for the next page; null when there are no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +- `workspace_id: string` + + ID of the workspace to disable for. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `federation_rule_id: string` + + Tagged ID of the federation rule. + +- `type: "federation_rule_workspace_deleted"` + + default: federation_rule_workspace_deleted + +- `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` diff --git a/content/en/api/beta/organization/federation/issuers.md b/content/en/api/beta/organization/federation/issuers.md new file mode 100644 index 000000000..5a8a8fc93 --- /dev/null +++ b/content/en/api/beta/organization/federation/issuers.md @@ -0,0 +1,1853 @@ +# Issuers + +## Create Federation Issuer + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `issuer_url: string` + + The `iss` claim value to match against. + + minLength: 1 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained. Defaults to OIDC discovery. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_url": "x", + "name": "x" + }' +``` + +#### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## List Federation Issuers + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `data: array of BetaFederationIssuer` + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +## Get Federation Issuer + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Update Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to update. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `issuer_url: optional string or null` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline or null` + + Replaces the entire JWKS configuration. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `jwks_polling_disabled: optional boolean or null` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +#### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Archive Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +### Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to archive. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Domain types + +### Beta Federation Issuer + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +### Beta Federation Issuer Poll Status + +- `BetaFederationIssuerPollStatus object` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + +### Beta JWKS Discovery + +- `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + +### Beta JWKS Explicit URL + +- `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + +### Beta JWKS Inline + +- `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` diff --git a/content/en/api/beta/organization/federation/issuers/archive.md b/content/en/api/beta/organization/federation/issuers/archive.md new file mode 100644 index 000000000..1c2746548 --- /dev/null +++ b/content/en/api/beta/organization/federation/issuers/archive.md @@ -0,0 +1,292 @@ +# Archive Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +## Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to archive. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` diff --git a/content/en/api/beta/organization/federation/issuers/create.md b/content/en/api/beta/organization/federation/issuers/create.md new file mode 100644 index 000000000..3235fb3f0 --- /dev/null +++ b/content/en/api/beta/organization/federation/issuers/create.md @@ -0,0 +1,369 @@ +# Create Federation Issuer + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `issuer_url: string` + + The `iss` claim value to match against. + + minLength: 1 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained. Defaults to OIDC discovery. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +## Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_url": "x", + "name": "x" + }' +``` + +### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` diff --git a/content/en/api/beta/organization/federation/issuers/list.md b/content/en/api/beta/organization/federation/issuers/list.md new file mode 100644 index 000000000..3b170b754 --- /dev/null +++ b/content/en/api/beta/organization/federation/issuers/list.md @@ -0,0 +1,304 @@ +# List Federation Issuers + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +## Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `data: array of BetaFederationIssuer` + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/federation/issuers/retrieve.md b/content/en/api/beta/organization/federation/issuers/retrieve.md new file mode 100644 index 000000000..51a1b60e8 --- /dev/null +++ b/content/en/api/beta/organization/federation/issuers/retrieve.md @@ -0,0 +1,286 @@ +# Get Federation Issuer + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +## Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` diff --git a/content/en/api/beta/organization/federation/issuers/update.md b/content/en/api/beta/organization/federation/issuers/update.md new file mode 100644 index 000000000..a3f4c7cfc --- /dev/null +++ b/content/en/api/beta/organization/federation/issuers/update.md @@ -0,0 +1,373 @@ +# Update Federation Issuer + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +## Path parameters + +- `federation_issuer_id: string` + + ID of the federation issuer to update. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `check_jti: optional boolean or null` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `issuer_url: optional string or null` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + +- `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline or null` + + Replaces the entire JWKS configuration. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + +- `jwks_polling_disabled: optional boolean or null` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `max_jwt_lifetime_seconds: optional number or null` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +## Returns + +- `BetaFederationIssuer object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string or null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string or null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string or null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string or null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus or null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string or null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string or null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` diff --git a/content/en/api/beta/organization/federation/rules.md b/content/en/api/beta/organization/federation/rules.md new file mode 100644 index 000000000..a73503716 --- /dev/null +++ b/content/en/api/beta/organization/federation/rules.md @@ -0,0 +1,2396 @@ +# Rules + +## Create Federation Rule + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `issuer_id: string` + + Tagged ID of the federation issuer. + +- `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: string` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `applies_to_all_workspaces: optional boolean` + + When true, enable this rule for every workspace in the org (including workspaces created later). + +- `attributes: optional map[string] or null` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `token_lifetime_seconds: optional number` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_id": "issuer_id", + "match": {}, + "name": "x", + "oauth_scope": "x", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account" + } + }' +``` + +#### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## List Federation Rules + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `issuer_id: optional string` + + Filter to rules referencing this federation issuer. + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `data: array of BetaFederationRule` + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +## Get Federation Rule + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Update Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to update. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `applies_to_all_workspaces: optional boolean or null` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `attributes: optional map[string] or null` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `match: optional BetaFederationRuleMatch or null` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: optional string or null` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: optional BetaServiceAccountTarget or null` + + Bind to a fixed service account by ID. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `token_lifetime_seconds: optional number or null` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +#### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Archive Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to archive. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Domain types + +### Beta Federation Rule + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +### Beta Federation Rule Match + +- `BetaFederationRuleMatch object` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +### Beta Federation Rule Workspace + +- `BetaFederationRuleWorkspace object` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +### Beta Service Account Target + +- `BetaServiceAccountTarget object` + + Bind to a fixed service account by ID. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +## Rules › Workspaces + +### Add Federation Rule Workspace + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_id: string` + + Tagged ID of the workspace to enable this rule for. + +#### Returns + +- `BetaFederationRuleWorkspace object` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id" + }' +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +- `next_page: string or null` + + Opaque cursor for the next page; null when there are no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +- `workspace_id: string` + + ID of the workspace to disable for. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `federation_rule_id: string` + + Tagged ID of the federation rule. + +- `type: "federation_rule_workspace_deleted"` + + default: federation_rule_workspace_deleted + +- `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` diff --git a/content/en/api/beta/organization/federation/rules/archive.md b/content/en/api/beta/organization/federation/rules/archive.md new file mode 100644 index 000000000..879a7f4c3 --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/archive.md @@ -0,0 +1,297 @@ +# Archive Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +## Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to archive. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` diff --git a/content/en/api/beta/organization/federation/rules/create.md b/content/en/api/beta/organization/federation/rules/create.md new file mode 100644 index 000000000..656f2388a --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/create.md @@ -0,0 +1,389 @@ +# Create Federation Rule + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `issuer_id: string` + + Tagged ID of the federation issuer. + +- `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: string` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `applies_to_all_workspaces: optional boolean` + + When true, enable this rule for every workspace in the org (including workspaces created later). + +- `attributes: optional map[string] or null` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `token_lifetime_seconds: optional number` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +## Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "issuer_id": "issuer_id", + "match": {}, + "name": "x", + "oauth_scope": "x", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account" + } + }' +``` + +### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` diff --git a/content/en/api/beta/organization/federation/rules/list.md b/content/en/api/beta/organization/federation/rules/list.md new file mode 100644 index 000000000..6fde877fd --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/list.md @@ -0,0 +1,305 @@ +# List Federation Rules + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +## Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `issuer_id: optional string` + + Filter to rules referencing this federation issuer. + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `data: array of BetaFederationRule` + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/federation/rules/retrieve.md b/content/en/api/beta/organization/federation/rules/retrieve.md new file mode 100644 index 000000000..0957a2d7d --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/retrieve.md @@ -0,0 +1,288 @@ +# Get Federation Rule + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +## Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` diff --git a/content/en/api/beta/organization/federation/rules/update.md b/content/en/api/beta/organization/federation/rules/update.md new file mode 100644 index 000000000..258426ef1 --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/update.md @@ -0,0 +1,388 @@ +# Update Federation Rule + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +## Path parameters + +- `federation_rule_id: string` + + ID of the federation rule to update. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `applies_to_all_workspaces: optional boolean or null` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `attributes: optional map[string] or null` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `match: optional BetaFederationRuleMatch or null` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: optional string or null` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: optional string or null` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: optional BetaServiceAccountTarget or null` + + Bind to a fixed service account by ID. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + +- `token_lifetime_seconds: optional number or null` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: optional string or null` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +## Returns + +- `BetaFederationRule object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string or null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string] or null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string or null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string or null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string or null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string] or null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string or null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string or null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string or null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string or null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` diff --git a/content/en/api/beta/organization/federation/rules/workspaces.md b/content/en/api/beta/organization/federation/rules/workspaces.md new file mode 100644 index 000000000..04a3138f8 --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/workspaces.md @@ -0,0 +1,527 @@ +# Workspaces + +## Add Federation Rule Workspace + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `workspace_id: string` + + Tagged ID of the workspace to enable this rule for. + +### Returns + +- `BetaFederationRuleWorkspace object` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id" + }' +``` + +#### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +## List Federation Rule Workspaces + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `data: array of BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +- `next_page: string or null` + + Opaque cursor for the next page; null when there are no more results. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +## Remove Federation Rule Workspace + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +### Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +- `workspace_id: string` + + ID of the workspace to disable for. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `federation_rule_id: string` + + Tagged ID of the federation rule. + +- `type: "federation_rule_workspace_deleted"` + + default: federation_rule_workspace_deleted + +- `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Domain types + +### Workspace Remove Response + +- `WorkspaceRemoveResponse object` + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace_deleted"` + + default: federation_rule_workspace_deleted + + - `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. diff --git a/content/en/api/beta/organization/federation/rules/workspaces/add.md b/content/en/api/beta/organization/federation/rules/workspaces/add.md new file mode 100644 index 000000000..d542686b1 --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/workspaces/add.md @@ -0,0 +1,175 @@ +# Add Federation Rule Workspace + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +## Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `workspace_id: string` + + Tagged ID of the workspace to enable this rule for. + +## Returns + +- `BetaFederationRuleWorkspace object` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id" + }' +``` + +### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` diff --git a/content/en/api/beta/organization/federation/rules/workspaces/list.md b/content/en/api/beta/organization/federation/rules/workspaces/list.md new file mode 100644 index 000000000..d1b114c79 --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/workspaces/list.md @@ -0,0 +1,183 @@ +# List Federation Rule Workspaces + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +## Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +## Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `data: array of BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string or null` + + Workspace display name. Populated when listing; null in the enable response. + +- `next_page: string or null` + + Opaque cursor for the next page; null when there are no more results. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/federation/rules/workspaces/remove.md b/content/en/api/beta/organization/federation/rules/workspaces/remove.md new file mode 100644 index 000000000..aac8f3582 --- /dev/null +++ b/content/en/api/beta/organization/federation/rules/workspaces/remove.md @@ -0,0 +1,147 @@ +# Remove Federation Rule Workspace + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +## Path parameters + +- `federation_rule_id: string` + + ID of the federation rule. + +- `workspace_id: string` + + ID of the workspace to disable for. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `federation_rule_id: string` + + Tagged ID of the federation rule. + +- `type: "federation_rule_workspace_deleted"` + + default: federation_rule_workspace_deleted + +- `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` diff --git a/content/en/api/beta/organization/invites.md b/content/en/api/beta/organization/invites.md new file mode 100644 index 000000000..36d3cc760 --- /dev/null +++ b/content/en/api/beta/organization/invites.md @@ -0,0 +1,565 @@ +# Invites + +## Create Invite + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +### Body parameters + +- `email: string` + + Email of the User. + + format: email + +- `role: "billing" or "claude_code_user" or "developer" or 2 more` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +- `rbac_group_ids: optional array of string` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +### Returns + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "email": "user@emaildomain.com", + "role": "user" + }' +``` + +#### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +## List Invites + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: optional string` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +- `statuses: optional array of "accepted" or "expired" or "pending"` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `"accepted"` + + - `"expired"` + + - `"pending"` + +### Returns + +- `data: array of BetaOrganizationInvite` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +## Get Invite + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +### Path parameters + +- `invite_id: string` + + ID of the Invite. + +### Returns + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +## Delete Invite + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +### Path parameters + +- `invite_id: string` + + ID of the Invite. + +### Returns + +- `id: string` + + ID of the Invite. + +- `type: "invite_deleted"` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + + default: invite_deleted + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Domain types + +### Beta Organization Invite + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +### Invite Delete Response + +- `InviteDeleteResponse object` + + - `id: string` + + ID of the Invite. + + - `type: "invite_deleted"` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + + default: invite_deleted diff --git a/content/en/api/beta/organization/invites/create.md b/content/en/api/beta/organization/invites/create.md new file mode 100644 index 000000000..8a54efa8d --- /dev/null +++ b/content/en/api/beta/organization/invites/create.md @@ -0,0 +1,144 @@ +# Create Invite + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +## Body parameters + +- `email: string` + + Email of the User. + + format: email + +- `role: "billing" or "claude_code_user" or "developer" or 2 more` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +- `rbac_group_ids: optional array of string` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +## Returns + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "email": "user@emaildomain.com", + "role": "user" + }' +``` + +### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` diff --git a/content/en/api/beta/organization/invites/delete.md b/content/en/api/beta/organization/invites/delete.md new file mode 100644 index 000000000..00b275b14 --- /dev/null +++ b/content/en/api/beta/organization/invites/delete.md @@ -0,0 +1,43 @@ +# Delete Invite + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +## Path parameters + +- `invite_id: string` + + ID of the Invite. + +## Returns + +- `id: string` + + ID of the Invite. + +- `type: "invite_deleted"` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + + default: invite_deleted + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` diff --git a/content/en/api/beta/organization/invites/list.md b/content/en/api/beta/organization/invites/list.md new file mode 100644 index 000000000..501546a3e --- /dev/null +++ b/content/en/api/beta/organization/invites/list.md @@ -0,0 +1,166 @@ +# List Invites + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +## Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: optional string` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +- `statuses: optional array of "accepted" or "expired" or "pending"` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `"accepted"` + + - `"expired"` + + - `"pending"` + +## Returns + +- `data: array of BetaOrganizationInvite` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` diff --git a/content/en/api/beta/organization/invites/retrieve.md b/content/en/api/beta/organization/invites/retrieve.md new file mode 100644 index 000000000..e2e94618d --- /dev/null +++ b/content/en/api/beta/organization/invites/retrieve.md @@ -0,0 +1,113 @@ +# Get Invite + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +## Path parameters + +- `invite_id: string` + + ID of the Invite. + +## Returns + +- `BetaOrganizationInvite object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string or null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` diff --git a/content/en/api/beta/organization/rate_limits.md b/content/en/api/beta/organization/rate_limits.md new file mode 100644 index 000000000..0bbd221e5 --- /dev/null +++ b/content/en/api/beta/organization/rate_limits.md @@ -0,0 +1,193 @@ +# Rate Limits + +## List Organization Rate Limits + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +### Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `model: optional string` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Returns + +- `data: array of BetaOrganizationRateLimit` + + Rate-limit entries for the organization, one per group. + + - `id: string` + + Stable identifier for this rate-limit group within the organization. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaOrganizationRateLimitValue` + + The limiter values that apply to this group. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The configured limit value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: "rate_limit"` + + Object type. Always `rate_limit` for organization rate-limit entries. + + default: rate_limit + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/rate_limits \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" +} +``` + +## Domain types + +### Beta Organization Rate Limit + +- `BetaOrganizationRateLimit object` + + - `id: string` + + Stable identifier for this rate-limit group within the organization. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaOrganizationRateLimitValue` + + The limiter values that apply to this group. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The configured limit value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: "rate_limit"` + + Object type. Always `rate_limit` for organization rate-limit entries. + + default: rate_limit + +### Beta Organization Rate Limit Value + +- `BetaOrganizationRateLimitValue object` + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The configured limit value for this limiter type. diff --git a/content/en/api/beta/organization/rate_limits/list.md b/content/en/api/beta/organization/rate_limits/list.md new file mode 100644 index 000000000..a79ca12f7 --- /dev/null +++ b/content/en/api/beta/organization/rate_limits/list.md @@ -0,0 +1,131 @@ +# List Organization Rate Limits + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +## Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `model: optional string` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Returns + +- `data: array of BetaOrganizationRateLimit` + + Rate-limit entries for the organization, one per group. + + - `id: string` + + Stable identifier for this rate-limit group within the organization. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaOrganizationRateLimitValue` + + The limiter values that apply to this group. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The configured limit value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: "rate_limit"` + + Object type. Always `rate_limit` for organization rate-limit entries. + + default: rate_limit + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/rate_limits \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/retrieve.md b/content/en/api/beta/organization/retrieve.md new file mode 100644 index 000000000..9de73e18f --- /dev/null +++ b/content/en/api/beta/organization/retrieve.md @@ -0,0 +1,45 @@ +# Get Current Organization + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +## Returns + +- `BetaOrganization object` + + - `id: string` + + ID of the Organization. + + format: uuid + + - `name: string` + + Name of the Organization. + + - `type: "organization"` + + Object type. + + For Organizations, this is always `"organization"`. + + default: organization + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/me \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` diff --git a/content/en/api/beta/organization/service_accounts.md b/content/en/api/beta/organization/service_accounts.md new file mode 100644 index 000000000..b50a64830 --- /dev/null +++ b/content/en/api/beta/organization/service_accounts.md @@ -0,0 +1,1704 @@ +# Service Accounts + +## Create Service Account + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `organization_role: optional "admin" or "developer"` + + Org-level role. Defaults to `developer`. + + - `"admin"` + + - `"developer"` + +### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "name": "ci-deploy-bot" + }' +``` + +#### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## List Service Accounts + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +### Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `data: array of BetaServiceAccount` + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +## Get Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +### Path parameters + +- `service_account_id: string` + + ID of the service account. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Update Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +### Path parameters + +- `service_account_id: string` + + ID of the service account to update. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `organization_role: optional "admin" or "developer" or null` + + Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `"admin"` + + - `"developer"` + +### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +#### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Archive Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +### Path parameters + +- `service_account_id: string` + + ID of the service account to archive. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Domain types + +### Beta Service Account + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +### Beta Service Account Workspace Member + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Service Accounts › Workspaces + +### Add Workspace To Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_id: string` + + Tagged workspace ID to add the service account to. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Path parameters + +- `service_account_id: string` + + ID of the service account. + +- `workspace_id: string` + + ID of the workspace. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` diff --git a/content/en/api/beta/organization/service_accounts/archive.md b/content/en/api/beta/organization/service_accounts/archive.md new file mode 100644 index 000000000..b64872fbb --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/archive.md @@ -0,0 +1,200 @@ +# Archive Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +## Path parameters + +- `service_account_id: string` + + ID of the service account to archive. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` diff --git a/content/en/api/beta/organization/service_accounts/create.md b/content/en/api/beta/organization/service_accounts/create.md new file mode 100644 index 000000000..62a4d5f3e --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/create.md @@ -0,0 +1,222 @@ +# Create Service Account + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `description: optional string or null` + + Optional free-text description. + + maxLength: 2000 + +- `organization_role: optional "admin" or "developer"` + + Org-level role. Defaults to `developer`. + + - `"admin"` + + - `"developer"` + +## Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "name": "ci-deploy-bot" + }' +``` + +### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` diff --git a/content/en/api/beta/organization/service_accounts/list.md b/content/en/api/beta/organization/service_accounts/list.md new file mode 100644 index 000000000..1b3b42e27 --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/list.md @@ -0,0 +1,214 @@ +# List Service Accounts + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +## Query parameters + +- `include_archived: optional boolean` + + Include archived resources. Defaults to false. + + default: false + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `data: array of BetaServiceAccount` + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/service_accounts/retrieve.md b/content/en/api/beta/organization/service_accounts/retrieve.md new file mode 100644 index 000000000..24d55574f --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/retrieve.md @@ -0,0 +1,194 @@ +# Get Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +## Path parameters + +- `service_account_id: string` + + ID of the service account. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` diff --git a/content/en/api/beta/organization/service_accounts/update.md b/content/en/api/beta/organization/service_accounts/update.md new file mode 100644 index 000000000..f67d1e8c6 --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/update.md @@ -0,0 +1,217 @@ +# Update Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +## Path parameters + +- `service_account_id: string` + + ID of the service account to update. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `description: optional string or null` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `organization_role: optional "admin" or "developer" or null` + + Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `"admin"` + + - `"developer"` + +## Returns + +- `BetaServiceAccount object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string or null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string or null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string or null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{}' +``` + +### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` diff --git a/content/en/api/beta/organization/service_accounts/workspaces.md b/content/en/api/beta/organization/service_accounts/workspaces.md new file mode 100644 index 000000000..32f82f448 --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/workspaces.md @@ -0,0 +1,565 @@ +# Workspaces + +## Add Workspace To Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +### Path parameters + +- `service_account_id: string` + + ID of the service account. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `workspace_id: string` + + Tagged workspace ID to add the service account to. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + }' +``` + +#### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +## List Workspaces For Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +### Path parameters + +- `service_account_id: string` + + ID of the service account. + +### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +## Remove Workspace From Service Account + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +### Path parameters + +- `service_account_id: string` + + ID of the service account. + +- `workspace_id: string` + + ID of the workspace. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Domain types + +### Workspace Remove Response + +- `WorkspaceRemoveResponse object` + + - `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. diff --git a/content/en/api/beta/organization/service_accounts/workspaces/add.md b/content/en/api/beta/organization/service_accounts/workspaces/add.md new file mode 100644 index 000000000..ff7075bb9 --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/workspaces/add.md @@ -0,0 +1,194 @@ +# Add Workspace To Service Account + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +## Path parameters + +- `service_account_id: string` + + ID of the service account. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `workspace_id: string` + + Tagged workspace ID to add the service account to. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + }' +``` + +### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` diff --git a/content/en/api/beta/organization/service_accounts/workspaces/list.md b/content/en/api/beta/organization/service_accounts/workspaces/list.md new file mode 100644 index 000000000..e4760c86e --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/workspaces/list.md @@ -0,0 +1,199 @@ +# List Workspaces For Service Account + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +## Path parameters + +- `service_account_id: string` + + ID of the service account. + +## Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/service_accounts/workspaces/remove.md b/content/en/api/beta/organization/service_accounts/workspaces/remove.md new file mode 100644 index 000000000..0e4ebd43c --- /dev/null +++ b/content/en/api/beta/organization/service_accounts/workspaces/remove.md @@ -0,0 +1,150 @@ +# Remove Workspace From Service Account + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +## Path parameters + +- `service_account_id: string` + + ID of the service account. + +- `workspace_id: string` + + ID of the workspace. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` diff --git a/content/en/api/beta/organization/users.md b/content/en/api/beta/organization/users.md new file mode 100644 index 000000000..9ce09c057 --- /dev/null +++ b/content/en/api/beta/organization/users.md @@ -0,0 +1,435 @@ +# Users + +## List Users + +**GET** `/v1/organizations/users` + +List the organization's members. + +### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: optional string` + + Filter by user email. + + format: email + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +### Returns + +- `data: array of BetaOrganizationUser` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +## Get User + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +### Path parameters + +- `user_id: string` + + ID of the User. + +### Returns + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +## Update User + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +### Path parameters + +- `user_id: string` + + ID of the User. + +### Body parameters + +- `role: "billing" or "claude_code_user" or "developer" or 2 more` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +### Returns + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "role": "user" + }' +``` + +#### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +## Remove User + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +### Path parameters + +- `user_id: string` + + ID of the User. + +### Returns + +- `id: string` + + ID of the User. + +- `type: "user_deleted"` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + + default: user_deleted + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Domain types + +### Beta Organization User + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +### User Remove Response + +- `UserRemoveResponse object` + + - `id: string` + + ID of the User. + + - `type: "user_deleted"` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + + default: user_deleted diff --git a/content/en/api/beta/organization/users/list.md b/content/en/api/beta/organization/users/list.md new file mode 100644 index 000000000..cddf96fcf --- /dev/null +++ b/content/en/api/beta/organization/users/list.md @@ -0,0 +1,127 @@ +# List Users + +**GET** `/v1/organizations/users` + +List the organization's members. + +## Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: optional string` + + Filter by user email. + + format: email + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +## Returns + +- `data: array of BetaOrganizationUser` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/users \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` diff --git a/content/en/api/beta/organization/users/remove.md b/content/en/api/beta/organization/users/remove.md new file mode 100644 index 000000000..1a28e0e55 --- /dev/null +++ b/content/en/api/beta/organization/users/remove.md @@ -0,0 +1,43 @@ +# Remove User + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +## Path parameters + +- `user_id: string` + + ID of the User. + +## Returns + +- `id: string` + + ID of the User. + +- `type: "user_deleted"` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + + default: user_deleted + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` diff --git a/content/en/api/beta/organization/users/retrieve.md b/content/en/api/beta/organization/users/retrieve.md new file mode 100644 index 000000000..115cc3cc4 --- /dev/null +++ b/content/en/api/beta/organization/users/retrieve.md @@ -0,0 +1,84 @@ +# Get User + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +## Path parameters + +- `user_id: string` + + ID of the User. + +## Returns + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` diff --git a/content/en/api/beta/organization/users/update.md b/content/en/api/beta/organization/users/update.md new file mode 100644 index 000000000..adc95fcf2 --- /dev/null +++ b/content/en/api/beta/organization/users/update.md @@ -0,0 +1,106 @@ +# Update User + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +## Path parameters + +- `user_id: string` + + ID of the User. + +## Body parameters + +- `role: "billing" or "claude_code_user" or "developer" or 2 more` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +## Returns + +- `BetaOrganizationUser object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "role": "user" + }' +``` + +### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` diff --git a/content/en/api/beta/organization/workspaces.md b/content/en/api/beta/organization/workspaces.md new file mode 100644 index 000000000..00ed07a29 --- /dev/null +++ b/content/en/api/beta/organization/workspaces.md @@ -0,0 +1,2544 @@ +# Workspaces + +## List Workspaces + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `include_archived: optional boolean` + + Whether to include Workspaces that have been archived in the response + + default: false + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +### Returns + +- `data: array of BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +## Create Workspace + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `name: string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `data_residency: optional BetaDataResidencyCreateConfig or null` + + Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + + - `workspace_geo: optional "us" or null` + + Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. + +- `display_color: optional string or null` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: optional string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `tags: optional map[string] or null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "name": "x", + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "tags": { + "env": "prod", + "team": "platform" + } + }' +``` + +#### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Get Workspace + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Update Workspace + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +### Path parameters + +- `workspace_id: string` + +### Body parameters + +- `data_residency: optional BetaDataResidencyUpdateConfig or null` + + Data residency configuration for the workspace. + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + +- `display_color: optional string` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: optional string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `name: optional string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `tags: optional map[string] or null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "tags": { + "env": "prod", + "team": "platform" + } + }' +``` + +#### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Archive Workspace + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +### Path parameters + +- `workspace_id: string` + +### Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Domain types + +### Beta Allowed Inference Geo + +- `BetaAllowedInferenceGeo = "global" or "us"` + + - `"global"` + + - `"us"` + +### Beta Data Residency + +- `BetaDataResidency object` + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + +### Beta Data Residency Create Config + +- `BetaDataResidencyCreateConfig object` + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + + - `workspace_geo: optional "us" or null` + + Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. + +### Beta Data Residency Update Config + +- `BetaDataResidencyUpdateConfig object` + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + +### Beta No Billing Workspace Role + +- `BetaNoBillingWorkspaceRole = "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"` + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Beta Workspace + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +### Beta Workspace Member + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Beta Workspace Role + +- `BetaWorkspaceRole = "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Workspaces › Rate Limits + +### List Workspace Rate Limits + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Path parameters + +- `workspace_id: string` + + The ID of the workspace. + +#### Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `data: array of BetaWorkspaceRateLimit` + + Rate-limit entries for the workspace, one per group that has at least one override. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaWorkspaceRateLimitValue` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: number or null` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: string` + + The `id` of the RateLimit group this override applies to. + + - `type: "workspace_rate_limit"` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `workspace_id: string` + + ID of the Workspace this override applies to. + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Workspaces › Members + +### List Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +#### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +#### Returns + +- `data: array of BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +#### Body parameters + +- `user_id: string` + + ID of the User. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Body parameters + +- `workspace_role: BetaWorkspaceRole` + + New workspace role for the User. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +#### Returns + +- `type: "workspace_member_deleted"` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + +- `user_id: string` + + ID of the User. + +- `workspace_id: string` + + ID of the Workspace. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Workspaces › Service Accounts + +### List Service Account Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +#### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `service_account_id: string` + + Tagged service account ID to add. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "service_account_id": "service_account_id", + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Get Service Account Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Update Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Body parameters + +- `workspace_role: BetaNoBillingWorkspaceRole` + + New role for the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Delete Service Account Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. + +#### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +#### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` diff --git a/content/en/api/beta/organization/workspaces/archive.md b/content/en/api/beta/organization/workspaces/archive.md new file mode 100644 index 000000000..a50ffe85f --- /dev/null +++ b/content/en/api/beta/organization/workspaces/archive.md @@ -0,0 +1,121 @@ +# Archive Workspace + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +## Path parameters + +- `workspace_id: string` + +## Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \ + -X POST \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` diff --git a/content/en/api/beta/organization/workspaces/create.md b/content/en/api/beta/organization/workspaces/create.md new file mode 100644 index 000000000..a03c7e02b --- /dev/null +++ b/content/en/api/beta/organization/workspaces/create.md @@ -0,0 +1,274 @@ +# Create Workspace + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `name: string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `data_residency: optional BetaDataResidencyCreateConfig or null` + + Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + + - `workspace_geo: optional "us" or null` + + Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. + +- `display_color: optional string or null` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: optional string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `tags: optional map[string] or null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +## Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "name": "x", + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "tags": { + "env": "prod", + "team": "platform" + } + }' +``` + +### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` diff --git a/content/en/api/beta/organization/workspaces/list.md b/content/en/api/beta/organization/workspaces/list.md new file mode 100644 index 000000000..aefb62279 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/list.md @@ -0,0 +1,159 @@ +# List Workspaces + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +## Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `include_archived: optional boolean` + + Whether to include Workspaces that have been archived in the response + + default: false + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +## Returns + +- `data: array of BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` diff --git a/content/en/api/beta/organization/workspaces/members.md b/content/en/api/beta/organization/workspaces/members.md new file mode 100644 index 000000000..3adb7057a --- /dev/null +++ b/content/en/api/beta/organization/workspaces/members.md @@ -0,0 +1,424 @@ +# Members + +## List Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +### Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +### Returns + +- `data: array of BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +## Create Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +### Body parameters + +- `user_id: string` + + ID of the User. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_role": "workspace_admin" + }' +``` + +#### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +## Get Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +## Update Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +### Body parameters + +- `workspace_role: BetaWorkspaceRole` + + New workspace role for the User. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +#### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +## Delete Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +### Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +### Returns + +- `type: "workspace_member_deleted"` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + +- `user_id: string` + + ID of the User. + +- `workspace_id: string` + + ID of the Workspace. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Domain types + +### Member Remove Response + +- `MemberRemoveResponse object` + + - `type: "workspace_member_deleted"` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. diff --git a/content/en/api/beta/organization/workspaces/members/add.md b/content/en/api/beta/organization/workspaces/members/add.md new file mode 100644 index 000000000..7edd3f7c0 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/members/add.md @@ -0,0 +1,87 @@ +# Create Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +## Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +## Body parameters + +- `user_id: string` + + ID of the User. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_role": "workspace_admin" + }' +``` + +### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` diff --git a/content/en/api/beta/organization/workspaces/members/list.md b/content/en/api/beta/organization/workspaces/members/list.md new file mode 100644 index 000000000..88af560f9 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/members/list.md @@ -0,0 +1,101 @@ +# List Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +## Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +## Query parameters + +- `after_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +## Returns + +- `data: array of BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `first_id: string or null` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + +- `has_more: boolean` + + Indicates if there are more results in the requested page direction. + +- `last_id: string or null` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` diff --git a/content/en/api/beta/organization/workspaces/members/remove.md b/content/en/api/beta/organization/workspaces/members/remove.md new file mode 100644 index 000000000..94c3008a2 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/members/remove.md @@ -0,0 +1,52 @@ +# Delete Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +## Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +## Returns + +- `type: "workspace_member_deleted"` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + +- `user_id: string` + + ID of the User. + +- `workspace_id: string` + + ID of the Workspace. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` diff --git a/content/en/api/beta/organization/workspaces/members/retrieve.md b/content/en/api/beta/organization/workspaces/members/retrieve.md new file mode 100644 index 000000000..784543ec2 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/members/retrieve.md @@ -0,0 +1,68 @@ +# Get Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +## Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +## Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` diff --git a/content/en/api/beta/organization/workspaces/members/update.md b/content/en/api/beta/organization/workspaces/members/update.md new file mode 100644 index 000000000..8fa8039ca --- /dev/null +++ b/content/en/api/beta/organization/workspaces/members/update.md @@ -0,0 +1,88 @@ +# Update Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +## Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +- `user_id: string` + + ID of the User. + +## Body parameters + +- `workspace_role: BetaWorkspaceRole` + + New workspace role for the User. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Returns + +- `BetaWorkspaceMember object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` diff --git a/content/en/api/beta/organization/workspaces/rate_limits.md b/content/en/api/beta/organization/workspaces/rate_limits.md new file mode 100644 index 000000000..22572e558 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/rate_limits.md @@ -0,0 +1,217 @@ +# Rate Limits + +## List Workspace Rate Limits + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +### Path parameters + +- `workspace_id: string` + + The ID of the workspace. + +### Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Returns + +- `data: array of BetaWorkspaceRateLimit` + + Rate-limit entries for the workspace, one per group that has at least one override. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaWorkspaceRateLimitValue` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: number or null` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: string` + + The `id` of the RateLimit group this override applies to. + + - `type: "workspace_rate_limit"` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `workspace_id: string` + + ID of the Workspace this override applies to. + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Domain types + +### Beta Workspace Rate Limit + +- `BetaWorkspaceRateLimit object` + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaWorkspaceRateLimitValue` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: number or null` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: string` + + The `id` of the RateLimit group this override applies to. + + - `type: "workspace_rate_limit"` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `workspace_id: string` + + ID of the Workspace this override applies to. + +### Beta Workspace Rate Limit Value + +- `BetaWorkspaceRateLimitValue object` + + - `org_limit: number or null` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. diff --git a/content/en/api/beta/organization/workspaces/rate_limits/list.md b/content/en/api/beta/organization/workspaces/rate_limits/list.md new file mode 100644 index 000000000..0f336f91a --- /dev/null +++ b/content/en/api/beta/organization/workspaces/rate_limits/list.md @@ -0,0 +1,143 @@ +# List Workspace Rate Limits + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +## Path parameters + +- `workspace_id: string` + + The ID of the workspace. + +## Query parameters + +- `group_type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Returns + +- `data: array of BetaWorkspaceRateLimit` + + Rate-limit entries for the workspace, one per group that has at least one override. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaWorkspaceRateLimitValue` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: number or null` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. + + - `models: array of string or null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: string` + + The `id` of the RateLimit group this override applies to. + + - `type: "workspace_rate_limit"` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `workspace_id: string` + + ID of the Workspace this override applies to. + +- `next_page: string or null` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/workspaces/retrieve.md b/content/en/api/beta/organization/workspaces/retrieve.md new file mode 100644 index 000000000..81b1a04c5 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/retrieve.md @@ -0,0 +1,122 @@ +# Get Workspace + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +## Path parameters + +- `workspace_id: string` + + ID of the Workspace. + +## Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` diff --git a/content/en/api/beta/organization/workspaces/service_accounts.md b/content/en/api/beta/organization/workspaces/service_accounts.md new file mode 100644 index 000000000..79f9c87bd --- /dev/null +++ b/content/en/api/beta/organization/workspaces/service_accounts.md @@ -0,0 +1,928 @@ +# Service Accounts + +## List Service Account Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +### Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +## Create Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `service_account_id: string` + + Tagged service account ID to add. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "service_account_id": "service_account_id", + "workspace_role": "workspace_admin" + }' +``` + +#### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +## Get Service Account Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. + +### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +## Update Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. + +### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Body parameters + +- `workspace_role: BetaNoBillingWorkspaceRole` + + New role for the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +#### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +## Delete Service Account Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. + +### Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +### Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +### Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +### Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +#### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Domain types + +### Service Account Remove Response + +- `ServiceAccountRemoveResponse object` + + - `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. diff --git a/content/en/api/beta/organization/workspaces/service_accounts/add.md b/content/en/api/beta/organization/workspaces/service_accounts/add.md new file mode 100644 index 000000000..e8814caea --- /dev/null +++ b/content/en/api/beta/organization/workspaces/service_accounts/add.md @@ -0,0 +1,196 @@ +# Create Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +## Path parameters + +- `workspace_id: string` + + ID of the workspace. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `service_account_id: string` + + Tagged service account ID to add. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "service_account_id": "service_account_id", + "workspace_role": "workspace_admin" + }' +``` + +### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` diff --git a/content/en/api/beta/organization/workspaces/service_accounts/list.md b/content/en/api/beta/organization/workspaces/service_accounts/list.md new file mode 100644 index 000000000..fbe0c8f69 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/service_accounts/list.md @@ -0,0 +1,192 @@ +# List Service Account Workspace Members + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +## Path parameters + +- `workspace_id: string` + + ID of the workspace. + +## Query parameters + +- `limit: optional number` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: optional string` + + Opaque cursor from a previous response's `next_page`. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `next_page: string or null` + + Opaque cursor for the next page, or null if no more results. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/beta/organization/workspaces/service_accounts/remove.md b/content/en/api/beta/organization/workspaces/service_accounts/remove.md new file mode 100644 index 000000000..7f33f9684 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/service_accounts/remove.md @@ -0,0 +1,148 @@ +# Delete Service Account Workspace Member + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. + +## Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + +- `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + +- `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -X DELETE \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` diff --git a/content/en/api/beta/organization/workspaces/service_accounts/retrieve.md b/content/en/api/beta/organization/workspaces/service_accounts/retrieve.md new file mode 100644 index 000000000..4d63fbab6 --- /dev/null +++ b/content/en/api/beta/organization/workspaces/service_accounts/retrieve.md @@ -0,0 +1,175 @@ +# Get Service Account Workspace Member + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. + +## Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" +``` + +### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` diff --git a/content/en/api/beta/organization/workspaces/service_accounts/update.md b/content/en/api/beta/organization/workspaces/service_accounts/update.md new file mode 100644 index 000000000..7dd6cb55f --- /dev/null +++ b/content/en/api/beta/organization/workspaces/service_accounts/update.md @@ -0,0 +1,193 @@ +# Update Service Account Workspace Member + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. + +## Path parameters + +- `workspace_id: string` + + ID of the workspace. + +- `service_account_id: string` + + ID of the service account. + +## Headers + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +## Body parameters + +- `workspace_role: BetaNoBillingWorkspaceRole` + + New role for the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Returns + +- `BetaServiceAccountWorkspaceMember object` + + - `created_by_actor_id: string or null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean or null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "workspace_role": "workspace_admin" + }' +``` + +### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` diff --git a/content/en/api/beta/organization/workspaces/update.md b/content/en/api/beta/organization/workspaces/update.md new file mode 100644 index 000000000..c1502841e --- /dev/null +++ b/content/en/api/beta/organization/workspaces/update.md @@ -0,0 +1,181 @@ +# Update Workspace + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +## Path parameters + +- `workspace_id: string` + +## Body parameters + +- `data_residency: optional BetaDataResidencyUpdateConfig or null` + + Data residency configuration for the workspace. + + - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` + + Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = array of BetaAllowedInferenceGeo` + + - `"global"` + + - `"us"` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: optional "global" or "us" or null` + + Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + +- `display_color: optional string` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: optional string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `name: optional string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `tags: optional map[string] or null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +## Returns + +- `BetaWorkspace object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string or null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = array of string` + + - `Unrestricted = "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string or null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +## Example + +```bash +curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + -d '{ + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "tags": { + "env": "prod", + "team": "platform" + } + }' +``` + +### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` diff --git a/content/en/api/beta/sessions.md b/content/en/api/beta/sessions.md index 51c1f8204..fd2471f4b 100644 --- a/content/en/api/beta/sessions.md +++ b/content/en/api/beta/sessions.md @@ -14,7 +14,7 @@ Create Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams` @@ -2185,7 +2199,7 @@ List Sessions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2255,6 +2269,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsSession` @@ -3324,7 +3352,7 @@ Get Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -3394,6 +3422,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession object` @@ -4449,7 +4491,7 @@ Update Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -4519,6 +4561,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `agent: optional BetaManagedAgentsSessionAgentUpdate` @@ -6018,7 +6074,7 @@ Delete Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -6088,6 +6144,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedSession object` @@ -6135,7 +6205,7 @@ Archive Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -6205,6 +6275,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession object` @@ -11763,7 +11847,7 @@ List Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -11833,6 +11917,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsSessionEvent` @@ -14024,7 +14122,7 @@ Send Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -14094,6 +14192,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `events: array of BetaManagedAgentsEventParams` @@ -14975,7 +15087,7 @@ Stream Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -15045,6 +15157,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` @@ -17274,7 +17400,7 @@ Add Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -17344,6 +17470,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `file_id: string` @@ -17442,7 +17582,7 @@ List Session Resources - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -17512,6 +17652,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaManagedAgentsSessionResource` @@ -17683,7 +17837,7 @@ Get Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -17753,6 +17907,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsGitHubRepositoryResource object` @@ -17903,7 +18071,7 @@ Update Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -17973,6 +18141,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `authorization_token: string` @@ -18135,7 +18317,7 @@ Delete Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -18205,6 +18387,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeleteSessionResource object` @@ -18266,7 +18462,7 @@ List Session Threads - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -18336,6 +18532,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsSessionThread` @@ -18348,7 +18558,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -19095,7 +19305,7 @@ Get Session Thread - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -19165,6 +19375,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread object` @@ -19177,7 +19401,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -19915,7 +20139,7 @@ Archive Session Thread - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -19985,6 +20209,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread object` @@ -19997,7 +20235,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -20750,7 +20988,7 @@ List Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -20820,6 +21058,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsSessionEvent` @@ -23012,7 +23264,7 @@ Stream Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -23082,6 +23334,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` diff --git a/content/en/api/beta/sessions/archive.md b/content/en/api/beta/sessions/archive.md index 5244031a5..e146f3d69 100644 --- a/content/en/api/beta/sessions/archive.md +++ b/content/en/api/beta/sessions/archive.md @@ -16,7 +16,7 @@ Archive Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSession object` diff --git a/content/en/api/beta/sessions/create.md b/content/en/api/beta/sessions/create.md index 44687e21d..40a8ed28a 100644 --- a/content/en/api/beta/sessions/create.md +++ b/content/en/api/beta/sessions/create.md @@ -12,7 +12,7 @@ Create Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams` diff --git a/content/en/api/beta/sessions/delete.md b/content/en/api/beta/sessions/delete.md index 8c864911c..c73de9650 100644 --- a/content/en/api/beta/sessions/delete.md +++ b/content/en/api/beta/sessions/delete.md @@ -16,7 +16,7 @@ Delete Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedSession object` diff --git a/content/en/api/beta/sessions/events.md b/content/en/api/beta/sessions/events.md index 9a83bbf30..b7ab83693 100644 --- a/content/en/api/beta/sessions/events.md +++ b/content/en/api/beta/sessions/events.md @@ -66,7 +66,7 @@ List Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -136,6 +136,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsSessionEvent` @@ -2327,7 +2341,7 @@ Send Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2397,6 +2411,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `events: array of BetaManagedAgentsEventParams` @@ -3278,7 +3306,7 @@ Stream Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -3348,6 +3376,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` diff --git a/content/en/api/beta/sessions/events/list.md b/content/en/api/beta/sessions/events/list.md index 46e5e8cb3..a2e178e34 100644 --- a/content/en/api/beta/sessions/events/list.md +++ b/content/en/api/beta/sessions/events/list.md @@ -64,7 +64,7 @@ List Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -134,6 +134,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsSessionEvent` diff --git a/content/en/api/beta/sessions/events/send.md b/content/en/api/beta/sessions/events/send.md index fa9ec56dc..a81c838f9 100644 --- a/content/en/api/beta/sessions/events/send.md +++ b/content/en/api/beta/sessions/events/send.md @@ -16,7 +16,7 @@ Send Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `events: array of BetaManagedAgentsEventParams` diff --git a/content/en/api/beta/sessions/events/stream.md b/content/en/api/beta/sessions/events/stream.md index 768c85ad6..bbf0374a5 100644 --- a/content/en/api/beta/sessions/events/stream.md +++ b/content/en/api/beta/sessions/events/stream.md @@ -26,7 +26,7 @@ Stream Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` diff --git a/content/en/api/beta/sessions/list.md b/content/en/api/beta/sessions/list.md index d9cc51d9e..42e928f9d 100644 --- a/content/en/api/beta/sessions/list.md +++ b/content/en/api/beta/sessions/list.md @@ -90,7 +90,7 @@ List Sessions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -160,6 +160,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsSession` diff --git a/content/en/api/beta/sessions/resources.md b/content/en/api/beta/sessions/resources.md index 2555da55e..ca7cda9e4 100644 --- a/content/en/api/beta/sessions/resources.md +++ b/content/en/api/beta/sessions/resources.md @@ -18,7 +18,7 @@ Add Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `file_id: string` @@ -186,7 +200,7 @@ List Session Resources - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -256,6 +270,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaManagedAgentsSessionResource` @@ -427,7 +455,7 @@ Get Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -497,6 +525,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsGitHubRepositoryResource object` @@ -647,7 +689,7 @@ Update Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -717,6 +759,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `authorization_token: string` @@ -879,7 +935,7 @@ Delete Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -949,6 +1005,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeleteSessionResource object` diff --git a/content/en/api/beta/sessions/resources/add.md b/content/en/api/beta/sessions/resources/add.md index ecec1bf87..3f4d0fcb8 100644 --- a/content/en/api/beta/sessions/resources/add.md +++ b/content/en/api/beta/sessions/resources/add.md @@ -16,7 +16,7 @@ Add Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `file_id: string` diff --git a/content/en/api/beta/sessions/resources/delete.md b/content/en/api/beta/sessions/resources/delete.md index 21fd1cc39..f29e2729b 100644 --- a/content/en/api/beta/sessions/resources/delete.md +++ b/content/en/api/beta/sessions/resources/delete.md @@ -18,7 +18,7 @@ Delete Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeleteSessionResource object` diff --git a/content/en/api/beta/sessions/resources/list.md b/content/en/api/beta/sessions/resources/list.md index 7bb9155ba..5f3f40314 100644 --- a/content/en/api/beta/sessions/resources/list.md +++ b/content/en/api/beta/sessions/resources/list.md @@ -28,7 +28,7 @@ List Session Resources - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaManagedAgentsSessionResource` diff --git a/content/en/api/beta/sessions/resources/retrieve.md b/content/en/api/beta/sessions/resources/retrieve.md index c99528938..4fdd65faf 100644 --- a/content/en/api/beta/sessions/resources/retrieve.md +++ b/content/en/api/beta/sessions/resources/retrieve.md @@ -18,7 +18,7 @@ Get Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsGitHubRepositoryResource object` diff --git a/content/en/api/beta/sessions/resources/update.md b/content/en/api/beta/sessions/resources/update.md index 84b8029c0..8fc59eb26 100644 --- a/content/en/api/beta/sessions/resources/update.md +++ b/content/en/api/beta/sessions/resources/update.md @@ -18,7 +18,7 @@ Update Session Resource - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `authorization_token: string` diff --git a/content/en/api/beta/sessions/retrieve.md b/content/en/api/beta/sessions/retrieve.md index c895aba2d..b982cc31b 100644 --- a/content/en/api/beta/sessions/retrieve.md +++ b/content/en/api/beta/sessions/retrieve.md @@ -16,7 +16,7 @@ Get Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSession object` diff --git a/content/en/api/beta/sessions/threads.md b/content/en/api/beta/sessions/threads.md index d502b629d..d9d854d85 100644 --- a/content/en/api/beta/sessions/threads.md +++ b/content/en/api/beta/sessions/threads.md @@ -30,7 +30,7 @@ List Session Threads - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsSessionThread` @@ -112,7 +126,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -859,7 +873,7 @@ Get Session Thread - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -929,6 +943,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionThread object` @@ -941,7 +969,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -1679,7 +1707,7 @@ Archive Session Thread - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1749,6 +1777,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionThread object` @@ -1761,7 +1803,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -2494,7 +2536,7 @@ curl https://api.anthropic.com/v1/sessions/$SESSION_ID/threads/$THREAD_ID/archiv - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` @@ -5440,7 +5482,7 @@ List Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -5510,6 +5552,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsSessionEvent` @@ -7702,7 +7758,7 @@ Stream Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -7772,6 +7828,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` diff --git a/content/en/api/beta/sessions/threads/archive.md b/content/en/api/beta/sessions/threads/archive.md index 99cb4cc40..9dffa199e 100644 --- a/content/en/api/beta/sessions/threads/archive.md +++ b/content/en/api/beta/sessions/threads/archive.md @@ -18,7 +18,7 @@ Archive Session Thread - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionThread object` @@ -100,7 +114,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` diff --git a/content/en/api/beta/sessions/threads/events.md b/content/en/api/beta/sessions/threads/events.md index 1feb34461..25e0900a8 100644 --- a/content/en/api/beta/sessions/threads/events.md +++ b/content/en/api/beta/sessions/threads/events.md @@ -32,7 +32,7 @@ List Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsSessionEvent` @@ -2294,7 +2308,7 @@ Stream Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2364,6 +2378,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` diff --git a/content/en/api/beta/sessions/threads/events/list.md b/content/en/api/beta/sessions/threads/events/list.md index b61557b8f..cfa554b9e 100644 --- a/content/en/api/beta/sessions/threads/events/list.md +++ b/content/en/api/beta/sessions/threads/events/list.md @@ -30,7 +30,7 @@ List Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsSessionEvent` diff --git a/content/en/api/beta/sessions/threads/events/stream.md b/content/en/api/beta/sessions/threads/events/stream.md index 2fa1fb87c..f9e7d212c 100644 --- a/content/en/api/beta/sessions/threads/events/stream.md +++ b/content/en/api/beta/sessions/threads/events/stream.md @@ -28,7 +28,7 @@ Stream Session Thread Events - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more` diff --git a/content/en/api/beta/sessions/threads/list.md b/content/en/api/beta/sessions/threads/list.md index 65140f706..709371bc7 100644 --- a/content/en/api/beta/sessions/threads/list.md +++ b/content/en/api/beta/sessions/threads/list.md @@ -28,7 +28,7 @@ List Session Threads - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsSessionThread` @@ -110,7 +124,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` diff --git a/content/en/api/beta/sessions/threads/retrieve.md b/content/en/api/beta/sessions/threads/retrieve.md index adb26b04f..4342ea507 100644 --- a/content/en/api/beta/sessions/threads/retrieve.md +++ b/content/en/api/beta/sessions/threads/retrieve.md @@ -18,7 +18,7 @@ Get Session Thread - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionThread object` @@ -100,7 +114,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent object` diff --git a/content/en/api/beta/sessions/update.md b/content/en/api/beta/sessions/update.md index ad733bef8..6547dd505 100644 --- a/content/en/api/beta/sessions/update.md +++ b/content/en/api/beta/sessions/update.md @@ -16,7 +16,7 @@ Update Session - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `agent: optional BetaManagedAgentsSessionAgentUpdate` diff --git a/content/en/api/beta/skills.md b/content/en/api/beta/skills.md index 4789cb73b..20c9f37c6 100644 --- a/content/en/api/beta/skills.md +++ b/content/en/api/beta/skills.md @@ -14,7 +14,7 @@ Create Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters (form-data) - `files: array of string` @@ -207,7 +221,7 @@ List Skills - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -277,6 +291,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of object` @@ -389,7 +417,7 @@ Get Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -459,6 +487,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `id: string` @@ -549,7 +591,7 @@ Delete Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -619,6 +661,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `id: string` @@ -839,7 +895,7 @@ Create Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -909,6 +965,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters (form-data) - `files: array of string` @@ -1025,7 +1095,7 @@ List Skill Versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1095,6 +1165,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of object` @@ -1213,7 +1297,7 @@ Download a skill version's content as a zip archive. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1283,6 +1367,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Example ```bash @@ -1320,7 +1418,7 @@ Get Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1390,6 +1488,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `id: string` @@ -1490,7 +1602,7 @@ Delete Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1560,6 +1672,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `id: string` diff --git a/content/en/api/beta/skills/create.md b/content/en/api/beta/skills/create.md index 949b03baf..816ecbb01 100644 --- a/content/en/api/beta/skills/create.md +++ b/content/en/api/beta/skills/create.md @@ -12,7 +12,7 @@ Create Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters (form-data) - `files: array of string` diff --git a/content/en/api/beta/skills/delete.md b/content/en/api/beta/skills/delete.md index 2b0a90529..594b0de23 100644 --- a/content/en/api/beta/skills/delete.md +++ b/content/en/api/beta/skills/delete.md @@ -20,7 +20,7 @@ Delete Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `id: string` diff --git a/content/en/api/beta/skills/list.md b/content/en/api/beta/skills/list.md index 01546aaa5..b5e6a1b9c 100644 --- a/content/en/api/beta/skills/list.md +++ b/content/en/api/beta/skills/list.md @@ -37,7 +37,7 @@ List Skills - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -107,6 +107,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of object` diff --git a/content/en/api/beta/skills/retrieve.md b/content/en/api/beta/skills/retrieve.md index 6a2e1cb3e..ca692ebc1 100644 --- a/content/en/api/beta/skills/retrieve.md +++ b/content/en/api/beta/skills/retrieve.md @@ -20,7 +20,7 @@ Get Skill - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `id: string` diff --git a/content/en/api/beta/skills/versions.md b/content/en/api/beta/skills/versions.md index 4e63cd465..917118d33 100644 --- a/content/en/api/beta/skills/versions.md +++ b/content/en/api/beta/skills/versions.md @@ -22,7 +22,7 @@ Create Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters (form-data) - `files: array of string` @@ -208,7 +222,7 @@ List Skill Versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -278,6 +292,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of object` @@ -396,7 +424,7 @@ Download a skill version's content as a zip archive. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -466,6 +494,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Example ```bash @@ -503,7 +545,7 @@ Get Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -573,6 +615,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `id: string` @@ -673,7 +729,7 @@ Delete Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -743,6 +799,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `id: string` diff --git a/content/en/api/beta/skills/versions/create.md b/content/en/api/beta/skills/versions/create.md index 9a4a4a4a5..f4becb0c1 100644 --- a/content/en/api/beta/skills/versions/create.md +++ b/content/en/api/beta/skills/versions/create.md @@ -20,7 +20,7 @@ Create Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters (form-data) - `files: array of string` diff --git a/content/en/api/beta/skills/versions/delete.md b/content/en/api/beta/skills/versions/delete.md index c79d2f954..fe54df93d 100644 --- a/content/en/api/beta/skills/versions/delete.md +++ b/content/en/api/beta/skills/versions/delete.md @@ -26,7 +26,7 @@ Delete Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `id: string` diff --git a/content/en/api/beta/skills/versions/download.md b/content/en/api/beta/skills/versions/download.md index 073f0a4e2..2df7e58d0 100644 --- a/content/en/api/beta/skills/versions/download.md +++ b/content/en/api/beta/skills/versions/download.md @@ -26,7 +26,7 @@ Download a skill version's content as a zip archive. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Example ```bash diff --git a/content/en/api/beta/skills/versions/list.md b/content/en/api/beta/skills/versions/list.md index 159c4588e..a748471e2 100644 --- a/content/en/api/beta/skills/versions/list.md +++ b/content/en/api/beta/skills/versions/list.md @@ -32,7 +32,7 @@ List Skill Versions - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of object` diff --git a/content/en/api/beta/skills/versions/retrieve.md b/content/en/api/beta/skills/versions/retrieve.md index c463d1027..92d915e06 100644 --- a/content/en/api/beta/skills/versions/retrieve.md +++ b/content/en/api/beta/skills/versions/retrieve.md @@ -26,7 +26,7 @@ Get Skill Version - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `id: string` diff --git a/content/en/api/beta/tunnels.md b/content/en/api/beta/tunnels.md index aaaf822b0..f5c69cbbf 100644 --- a/content/en/api/beta/tunnels.md +++ b/content/en/api/beta/tunnels.md @@ -16,7 +16,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `display_name: optional string or null` @@ -170,7 +184,7 @@ Fetches a tunnel by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -240,6 +254,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnel object` @@ -326,7 +354,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -396,6 +424,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaTunnel` @@ -479,7 +521,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -549,6 +591,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnel object` @@ -624,7 +680,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -694,6 +750,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelToken object` @@ -750,7 +820,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -820,6 +890,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `reason: optional string or null` @@ -937,7 +1021,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1007,6 +1091,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `ca_certificate_pem: string` @@ -1102,7 +1200,7 @@ Fetches a tunnel certificate by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1172,6 +1270,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelCertificate object` @@ -1269,7 +1381,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1339,6 +1451,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: array of BetaTunnelCertificate` @@ -1431,7 +1557,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1501,6 +1627,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelCertificate object` diff --git a/content/en/api/beta/tunnels/archive.md b/content/en/api/beta/tunnels/archive.md index 20345587c..2e8f61471 100644 --- a/content/en/api/beta/tunnels/archive.md +++ b/content/en/api/beta/tunnels/archive.md @@ -18,7 +18,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnel object` diff --git a/content/en/api/beta/tunnels/certificates.md b/content/en/api/beta/tunnels/certificates.md index 6cdd71a5a..59e7c13c2 100644 --- a/content/en/api/beta/tunnels/certificates.md +++ b/content/en/api/beta/tunnels/certificates.md @@ -20,7 +20,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `ca_certificate_pem: string` @@ -185,7 +199,7 @@ Fetches a tunnel certificate by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -255,6 +269,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelCertificate object` @@ -352,7 +380,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -422,6 +450,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaTunnelCertificate` @@ -514,7 +556,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -584,6 +626,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelCertificate object` diff --git a/content/en/api/beta/tunnels/certificates/archive.md b/content/en/api/beta/tunnels/certificates/archive.md index 8490f01b8..03d32566b 100644 --- a/content/en/api/beta/tunnels/certificates/archive.md +++ b/content/en/api/beta/tunnels/certificates/archive.md @@ -20,7 +20,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelCertificate object` diff --git a/content/en/api/beta/tunnels/certificates/create.md b/content/en/api/beta/tunnels/certificates/create.md index f482d4cb3..17421c5f8 100644 --- a/content/en/api/beta/tunnels/certificates/create.md +++ b/content/en/api/beta/tunnels/certificates/create.md @@ -18,7 +18,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `ca_certificate_pem: string` diff --git a/content/en/api/beta/tunnels/certificates/list.md b/content/en/api/beta/tunnels/certificates/list.md index d6244482a..29ef5e51e 100644 --- a/content/en/api/beta/tunnels/certificates/list.md +++ b/content/en/api/beta/tunnels/certificates/list.md @@ -34,7 +34,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaTunnelCertificate` diff --git a/content/en/api/beta/tunnels/certificates/retrieve.md b/content/en/api/beta/tunnels/certificates/retrieve.md index a68fb1e7b..17a9f7dba 100644 --- a/content/en/api/beta/tunnels/certificates/retrieve.md +++ b/content/en/api/beta/tunnels/certificates/retrieve.md @@ -20,7 +20,7 @@ Fetches a tunnel certificate by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelCertificate object` diff --git a/content/en/api/beta/tunnels/create.md b/content/en/api/beta/tunnels/create.md index cfde86d17..6472f4363 100644 --- a/content/en/api/beta/tunnels/create.md +++ b/content/en/api/beta/tunnels/create.md @@ -14,7 +14,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `display_name: optional string or null` diff --git a/content/en/api/beta/tunnels/list.md b/content/en/api/beta/tunnels/list.md index 831a96124..7591026e9 100644 --- a/content/en/api/beta/tunnels/list.md +++ b/content/en/api/beta/tunnels/list.md @@ -30,7 +30,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaTunnel` diff --git a/content/en/api/beta/tunnels/retrieve.md b/content/en/api/beta/tunnels/retrieve.md index c82ae0fae..3715c0a0c 100644 --- a/content/en/api/beta/tunnels/retrieve.md +++ b/content/en/api/beta/tunnels/retrieve.md @@ -18,7 +18,7 @@ Fetches a tunnel by ID. - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnel object` diff --git a/content/en/api/beta/tunnels/reveal_token.md b/content/en/api/beta/tunnels/reveal_token.md index 74bffd21e..3849a508b 100644 --- a/content/en/api/beta/tunnels/reveal_token.md +++ b/content/en/api/beta/tunnels/reveal_token.md @@ -18,7 +18,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelToken object` diff --git a/content/en/api/beta/tunnels/rotate_token.md b/content/en/api/beta/tunnels/rotate_token.md index 79b19a1cb..df5dc36dc 100644 --- a/content/en/api/beta/tunnels/rotate_token.md +++ b/content/en/api/beta/tunnels/rotate_token.md @@ -18,7 +18,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `reason: optional string or null` diff --git a/content/en/api/beta/user_profiles.md b/content/en/api/beta/user_profiles.md index edcce859e..ab351272d 100644 --- a/content/en/api/beta/user_profiles.md +++ b/content/en/api/beta/user_profiles.md @@ -14,7 +14,7 @@ Create User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `access_type: optional "application" or "passthrough"` @@ -257,7 +271,7 @@ List User Profiles - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -327,6 +341,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of BetaUserProfile` @@ -454,7 +482,7 @@ Get User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -524,6 +552,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaUserProfile object` @@ -640,7 +682,7 @@ Update User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -710,6 +752,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `access_type: optional "application" or "passthrough" or null` @@ -866,7 +922,7 @@ Create Enrollment URL - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -936,6 +992,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaUserProfileEnrollmentURL object` diff --git a/content/en/api/beta/user_profiles/create.md b/content/en/api/beta/user_profiles/create.md index 91f08a4f6..b4ffbb32e 100644 --- a/content/en/api/beta/user_profiles/create.md +++ b/content/en/api/beta/user_profiles/create.md @@ -12,7 +12,7 @@ Create User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `access_type: optional "application" or "passthrough"` diff --git a/content/en/api/beta/user_profiles/create_enrollment_url.md b/content/en/api/beta/user_profiles/create_enrollment_url.md index 07b821e1a..8059be709 100644 --- a/content/en/api/beta/user_profiles/create_enrollment_url.md +++ b/content/en/api/beta/user_profiles/create_enrollment_url.md @@ -16,7 +16,7 @@ Create Enrollment URL - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaUserProfileEnrollmentURL object` diff --git a/content/en/api/beta/user_profiles/list.md b/content/en/api/beta/user_profiles/list.md index e56359e86..85454c2d3 100644 --- a/content/en/api/beta/user_profiles/list.md +++ b/content/en/api/beta/user_profiles/list.md @@ -32,7 +32,7 @@ List User Profiles - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of BetaUserProfile` diff --git a/content/en/api/beta/user_profiles/retrieve.md b/content/en/api/beta/user_profiles/retrieve.md index 6b9bfc474..78334d8a5 100644 --- a/content/en/api/beta/user_profiles/retrieve.md +++ b/content/en/api/beta/user_profiles/retrieve.md @@ -16,7 +16,7 @@ Get User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaUserProfile object` diff --git a/content/en/api/beta/user_profiles/update.md b/content/en/api/beta/user_profiles/update.md index eaf2011e7..3010fbd59 100644 --- a/content/en/api/beta/user_profiles/update.md +++ b/content/en/api/beta/user_profiles/update.md @@ -16,7 +16,7 @@ Update User Profile - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `access_type: optional "application" or "passthrough" or null` diff --git a/content/en/api/beta/vaults.md b/content/en/api/beta/vaults.md index b1fe2b501..bcbd75e2d 100644 --- a/content/en/api/beta/vaults.md +++ b/content/en/api/beta/vaults.md @@ -14,7 +14,7 @@ Create Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -84,6 +84,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `display_name: string` @@ -196,7 +210,7 @@ List Vaults - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -266,6 +280,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsVault` @@ -356,7 +384,7 @@ Get Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -426,6 +454,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsVault object` @@ -507,7 +549,7 @@ Update Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -577,6 +619,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `display_name: optional string or null` @@ -677,7 +733,7 @@ Delete Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -747,6 +803,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedVault object` @@ -796,7 +866,7 @@ Archive Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -866,6 +936,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsVault object` @@ -1002,7 +1086,7 @@ Create Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1072,6 +1156,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams` @@ -1480,7 +1578,7 @@ List Credentials - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1550,6 +1648,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `data: optional array of BetaManagedAgentsCredential` @@ -1765,7 +1877,7 @@ Get Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1835,6 +1947,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential object` @@ -2041,7 +2167,7 @@ Update Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2111,6 +2237,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Body parameters - `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams` @@ -2458,7 +2598,7 @@ Delete Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2528,6 +2668,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedCredential object` @@ -2579,7 +2733,7 @@ Archive Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2649,6 +2803,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential object` @@ -2856,7 +3024,7 @@ Validate Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -2926,6 +3094,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredentialValidation object` diff --git a/content/en/api/beta/vaults/archive.md b/content/en/api/beta/vaults/archive.md index 023b972b4..52d6bc1ce 100644 --- a/content/en/api/beta/vaults/archive.md +++ b/content/en/api/beta/vaults/archive.md @@ -16,7 +16,7 @@ Archive Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsVault object` diff --git a/content/en/api/beta/vaults/create.md b/content/en/api/beta/vaults/create.md index fa74e64e4..8311c5769 100644 --- a/content/en/api/beta/vaults/create.md +++ b/content/en/api/beta/vaults/create.md @@ -12,7 +12,7 @@ Create Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -82,6 +82,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `display_name: string` diff --git a/content/en/api/beta/vaults/credentials.md b/content/en/api/beta/vaults/credentials.md index 922576a18..a45135ca1 100644 --- a/content/en/api/beta/vaults/credentials.md +++ b/content/en/api/beta/vaults/credentials.md @@ -18,7 +18,7 @@ Create Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams` @@ -496,7 +510,7 @@ List Credentials - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -566,6 +580,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsCredential` @@ -781,7 +809,7 @@ Get Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -851,6 +879,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredential object` @@ -1057,7 +1099,7 @@ Update Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1127,6 +1169,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams` @@ -1474,7 +1530,7 @@ Delete Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1544,6 +1600,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedCredential object` @@ -1595,7 +1665,7 @@ Archive Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1665,6 +1735,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredential object` @@ -1872,7 +1956,7 @@ Validate Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -1942,6 +2026,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredentialValidation object` diff --git a/content/en/api/beta/vaults/credentials/archive.md b/content/en/api/beta/vaults/credentials/archive.md index 4d9638cbe..7baf3e5c7 100644 --- a/content/en/api/beta/vaults/credentials/archive.md +++ b/content/en/api/beta/vaults/credentials/archive.md @@ -18,7 +18,7 @@ Archive Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredential object` diff --git a/content/en/api/beta/vaults/credentials/create.md b/content/en/api/beta/vaults/credentials/create.md index d529e6c18..b7927a4ed 100644 --- a/content/en/api/beta/vaults/credentials/create.md +++ b/content/en/api/beta/vaults/credentials/create.md @@ -16,7 +16,7 @@ Create Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams` diff --git a/content/en/api/beta/vaults/credentials/delete.md b/content/en/api/beta/vaults/credentials/delete.md index c7055e7e3..557ee5e1e 100644 --- a/content/en/api/beta/vaults/credentials/delete.md +++ b/content/en/api/beta/vaults/credentials/delete.md @@ -18,7 +18,7 @@ Delete Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedCredential object` diff --git a/content/en/api/beta/vaults/credentials/list.md b/content/en/api/beta/vaults/credentials/list.md index f3cf727a4..d77a33283 100644 --- a/content/en/api/beta/vaults/credentials/list.md +++ b/content/en/api/beta/vaults/credentials/list.md @@ -32,7 +32,7 @@ List Credentials - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsCredential` diff --git a/content/en/api/beta/vaults/credentials/mcp_oauth_validate.md b/content/en/api/beta/vaults/credentials/mcp_oauth_validate.md index 6464cf203..2a27eee3c 100644 --- a/content/en/api/beta/vaults/credentials/mcp_oauth_validate.md +++ b/content/en/api/beta/vaults/credentials/mcp_oauth_validate.md @@ -18,7 +18,7 @@ Validate Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredentialValidation object` diff --git a/content/en/api/beta/vaults/credentials/retrieve.md b/content/en/api/beta/vaults/credentials/retrieve.md index a63c743af..59ddd3cba 100644 --- a/content/en/api/beta/vaults/credentials/retrieve.md +++ b/content/en/api/beta/vaults/credentials/retrieve.md @@ -18,7 +18,7 @@ Get Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredential object` diff --git a/content/en/api/beta/vaults/credentials/update.md b/content/en/api/beta/vaults/credentials/update.md index 8610edbe7..3ec7f671e 100644 --- a/content/en/api/beta/vaults/credentials/update.md +++ b/content/en/api/beta/vaults/credentials/update.md @@ -18,7 +18,7 @@ Update Credential - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams` diff --git a/content/en/api/beta/vaults/delete.md b/content/en/api/beta/vaults/delete.md index edbcd29c0..aaddf2ff3 100644 --- a/content/en/api/beta/vaults/delete.md +++ b/content/en/api/beta/vaults/delete.md @@ -16,7 +16,7 @@ Delete Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedVault object` diff --git a/content/en/api/beta/vaults/list.md b/content/en/api/beta/vaults/list.md index eb227e9b8..7d1863e91 100644 --- a/content/en/api/beta/vaults/list.md +++ b/content/en/api/beta/vaults/list.md @@ -28,7 +28,7 @@ List Vaults - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: optional array of BetaManagedAgentsVault` diff --git a/content/en/api/beta/vaults/retrieve.md b/content/en/api/beta/vaults/retrieve.md index dc74da05e..4fea78a1b 100644 --- a/content/en/api/beta/vaults/retrieve.md +++ b/content/en/api/beta/vaults/retrieve.md @@ -16,7 +16,7 @@ Get Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsVault object` diff --git a/content/en/api/beta/vaults/update.md b/content/en/api/beta/vaults/update.md index 17d902834..2fbf89a85 100644 --- a/content/en/api/beta/vaults/update.md +++ b/content/en/api/beta/vaults/update.md @@ -16,7 +16,7 @@ Update Vault - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `display_name: optional string or null` diff --git a/content/en/api/cli/beta.md b/content/en/api/cli/beta.md index 2af4c4432..0e030066e 100644 --- a/content/en/api/cli/beta.md +++ b/content/en/api/cli/beta.md @@ -2502,12 +2502,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -3243,12 +3245,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -6176,12 +6180,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -24227,7 +24233,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` @@ -24979,7 +24985,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` @@ -25723,7 +25729,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` @@ -38802,7 +38808,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -38929,7 +38935,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -39049,7 +39055,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -39165,7 +39171,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -39239,7 +39245,7 @@ Delete a memory - `beta_managed_agents_deleted_memory: object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -39353,7 +39359,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -39540,7 +39546,7 @@ Retrieve a memory version - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -39554,7 +39560,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -39729,7 +39735,7 @@ Redact a memory version - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -39743,7 +39749,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -43593,3 +43599,7270 @@ ant beta:tunnels:certificates archive \ "type": "tunnel_certificate" } ``` + +## Beta › Organization + +### Get Current Organization + +`$ ant beta:organization retrieve` + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Returns + +- `beta_organization: object` + + - `id: string` + + ID of the Organization. + + format: uuid + + - `name: string` + + Name of the Organization. + + - `type: "organization"` + + Object type. + + For Organizations, this is always `"organization"`. + +#### Example + +```bash +ant beta:organization retrieve \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +`$ ant beta:organization:api-keys list` + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Parameters + +- `--after-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `--before-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `--created-by-user-id: optional string` + + Filter by the ID of the User who created the object. + +- `--limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +- `--status: optional "active" or "archived" or "expired" or "inactive"` + + Filter by API key status. + +- `--workspace-id: optional string` + + Filter by Workspace ID. + +#### Returns + +- `BetaListResponse_ApiKey_: object` + + - `data: array of BetaAPIKey` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: object` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `beta_api_key_user_actor: object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + - `user_id: string` + + ID of the User the API key acts as. + + - `beta_api_key_service_account_actor: object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `beta_api_key_organization_scope: object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `beta_api_key_workspace_scope: object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `workspace_id: string` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + + - `first_id: string` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `has_more: boolean` + + Indicates if there are more results in the requested page direction. + + - `last_id: string` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +ant beta:organization:api-keys list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +`$ ant beta:organization:api-keys retrieve` + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Parameters + +- `--api-key-id: string` + + ID of the API key. + +#### Returns + +- `beta_api_key: object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: object` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `beta_api_key_user_actor: object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + - `user_id: string` + + ID of the User the API key acts as. + + - `beta_api_key_service_account_actor: object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `beta_api_key_organization_scope: object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `beta_api_key_workspace_scope: object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `workspace_id: string` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```bash +ant beta:organization:api-keys retrieve \ + --api-key my-anthropic-api-key \ + --api-key-id api_key_id +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +`$ ant beta:organization:api-keys update` + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Parameters + +- `--api-key-id: string` + + ID of the API key. + +- `--name: optional string` + + Name of the API key. + + maxLength: 500, minLength: 1 + +- `--status: optional "active" or "archived" or "inactive"` + + Status of the API key. + +#### Returns + +- `beta_api_key: object` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: object` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" or "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `beta_api_key_user_actor: object` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + - `user_id: string` + + ID of the User the API key acts as. + + - `beta_api_key_service_account_actor: object` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `beta_api_key_organization_scope: object` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `beta_api_key_workspace_scope: object` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" or "archived" or "expired" or "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `workspace_id: string` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```bash +ant beta:organization:api-keys update \ + --api-key my-anthropic-api-key \ + --api-key-id api_key_id +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +`$ ant beta:organization:external-keys create` + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Parameters + +- `--provider-config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + +- `--display-name: optional string` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `--geo: optional "us"` + + Data residency geo. Only `us` is supported. + +#### Returns + +- `beta_external_key: object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `beta_external_key_attached_attachment: object` + + - `type: "attached"` + + - `beta_external_key_unattached_attachment: object` + + - `type: "unattached"` + + - `created_at: string` + + format: date-time + + - `display_name: string` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `beta_aws_external_key_config: object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `beta_gcp_external_key_config: object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `beta_azure_external_key_config: object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +ant beta:organization:external-keys create \ + --api-key my-anthropic-api-key \ + --provider-config '{kms_arn: arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222, type: aws}' +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +`$ ant beta:organization:external-keys list` + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Parameters + +- `--limit: optional number` + + Number of results per page. + + maximum: 100, minimum: 1 + +- `--page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `BetaExternalKeyListResponse: object` + + Opaque-cursor page of external keys, ordered by creation time (newest first). + + - `data: array of BetaExternalKey` + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `beta_external_key_attached_attachment: object` + + - `type: "attached"` + + - `beta_external_key_unattached_attachment: object` + + - `type: "unattached"` + + - `created_at: string` + + format: date-time + + - `display_name: string` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `beta_aws_external_key_config: object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `beta_gcp_external_key_config: object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `beta_azure_external_key_config: object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + - `updated_at: string` + + format: date-time + + - `next_page: string` + + Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page. + +#### Example + +```bash +ant beta:organization:external-keys list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +`$ ant beta:organization:external-keys retrieve` + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Parameters + +- `--external-key-id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `beta_external_key: object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `beta_external_key_attached_attachment: object` + + - `type: "attached"` + + - `beta_external_key_unattached_attachment: object` + + - `type: "unattached"` + + - `created_at: string` + + format: date-time + + - `display_name: string` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `beta_aws_external_key_config: object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `beta_gcp_external_key_config: object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `beta_azure_external_key_config: object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +ant beta:organization:external-keys retrieve \ + --api-key my-anthropic-api-key \ + --external-key-id external_key_id +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +`$ ant beta:organization:external-keys update` + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Parameters + +- `--external-key-id: string` + + ID of the External Key. + + maxLength: 2048 + +- `--display-name: optional string` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `--geo: optional "us"` + + Data residency geo. Only `us` is supported. + +- `--provider-config: optional BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + +#### Returns + +- `beta_external_key: object` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `beta_external_key_attached_attachment: object` + + - `type: "attached"` + + - `beta_external_key_unattached_attachment: object` + + - `type: "unattached"` + + - `created_at: string` + + format: date-time + + - `display_name: string` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `beta_aws_external_key_config: object` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region: optional string` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: optional string` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `beta_gcp_external_key_config: object` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `beta_azure_external_key_config: object` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: optional string` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + - `updated_at: string` + + format: date-time + +#### Example + +```bash +ant beta:organization:external-keys update \ + --api-key my-anthropic-api-key \ + --external-key-id external_key_id +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +`$ ant beta:organization:external-keys delete` + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Parameters + +- `--external-key-id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `BetaOrganizationExternalKeyDeleteResponse: object` + + - `id: string` + + ID of the deleted External Key. + + - `type: "external_key_deleted"` + +#### Example + +```bash +ant beta:organization:external-keys delete \ + --api-key my-anthropic-api-key \ + --external-key-id external_key_id +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +`$ ant beta:organization:external-keys validate` + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Parameters + +- `--external-key-id: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `BetaOrganizationExternalKeyValidateResponse: object` + + Result of a validation roundtrip against the customer's KMS. + + HTTP 200 for both outcomes — the operation completed; `status` says + whether the key works. + + - `error: string` + + Error message when status is `failure`. Null otherwise. + + - `status: "failure" or "success"` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"failure"` + + - `"success"` + + - `type: "external_key_validation"` + +#### Example + +```bash +ant beta:organization:external-keys validate \ + --api-key my-anthropic-api-key \ + --external-key-id external_key_id +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +`$ ant beta:organization:federation:issuers create` + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Parameters + +- `--issuer-url: string` + + Body param: The `iss` claim value to match against. + + minLength: 1 + +- `--name: string` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `--check-jti: optional boolean` + + Body param: Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `--jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + Body param: How signing keys are obtained. Defaults to OIDC discovery. + +- `--max-jwt-lifetime-seconds: optional number` + + Body param: Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_issuer: object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `beta_jwks_discovery: object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string` + + Set when the discovery URL differs from `issuer_url`. + + - `beta_jwks_explicit_url: object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `beta_jwks_inline: object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: object` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +ant beta:organization:federation:issuers create \ + --api-key my-anthropic-api-key \ + --issuer-url x \ + --name x +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +`$ ant beta:organization:federation:issuers list` + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Parameters + +- `--include-archived: optional boolean` + + Query param: Include archived resources. Defaults to false. + +- `--limit: optional number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + +- `--page: optional string` + + Query param: Opaque cursor from a previous response's `next_page`. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationIssuerListResponse: object` + + - `data: array of BetaFederationIssuer` + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `beta_jwks_discovery: object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string` + + Set when the discovery URL differs from `issuer_url`. + + - `beta_jwks_explicit_url: object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `beta_jwks_inline: object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: object` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + + - `next_page: string` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +ant beta:organization:federation:issuers list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +`$ ant beta:organization:federation:issuers retrieve` + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Parameters + +- `--federation-issuer-id: string` + + ID of the federation issuer. + +- `--beta: optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_issuer: object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `beta_jwks_discovery: object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string` + + Set when the discovery URL differs from `issuer_url`. + + - `beta_jwks_explicit_url: object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `beta_jwks_inline: object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: object` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +ant beta:organization:federation:issuers retrieve \ + --api-key my-anthropic-api-key \ + --federation-issuer-id federation_issuer_id +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +`$ ant beta:organization:federation:issuers update` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Parameters + +- `--federation-issuer-id: string` + + Path param: ID of the federation issuer to update. + +- `--check-jti: optional boolean` + + Body param: Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `--issuer-url: optional string` + + Body param: Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + +- `--jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + Body param: Replaces the entire JWKS configuration. + +- `--jwks-polling-disabled: optional boolean` + + Body param: Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `--max-jwt-lifetime-seconds: optional number` + + Body param: Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `--name: optional string` + + Body param: Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_issuer: object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `beta_jwks_discovery: object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string` + + Set when the discovery URL differs from `issuer_url`. + + - `beta_jwks_explicit_url: object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `beta_jwks_inline: object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: object` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +ant beta:organization:federation:issuers update \ + --api-key my-anthropic-api-key \ + --federation-issuer-id federation_issuer_id +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +`$ ant beta:organization:federation:issuers archive` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Parameters + +- `--federation-issuer-id: string` + + ID of the federation issuer to archive. + +- `--beta: optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_issuer: object` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `beta_jwks_discovery: object` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: optional string` + + Set when the discovery URL differs from `issuer_url`. + + - `beta_jwks_explicit_url: object` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: optional string` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `beta_jwks_inline: object` + + JWKS supplied directly; no network fetch. + + - `keys: array of map[unknown]` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: object` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```bash +ant beta:organization:federation:issuers archive \ + --api-key my-anthropic-api-key \ + --federation-issuer-id federation_issuer_id +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +`$ ant beta:organization:federation:rules create` + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Parameters + +- `--issuer-id: string` + + Body param: Tagged ID of the federation issuer. + +- `--match: object` + + Body param: Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + +- `--name: string` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `--oauth-scope: string` + + Body param: Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `--target: object` + + Body param: Identity that tokens minted via this rule act as. Currently always a `service_account` target. + +- `--applies-to-all-workspaces: optional boolean` + + Body param: When true, enable this rule for every workspace in the org (including workspaces created later). + +- `--attributes: optional map[string]` + + Body param: CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `--description: optional string` + + Body param: Optional free-text description. + + maxLength: 2000 + +- `--token-lifetime-seconds: optional number` + + Body param: Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `--workspace-id: optional string` + + Body param: Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_rule: object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string` + + Issuer's display name at read time. + + - `match: object` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: object` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +ant beta:organization:federation:rules create \ + --api-key my-anthropic-api-key \ + --issuer-id issuer_id \ + --match '{}' \ + --name x \ + --oauth-scope x \ + --target '{service_account_id: svac_01SDCCSbTxrXDpWc1phhtcfK, type: service_account}' +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +`$ ant beta:organization:federation:rules list` + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Parameters + +- `--include-archived: optional boolean` + + Query param: Include archived resources. Defaults to false. + +- `--issuer-id: optional string` + + Query param: Filter to rules referencing this federation issuer. + +- `--limit: optional number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + +- `--page: optional string` + + Query param: Opaque cursor from a previous response's `next_page`. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRuleListResponse: object` + + - `data: array of BetaFederationRule` + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string` + + Issuer's display name at read time. + + - `match: object` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: object` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + + - `next_page: string` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +ant beta:organization:federation:rules list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +`$ ant beta:organization:federation:rules retrieve` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Parameters + +- `--federation-rule-id: string` + + ID of the federation rule. + +- `--beta: optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_rule: object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string` + + Issuer's display name at read time. + + - `match: object` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: object` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +ant beta:organization:federation:rules retrieve \ + --api-key my-anthropic-api-key \ + --federation-rule-id federation_rule_id +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +`$ ant beta:organization:federation:rules update` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `--federation-rule-id: string` + + Path param: ID of the federation rule to update. + +- `--applies-to-all-workspaces: optional boolean` + + Body param: When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `--attributes: optional map[string]` + + Body param: Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `--description: optional string` + + Body param: Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `--match: optional object` + + Body param: Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + +- `--name: optional string` + + Body param: Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `--oauth-scope: optional string` + + Body param: Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `--target: optional object` + + Body param: Bind to a fixed service account by ID. + +- `--token-lifetime-seconds: optional number` + + Body param: Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `--workspace-id: optional string` + + Body param: Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_rule: object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string` + + Issuer's display name at read time. + + - `match: object` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: object` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +ant beta:organization:federation:rules update \ + --api-key my-anthropic-api-key \ + --federation-rule-id federation_rule_id +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +`$ ant beta:organization:federation:rules archive` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `--federation-rule-id: string` + + ID of the federation rule to archive. + +- `--beta: optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_rule: object` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: map[string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string` + + Issuer's display name at read time. + + - `match: object` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: optional string` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: optional map[string]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: optional string` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: optional string` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: object` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name: optional string` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: array of string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```bash +ant beta:organization:federation:rules archive \ + --api-key my-anthropic-api-key \ + --federation-rule-id federation_rule_id +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +`$ ant beta:organization:federation:rules:workspaces add` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `--federation-rule-id: string` + + Path param: ID of the federation rule. + +- `--workspace-id: string` + + Body param: Tagged ID of the workspace to enable this rule for. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_federation_rule_workspace: object` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```bash +ant beta:organization:federation:rules:workspaces add \ + --api-key my-anthropic-api-key \ + --federation-rule-id federation_rule_id \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +`$ ant beta:organization:federation:rules:workspaces list` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Parameters + +- `--federation-rule-id: string` + + Path param: ID of the federation rule. + +- `--limit: optional number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + +- `--page: optional string` + + Query param: Opaque cursor from a previous response's `next_page`. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRuleWorkspaceListResponse: object` + + - `data: array of BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string` + + Workspace display name. Populated when listing; null in the enable response. + + - `next_page: string` + + Opaque cursor for the next page; null when there are no more results. + +#### Example + +```bash +ant beta:organization:federation:rules:workspaces list \ + --api-key my-anthropic-api-key \ + --federation-rule-id federation_rule_id +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +`$ ant beta:organization:federation:rules:workspaces remove` + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `--federation-rule-id: string` + + Path param: ID of the federation rule. + +- `--workspace-id: string` + + Path param: ID of the workspace to disable for. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaOrganizationFederationRuleWorkspaceRemoveResponse: object` + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace_deleted"` + + - `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```bash +ant beta:organization:federation:rules:workspaces remove \ + --api-key my-anthropic-api-key \ + --federation-rule-id federation_rule_id \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +`$ ant beta:organization:invites create` + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Parameters + +- `--email: string` + + Email of the User. + + format: email + +- `--role: "billing" or "claude_code_user" or "developer" or 2 more` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + +- `--rbac-group-id: optional array of string` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `beta_organization_invite: object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: "admin" or "billing" or "claude_code_user" or 6 more` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```bash +ant beta:organization:invites create \ + --api-key my-anthropic-api-key \ + --email user@emaildomain.com \ + --role user +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +`$ ant beta:organization:invites list` + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Parameters + +- `--after-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `--before-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `--email: optional string` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + +- `--limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +- `--role: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +- `--status: optional array of "accepted" or "expired" or "pending"` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + +#### Returns + +- `BetaListResponse_InviteSchema_: object` + + - `data: array of BetaOrganizationInvite` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: "admin" or "billing" or "claude_code_user" or 6 more` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + - `first_id: string` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `has_more: boolean` + + Indicates if there are more results in the requested page direction. + + - `last_id: string` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +ant beta:organization:invites list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +`$ ant beta:organization:invites retrieve` + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Parameters + +- `--invite-id: string` + + ID of the Invite. + +#### Returns + +- `beta_organization_invite: object` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: array of string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: "admin" or "billing" or "claude_code_user" or 6 more` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" or "deleted" or "expired" or "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```bash +ant beta:organization:invites retrieve \ + --api-key my-anthropic-api-key \ + --invite-id invite_id +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +`$ ant beta:organization:invites delete` + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Parameters + +- `--invite-id: string` + + ID of the Invite. + +#### Returns + +- `BetaOrganizationInviteDeleteResponse: object` + + - `id: string` + + ID of the Invite. + + - `type: "invite_deleted"` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + +#### Example + +```bash +ant beta:organization:invites delete \ + --api-key my-anthropic-api-key \ + --invite-id invite_id +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +`$ ant beta:organization:service-accounts create` + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Parameters + +- `--name: string` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `--description: optional string` + + Body param: Optional free-text description. + + maxLength: 2000 + +- `--organization-role: optional "admin" or "developer"` + + Body param: Org-level role. Defaults to `developer`. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_service_account: object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +ant beta:organization:service-accounts create \ + --api-key my-anthropic-api-key \ + --name ci-deploy-bot +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +`$ ant beta:organization:service-accounts list` + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Parameters + +- `--include-archived: optional boolean` + + Query param: Include archived resources. Defaults to false. + +- `--limit: optional number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + +- `--page: optional string` + + Query param: Opaque cursor from a previous response's `next_page`. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaServiceAccountListResponse: object` + + - `data: array of BetaServiceAccount` + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + + - `next_page: string` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +ant beta:organization:service-accounts list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +`$ ant beta:organization:service-accounts retrieve` + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Parameters + +- `--service-account-id: string` + + ID of the service account. + +- `--beta: optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_service_account: object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +ant beta:organization:service-accounts retrieve \ + --api-key my-anthropic-api-key \ + --service-account-id service_account_id +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +`$ ant beta:organization:service-accounts update` + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Parameters + +- `--service-account-id: string` + + Path param: ID of the service account to update. + +- `--description: optional string` + + Body param: Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `--organization-role: optional "admin" or "developer"` + + Body param: Replaces the org-level role. Omit or send `null` to leave unchanged. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_service_account: object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +ant beta:organization:service-accounts update \ + --api-key my-anthropic-api-key \ + --service-account-id service_account_id +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +`$ ant beta:organization:service-accounts archive` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Parameters + +- `--service-account-id: string` + + ID of the service account to archive. + +- `--beta: optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_service_account: object` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" or "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```bash +ant beta:organization:service-accounts archive \ + --api-key my-anthropic-api-key \ + --service-account-id service_account_id +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +`$ ant beta:organization:service-accounts:workspaces add` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Parameters + +- `--service-account-id: string` + + Path param: ID of the service account. + +- `--workspace-id: string` + + Body param: Tagged workspace ID to add the service account to. + +- `--workspace-role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"` + + Body param: Role to assign to the service account in this workspace. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_service_account_workspace_member: object` + + - `created_by_actor_id: string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +ant beta:organization:service-accounts:workspaces add \ + --api-key my-anthropic-api-key \ + --service-account-id service_account_id \ + --workspace-id workspace_id \ + --workspace-role workspace_admin +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +`$ ant beta:organization:service-accounts:workspaces list` + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Parameters + +- `--service-account-id: string` + + Path param: ID of the service account. + +- `--limit: optional number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + +- `--page: optional string` + + Query param: Opaque cursor from a previous response's `next_page`. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaServiceAccountWorkspaceMemberListResponse: object` + + - `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + + - `next_page: string` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +ant beta:organization:service-accounts:workspaces list \ + --api-key my-anthropic-api-key \ + --service-account-id service_account_id +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +`$ ant beta:organization:service-accounts:workspaces remove` + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Parameters + +- `--service-account-id: string` + + Path param: ID of the service account. + +- `--workspace-id: string` + + Path param: ID of the workspace. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaOrganizationServiceAccountWorkspaceRemoveResponse: object` + + - `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: "service_account_workspace_member_deleted"` + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```bash +ant beta:organization:service-accounts:workspaces remove \ + --api-key my-anthropic-api-key \ + --service-account-id service_account_id \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +`$ ant beta:organization:users list` + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Parameters + +- `--after-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `--before-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `--email: optional string` + + Filter by user email. + + format: email + +- `--limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +- `--role: optional array of string` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `BetaListResponse_User_: object` + + - `data: array of BetaOrganizationUser` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: "admin" or "billing" or "claude_code_user" or 6 more` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + - `first_id: string` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `has_more: boolean` + + Indicates if there are more results in the requested page direction. + + - `last_id: string` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +ant beta:organization:users list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +`$ ant beta:organization:users retrieve` + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Parameters + +- `--user-id: string` + + ID of the User. + +#### Returns + +- `beta_organization_user: object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: "admin" or "billing" or "claude_code_user" or 6 more` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```bash +ant beta:organization:users retrieve \ + --api-key my-anthropic-api-key \ + --user-id user_id +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +`$ ant beta:organization:users update` + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Parameters + +- `--user-id: string` + + ID of the User. + +- `--role: "billing" or "claude_code_user" or "developer" or 2 more` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + +#### Returns + +- `beta_organization_user: object` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: "admin" or "billing" or "claude_code_user" or 6 more` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```bash +ant beta:organization:users update \ + --api-key my-anthropic-api-key \ + --user-id user_id \ + --role user +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +`$ ant beta:organization:users remove` + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Parameters + +- `--user-id: string` + + ID of the User. + +#### Returns + +- `BetaOrganizationUserRemoveResponse: object` + + - `id: string` + + ID of the User. + + - `type: "user_deleted"` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + +#### Example + +```bash +ant beta:organization:users remove \ + --api-key my-anthropic-api-key \ + --user-id user_id +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +`$ ant beta:organization:workspaces list` + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Parameters + +- `--after-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `--before-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `--include-archived: optional boolean` + + Whether to include Workspaces that have been archived in the response + +- `--limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `BetaListResponse_Workspace_: object` + + - `data: array of BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: object` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `geos: array of string` + + - `unrestricted: "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + - `first_id: string` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `has_more: boolean` + + Indicates if there are more results in the requested page direction. + + - `last_id: string` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +ant beta:organization:workspaces list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +`$ ant beta:organization:workspaces create` + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Parameters + +- `--name: string` + + Body param: Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `--data-residency: optional object` + + Body param: Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + +- `--display-color: optional string` + + Body param: Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `--external-key-id: optional string` + + Body param: ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `--tags: optional map[string]` + + Body param: User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_workspace: object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: object` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `geos: array of string` + + - `unrestricted: "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```bash +ant beta:organization:workspaces create \ + --api-key my-anthropic-api-key \ + --name x +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +`$ ant beta:organization:workspaces retrieve` + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Parameters + +- `--workspace-id: string` + + ID of the Workspace. + +#### Returns + +- `beta_workspace: object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: object` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `geos: array of string` + + - `unrestricted: "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```bash +ant beta:organization:workspaces retrieve \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +`$ ant beta:organization:workspaces update` + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Parameters + +- `--workspace-id: string` + +- `--data-residency: optional object` + + Data residency configuration for the workspace. + +- `--display-color: optional string` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `--external-key-id: optional string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `--name: optional string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `--tags: optional map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `beta_workspace: object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: object` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `geos: array of string` + + - `unrestricted: "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```bash +ant beta:organization:workspaces update \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +`$ ant beta:organization:workspaces archive` + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Parameters + +- `--workspace-id: string` + +#### Returns + +- `beta_workspace: object` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: object` + + Data residency configuration. + + - `allowed_inference_geos: array of string or "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `geos: array of string` + + - `unrestricted: "unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: map[string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```bash +ant beta:organization:workspaces archive \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +`$ ant beta:organization:workspaces:rate-limits list` + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `--workspace-id: string` + + The ID of the workspace. + +- `--group-type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + +- `--limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `--page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `BetaWorkspaceRateLimitListResponse: object` + + - `data: array of BetaWorkspaceRateLimit` + + Rate-limit entries for the workspace, one per group that has at least one override. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaWorkspaceRateLimitValue` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: number` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. + + - `models: array of string` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: string` + + The `id` of the RateLimit group this override applies to. + + - `type: "workspace_rate_limit"` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + - `workspace_id: string` + + ID of the Workspace this override applies to. + + - `next_page: string` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +#### Example + +```bash +ant beta:organization:workspaces:rate-limits list \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +`$ ant beta:organization:workspaces:members list` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Parameters + +- `--workspace-id: string` + + ID of the Workspace. + +- `--after-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `--before-id: optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `--limit: optional number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `BetaListResponse_WorkspaceMemberSchema_: object` + + - `data: array of BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + + - `first_id: string` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `has_more: boolean` + + Indicates if there are more results in the requested page direction. + + - `last_id: string` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```bash +ant beta:organization:workspaces:members list \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +`$ ant beta:organization:workspaces:members add` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Parameters + +- `--workspace-id: string` + + ID of the Workspace. + +- `--user-id: string` + + ID of the User. + +- `--workspace-role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + +#### Returns + +- `beta_workspace_member: object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +ant beta:organization:workspaces:members add \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id \ + --user-id user_01WCz1FkmYMm4gnmykNKUu3Q \ + --workspace-role workspace_admin +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +`$ ant beta:organization:workspaces:members retrieve` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Parameters + +- `--workspace-id: string` + + ID of the Workspace. + +- `--user-id: string` + + ID of the User. + +#### Returns + +- `beta_workspace_member: object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +ant beta:organization:workspaces:members retrieve \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id \ + --user-id user_id +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +`$ ant beta:organization:workspaces:members update` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Parameters + +- `--workspace-id: string` + + Path param: ID of the Workspace. + +- `--user-id: string` + + Path param: ID of the User. + +- `--workspace-role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Body param: New workspace role for the User. + +#### Returns + +- `beta_workspace_member: object` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +ant beta:organization:workspaces:members update \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id \ + --user-id user_id \ + --workspace-role workspace_admin +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +`$ ant beta:organization:workspaces:members remove` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Parameters + +- `--workspace-id: string` + + ID of the Workspace. + +- `--user-id: string` + + ID of the User. + +#### Returns + +- `BetaOrganizationWorkspaceMemberRemoveResponse: object` + + - `type: "workspace_member_deleted"` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + +#### Example + +```bash +ant beta:organization:workspaces:members remove \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id \ + --user-id user_id +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +`$ ant beta:organization:workspaces:service-accounts list` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Parameters + +- `--workspace-id: string` + + Path param: ID of the workspace. + +- `--limit: optional number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + +- `--page: optional string` + + Query param: Opaque cursor from a previous response's `next_page`. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaServiceAccountWorkspaceMemberListResponse: object` + + - `data: array of BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + + - `next_page: string` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```bash +ant beta:organization:workspaces:service-accounts list \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +`$ ant beta:organization:workspaces:service-accounts add` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Parameters + +- `--workspace-id: string` + + Path param: ID of the workspace. + +- `--service-account-id: string` + + Body param: Tagged service account ID to add. + +- `--workspace-role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"` + + Body param: Role to assign to the service account in this workspace. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_service_account_workspace_member: object` + + - `created_by_actor_id: string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +ant beta:organization:workspaces:service-accounts add \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id \ + --service-account-id service_account_id \ + --workspace-role workspace_admin +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Get Service Account Workspace Member + +`$ ant beta:organization:workspaces:service-accounts retrieve` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. + +#### Parameters + +- `--workspace-id: string` + + Path param: ID of the workspace. + +- `--service-account-id: string` + + Path param: ID of the service account. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_service_account_workspace_member: object` + + - `created_by_actor_id: string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +ant beta:organization:workspaces:service-accounts retrieve \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id \ + --service-account-id service_account_id +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Update Service Account Workspace Member + +`$ ant beta:organization:workspaces:service-accounts update` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. + +#### Parameters + +- `--workspace-id: string` + + Path param: ID of the workspace. + +- `--service-account-id: string` + + Path param: ID of the service account. + +- `--workspace-role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"` + + Body param: New role for the service account in this workspace. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `beta_service_account_workspace_member: object` + + - `created_by_actor_id: string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```bash +ant beta:organization:workspaces:service-accounts update \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id \ + --service-account-id service_account_id \ + --workspace-role workspace_admin +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Delete Service Account Workspace Member + +`$ ant beta:organization:workspaces:service-accounts remove` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. + +#### Parameters + +- `--workspace-id: string` + + Path param: ID of the workspace. + +- `--service-account-id: string` + + Path param: ID of the service account. + +- `--beta: optional array of AnthropicBeta` + + Header param: Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaOrganizationWorkspaceServiceAccountRemoveResponse: object` + + - `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: "service_account_workspace_member_deleted"` + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```bash +ant beta:organization:workspaces:service-accounts remove \ + --api-key my-anthropic-api-key \ + --workspace-id workspace_id \ + --service-account-id service_account_id +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Rate Limits + +### List Organization Rate Limits + +`$ ant beta:organization:rate-limits list` + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `--group-type: optional "batch" or "files" or "model_group" or 3 more` + + Filter by group type. + +- `--limit: optional number` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `--model: optional string` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + +- `--page: optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `BetaRateLimitListResponse: object` + + - `data: array of BetaOrganizationRateLimit` + + Rate-limit entries for the organization, one per group. + + - `id: string` + + Stable identifier for this rate-limit group within the organization. + + - `group_type: "batch" or "files" or "model_group" or 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: array of BetaOrganizationRateLimitValue` + + The limiter values that apply to this group. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The configured limit value for this limiter type. + + - `models: array of string` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: "rate_limit"` + + Object type. Always `rate_limit` for organization rate-limit entries. + + - `next_page: string` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +#### Example + +```bash +ant beta:organization:rate-limits list \ + --api-key my-anthropic-api-key +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/cli/beta/environments.md b/content/en/api/cli/beta/environments.md index d63b39b8e..2aa7e5f95 100644 --- a/content/en/api/cli/beta/environments.md +++ b/content/en/api/cli/beta/environments.md @@ -1255,7 +1255,7 @@ ant beta:environments archive \ - `allow_package_managers: optional boolean` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string` @@ -1267,6 +1267,8 @@ ant beta:environments archive \ When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string` Ubuntu/Debian packages to install @@ -1480,7 +1482,7 @@ ant beta:environments archive \ - `allow_package_managers: optional boolean` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string` @@ -1528,6 +1530,8 @@ ant beta:environments archive \ When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: optional array of string` Ubuntu/Debian packages to install diff --git a/content/en/api/cli/beta/memory_stores.md b/content/en/api/cli/beta/memory_stores.md index 54cb0d9d7..f61f2a7dd 100644 --- a/content/en/api/cli/beta/memory_stores.md +++ b/content/en/api/cli/beta/memory_stores.md @@ -656,7 +656,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -783,7 +783,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -903,7 +903,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1019,7 +1019,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1093,7 +1093,7 @@ Delete a memory - `beta_managed_agents_deleted_memory: object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -1207,7 +1207,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -1394,7 +1394,7 @@ Retrieve a memory version - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -1408,7 +1408,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -1583,7 +1583,7 @@ Redact a memory version - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -1597,7 +1597,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/cli/beta/memory_stores/memories.md b/content/en/api/cli/beta/memory_stores/memories.md index d145521c1..fade3a994 100644 --- a/content/en/api/cli/beta/memory_stores/memories.md +++ b/content/en/api/cli/beta/memory_stores/memories.md @@ -64,7 +64,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -191,7 +191,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -311,7 +311,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -427,7 +427,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -501,7 +501,7 @@ Delete a memory - `beta_managed_agents_deleted_memory: object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -553,7 +553,7 @@ ant beta:memory-stores:memories delete \ - `beta_managed_agents_deleted_memory: object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -673,7 +673,7 @@ ant beta:memory-stores:memories delete \ - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -727,7 +727,7 @@ ant beta:memory-stores:memories delete \ - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/cli/beta/memory_stores/memories/create.md b/content/en/api/cli/beta/memory_stores/memories/create.md index d33daae3e..8b9df7958 100644 --- a/content/en/api/cli/beta/memory_stores/memories/create.md +++ b/content/en/api/cli/beta/memory_stores/memories/create.md @@ -62,7 +62,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/cli/beta/memory_stores/memories/delete.md b/content/en/api/cli/beta/memory_stores/memories/delete.md index 43b8c3c28..4c0577354 100644 --- a/content/en/api/cli/beta/memory_stores/memories/delete.md +++ b/content/en/api/cli/beta/memory_stores/memories/delete.md @@ -28,7 +28,7 @@ Delete a memory - `beta_managed_agents_deleted_memory: object` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` diff --git a/content/en/api/cli/beta/memory_stores/memories/list.md b/content/en/api/cli/beta/memory_stores/memories/list.md index cd1175776..be7f812e8 100644 --- a/content/en/api/cli/beta/memory_stores/memories/list.md +++ b/content/en/api/cli/beta/memory_stores/memories/list.md @@ -80,7 +80,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/cli/beta/memory_stores/memories/retrieve.md b/content/en/api/cli/beta/memory_stores/memories/retrieve.md index 5e75e2633..3786c2db3 100644 --- a/content/en/api/cli/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/cli/beta/memory_stores/memories/retrieve.md @@ -56,7 +56,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/cli/beta/memory_stores/memories/update.md b/content/en/api/cli/beta/memory_stores/memories/update.md index bbe3a9ac6..4659da252 100644 --- a/content/en/api/cli/beta/memory_stores/memories/update.md +++ b/content/en/api/cli/beta/memory_stores/memories/update.md @@ -70,7 +70,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/cli/beta/memory_stores/memory_versions.md b/content/en/api/cli/beta/memory_stores/memory_versions.md index 402960c9d..5166b9a73 100644 --- a/content/en/api/cli/beta/memory_stores/memory_versions.md +++ b/content/en/api/cli/beta/memory_stores/memory_versions.md @@ -86,7 +86,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -273,7 +273,7 @@ Retrieve a memory version - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -287,7 +287,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -462,7 +462,7 @@ Redact a memory version - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -476,7 +476,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -699,7 +699,7 @@ ant beta:memory-stores:memory-versions redact \ - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -713,7 +713,7 @@ ant beta:memory-stores:memory-versions redact \ - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/cli/beta/memory_stores/memory_versions/list.md b/content/en/api/cli/beta/memory_stores/memory_versions/list.md index badade028..abeae4990 100644 --- a/content/en/api/cli/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/cli/beta/memory_stores/memory_versions/list.md @@ -84,7 +84,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/cli/beta/memory_stores/memory_versions/redact.md b/content/en/api/cli/beta/memory_stores/memory_versions/redact.md index a18b7869e..a26441164 100644 --- a/content/en/api/cli/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/cli/beta/memory_stores/memory_versions/redact.md @@ -24,7 +24,7 @@ Redact a memory version - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -38,7 +38,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/cli/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/cli/beta/memory_stores/memory_versions/retrieve.md index 07637663c..e97236bbf 100644 --- a/content/en/api/cli/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/cli/beta/memory_stores/memory_versions/retrieve.md @@ -28,7 +28,7 @@ Retrieve a memory version - `beta_managed_agents_memory_version: object` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -42,7 +42,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/cli/beta/messages.md b/content/en/api/cli/beta/messages.md index 036ae6192..145fc507b 100644 --- a/content/en/api/cli/beta/messages.md +++ b/content/en/api/cli/beta/messages.md @@ -1648,12 +1648,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -2389,12 +2391,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -11833,7 +11837,7 @@ ant beta:messages count-tokens \ - `type: "enabled"` - - `display: optional "summarized" or "omitted"` + - `display: optional "summarized" or "omitted" or "updates"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -11841,6 +11845,8 @@ ant beta:messages count-tokens \ - `"omitted"` + - `"updates"` + - `beta_thinking_config_disabled: object` - `type: "disabled"` @@ -11849,7 +11855,7 @@ ant beta:messages count-tokens \ - `type: "adaptive"` - - `display: optional "summarized" or "omitted"` + - `display: optional "summarized" or "omitted" or "updates"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -11857,6 +11863,8 @@ ant beta:messages count-tokens \ - `"omitted"` + - `"updates"` + ### Beta Fallback Refusal Trigger - `beta_fallback_refusal_trigger: object` @@ -12035,7 +12043,7 @@ ant beta:messages count-tokens \ - `type: "enabled"` - - `display: optional "summarized" or "omitted"` + - `display: optional "summarized" or "omitted" or "updates"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12043,6 +12051,8 @@ ant beta:messages count-tokens \ - `"omitted"` + - `"updates"` + - `beta_thinking_config_disabled: object` - `type: "disabled"` @@ -12051,7 +12061,7 @@ ant beta:messages count-tokens \ - `type: "adaptive"` - - `display: optional "summarized" or "omitted"` + - `display: optional "summarized" or "omitted" or "updates"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12059,6 +12069,8 @@ ant beta:messages count-tokens \ - `"omitted"` + - `"updates"` + - `Default: "default"` ### Beta File Document Source @@ -12196,12 +12208,14 @@ ant beta:messages count-tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -14492,12 +14506,14 @@ ant beta:messages count-tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -15049,12 +15065,14 @@ ant beta:messages count-tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -18906,12 +18924,14 @@ ant beta:messages count-tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -20702,12 +20722,14 @@ ant beta:messages count-tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -22528,12 +22550,14 @@ ant beta:messages count-tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -23157,12 +23181,14 @@ ant beta:messages count-tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -25737,7 +25763,7 @@ ant beta:messages count-tokens \ - `type: "adaptive"` - - `display: optional "summarized" or "omitted"` + - `display: optional "summarized" or "omitted" or "updates"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -25745,6 +25771,8 @@ ant beta:messages count-tokens \ - `"omitted"` + - `"updates"` + ### Beta Thinking Config Disabled - `beta_thinking_config_disabled: object` @@ -25767,7 +25795,7 @@ ant beta:messages count-tokens \ - `type: "enabled"` - - `display: optional "summarized" or "omitted"` + - `display: optional "summarized" or "omitted" or "updates"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -25775,6 +25803,8 @@ ant beta:messages count-tokens \ - `"omitted"` + - `"updates"` + ### Beta Thinking Config Param - `beta_thinking_config_param: BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigAdaptive` @@ -25799,7 +25829,7 @@ ant beta:messages count-tokens \ - `type: "enabled"` - - `display: optional "summarized" or "omitted"` + - `display: optional "summarized" or "omitted" or "updates"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -25807,6 +25837,8 @@ ant beta:messages count-tokens \ - `"omitted"` + - `"updates"` + - `beta_thinking_config_disabled: object` - `type: "disabled"` @@ -25815,7 +25847,7 @@ ant beta:messages count-tokens \ - `type: "adaptive"` - - `display: optional "summarized" or "omitted"` + - `display: optional "summarized" or "omitted" or "updates"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -25823,6 +25855,8 @@ ant beta:messages count-tokens \ - `"omitted"` + - `"updates"` + ### Beta Thinking Delta - `beta_thinking_delta: object` @@ -30172,12 +30206,14 @@ ant beta:messages count-tokens \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -34602,12 +34638,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. diff --git a/content/en/api/cli/beta/messages/batches.md b/content/en/api/cli/beta/messages/batches.md index f494ca1db..1c09cfff0 100644 --- a/content/en/api/cli/beta/messages/batches.md +++ b/content/en/api/cli/beta/messages/batches.md @@ -2082,12 +2082,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -4192,12 +4194,14 @@ ant beta:messages:batches results \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -6122,12 +6126,14 @@ ant beta:messages:batches results \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -8014,12 +8020,14 @@ ant beta:messages:batches results \ Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. diff --git a/content/en/api/cli/beta/messages/batches/results.md b/content/en/api/cli/beta/messages/batches/results.md index 2e02fd228..64e4f7089 100644 --- a/content/en/api/cli/beta/messages/batches/results.md +++ b/content/en/api/cli/beta/messages/batches/results.md @@ -1389,12 +1389,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. diff --git a/content/en/api/cli/beta/messages/create.md b/content/en/api/cli/beta/messages/create.md index 858100682..3483c5843 100644 --- a/content/en/api/cli/beta/messages/create.md +++ b/content/en/api/cli/beta/messages/create.md @@ -1646,12 +1646,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. @@ -2387,12 +2389,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `beta_message_iteration_usage: object` Token usage for a sampling iteration. diff --git a/content/en/api/cli/beta/sessions.md b/content/en/api/cli/beta/sessions.md index 538d8736e..32e2357a6 100644 --- a/content/en/api/cli/beta/sessions.md +++ b/content/en/api/cli/beta/sessions.md @@ -15914,7 +15914,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` @@ -16666,7 +16666,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` @@ -17410,7 +17410,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` diff --git a/content/en/api/cli/beta/sessions/threads.md b/content/en/api/cli/beta/sessions/threads.md index 30f63c408..30d8cb20d 100644 --- a/content/en/api/cli/beta/sessions/threads.md +++ b/content/en/api/cli/beta/sessions/threads.md @@ -44,7 +44,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` @@ -796,7 +796,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` @@ -1540,7 +1540,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` @@ -2264,7 +2264,7 @@ ant beta:sessions:threads archive \ - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` diff --git a/content/en/api/cli/beta/sessions/threads/archive.md b/content/en/api/cli/beta/sessions/threads/archive.md index e7b815c3c..d0fb1916e 100644 --- a/content/en/api/cli/beta/sessions/threads/archive.md +++ b/content/en/api/cli/beta/sessions/threads/archive.md @@ -32,7 +32,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` diff --git a/content/en/api/cli/beta/sessions/threads/list.md b/content/en/api/cli/beta/sessions/threads/list.md index b25f04b8e..2263979ca 100644 --- a/content/en/api/cli/beta/sessions/threads/list.md +++ b/content/en/api/cli/beta/sessions/threads/list.md @@ -42,7 +42,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` diff --git a/content/en/api/cli/beta/sessions/threads/retrieve.md b/content/en/api/cli/beta/sessions/threads/retrieve.md index a00a91800..c5936e6f0 100644 --- a/content/en/api/cli/beta/sessions/threads/retrieve.md +++ b/content/en/api/cli/beta/sessions/threads/retrieve.md @@ -32,7 +32,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `beta_managed_agents_session_thread_agent: object` diff --git a/content/en/api/completions.md b/content/en/api/completions.md index 8b60f5016..4bbcf3a99 100644 --- a/content/en/api/completions.md +++ b/content/en/api/completions.md @@ -18,7 +18,7 @@ Future models and features will not be compatible with Text Completions. See our - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Future models and features will not be compatible with Text Completions. See our - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `max_tokens_to_sample: number` diff --git a/content/en/api/completions/create.md b/content/en/api/completions/create.md index c2c78e83c..73786d2d2 100644 --- a/content/en/api/completions/create.md +++ b/content/en/api/completions/create.md @@ -16,7 +16,7 @@ Future models and features will not be compatible with Text Completions. See our - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Future models and features will not be compatible with Text Completions. See our - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Body parameters - `max_tokens_to_sample: number` diff --git a/content/en/api/compliance.md b/content/en/api/compliance.md index 2edc32ed8..fc0fa98fe 100644 --- a/content/en/api/compliance.md +++ b/content/en/api/compliance.md @@ -14,7 +14,7 @@ compliance activities that can be filtered by various criteria. #### Query parameters -- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 474 more` +- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 480 more` Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`. @@ -190,6 +190,14 @@ compliance activities that can be filtered by various criteria. An attempt to access an artifact failed. + - `"claude_artifact_commented"` + + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. + + - `"claude_artifact_comments_viewed"` + + An artifact's comments were viewed. + - `"claude_artifact_created"` An artifact was created. @@ -332,7 +340,7 @@ compliance activities that can be filtered by various criteria. - `"claude_code_security_scan_run_updated"` - A single Claude Code Security scan run was archived or unarchived. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. - `"claude_code_security_scan_schedule_deleted"` @@ -406,6 +414,10 @@ compliance activities that can be filtered by various criteria. Command was replaced. + - `"claude_enterprise_upgrade_credit_updated"` + + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. + - `"claude_file_access_failed"` A user was denied access to a file in Claude.ai. @@ -1306,11 +1318,11 @@ compliance activities that can be filtered by various criteria. - `"org_work_across_apps_disabled"` - Organization Work Across Apps was disabled. + The organization's "Let Claude work across apps" setting was turned off. - `"org_work_across_apps_enabled"` - Organization Work Across Apps was enabled. + The organization's "Let Claude work across apps" setting was turned on. - `"organization_address_updated"` @@ -1452,6 +1464,18 @@ compliance activities that can be filtered by various criteria. The cost report was viewed. + - `"platform_dream_archived"` + + A Dream (asynchronous memory-consolidation job) was archived. + + - `"platform_dream_cancelled"` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. + + - `"platform_dream_created"` + + A Dream (asynchronous memory-consolidation job) was created. + - `"platform_federated_authentication"` A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials. @@ -1986,7 +2010,7 @@ compliance activities that can be filtered by various criteria. format: date-time -- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 474 more` +- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 480 more` Exclude activities of these types. Cannot be combined with `activity_types[]`. @@ -2162,6 +2186,14 @@ compliance activities that can be filtered by various criteria. An attempt to access an artifact failed. + - `"claude_artifact_commented"` + + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. + + - `"claude_artifact_comments_viewed"` + + An artifact's comments were viewed. + - `"claude_artifact_created"` An artifact was created. @@ -2304,7 +2336,7 @@ compliance activities that can be filtered by various criteria. - `"claude_code_security_scan_run_updated"` - A single Claude Code Security scan run was archived or unarchived. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. - `"claude_code_security_scan_schedule_deleted"` @@ -2378,6 +2410,10 @@ compliance activities that can be filtered by various criteria. Command was replaced. + - `"claude_enterprise_upgrade_credit_updated"` + + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. + - `"claude_file_access_failed"` A user was denied access to a file in Claude.ai. @@ -3278,11 +3314,11 @@ compliance activities that can be filtered by various criteria. - `"org_work_across_apps_disabled"` - Organization Work Across Apps was disabled. + The organization's "Let Claude work across apps" setting was turned off. - `"org_work_across_apps_enabled"` - Organization Work Across Apps was enabled. + The organization's "Let Claude work across apps" setting was turned on. - `"organization_address_updated"` @@ -3424,6 +3460,18 @@ compliance activities that can be filtered by various criteria. The cost report was viewed. + - `"platform_dream_archived"` + + A Dream (asynchronous memory-consolidation job) was archived. + + - `"platform_dream_cancelled"` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. + + - `"platform_dream_created"` + + A Dream (asynchronous memory-consolidation job) was created. + - `"platform_federated_authentication"` A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials. @@ -3950,7 +3998,7 @@ compliance activities that can be filtered by various criteria. #### Returns -- `data: optional array of object or object or object or 474 more` +- `data: optional array of object or object or object or 480 more` List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present. @@ -6641,9 +6689,9 @@ compliance activities that can be filtered by various criteria. default: claude_artifact_access_failed - - `ClaudeArtifactCreated object` + - `ClaudeArtifactCommented object` - An artifact was created. + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. - `actor: object or object or object or 8 more` @@ -6858,250 +6906,45 @@ compliance activities that can be filtered by various criteria. - `claude_artifact_id: string` - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `organization_id: optional string or null` - - Organization ID this activity is associated with - - - `organization_uuid: optional string or null` - - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - - `type: optional "claude_artifact_created"` - - default: claude_artifact_created - - - `ClaudePublishedArtifactDeleted object` - - A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation). - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp - - - `FederatedActorOidcProvider object` - - Asserting party: a customer-registered OIDC federation issuer. - - - `issuer: optional string or null` - - The federation issuer's URL. Null when the presented credential failed verification. - - - `type: optional "oidc"` + The artifact's identifier. - default: oidc + - `comment_action: "activate_thread" or "create_thread" or "deactivate_thread" or 6 more` - - `ip_address: optional string or null` + The action recorded: for example a new comment thread, a reply to an existing thread, a thread resolved, reopened, or deleted, a thread's Claude activation granted or revoked, or a comment's text rewritten by its author. - - `subject: optional string or null` + - `"activate_thread"` - The provider's verified identifier for the caller; its form depends on the provider. + - `"create_thread"` - - `type: optional "federated_actor"` + - `"deactivate_thread"` - default: federated_actor + - `"delete_thread"` - - `user_agent: optional string or null` + - `"edit_comment"` - - `AttestedDeviceActor object` + - `"reopen"` - An attested mobile device authenticated via Apple App Attest. + - `"reply"` - - `external_client_id: string` + - `"resolve"` - - `kid_hash: string` + - `"unspecified"` - - `ip_address: optional string or null` + - `id: optional string` - - `type: optional "attested_device_actor"` + Unique identifier for the activity e.g. 'activity_abcd1234' - default: attested_device_actor + - `claude_artifact_comment_id: optional string or null` - - `user_agent: optional string or null` + The comment's identifier. Present when the activity relates to a specific comment, for example a new comment or an author's edit of one; absent for thread-level actions performed without a comment, such as resolve, reopen, deletion, or an activation change. - - `claude_published_artifact_id: string` + - `claude_artifact_comment_thread_id: optional string or null` - The published artifact's identifier. + The comment thread's identifier. - - `id: optional string` + - `claude_artifact_version_id: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The artifact version the comment activity applied to, when known. - `created_at: optional string` @@ -7117,13 +6960,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_published_artifact_deleted"` + - `type: optional "claude_artifact_commented"` - default: claude_published_artifact_deleted + default: claude_artifact_commented - - `ClaudeArtifactPublished object` + - `ClaudeArtifactCommentsViewed object` - A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded on every save, including saves of private artifacts, and changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated. + An artifact's comments were viewed. - `actor: object or object or object or 8 more` @@ -7336,17 +7179,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `artifact_type: string` - - Artifact type (code, html, react, etc.) - - - `claude_published_artifact_id: string` - - The published artifact's identifier. - - - `title: string` + - `claude_artifact_id: string` - Title of the published artifact + The artifact's identifier. - `id: optional string` @@ -7354,7 +7189,7 @@ compliance activities that can be filtered by various criteria. - `claude_artifact_version_id: optional string or null` - The version identifier recorded as live by this publish. + The version of the artifact whose comments were served, when known. - `created_at: optional string` @@ -7362,14 +7197,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `description: optional string or null` - - Optional gallery-card description supplied at publish time. Same provenance as title (caller-authored, reader-visible). - - - `is_redeploy: optional boolean or null` - - True when the publish updated an existing artifact; false when the publish created the artifact. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -7378,13 +7205,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_artifact_published"` + - `type: optional "claude_artifact_comments_viewed"` - default: claude_artifact_published + default: claude_artifact_comments_viewed - - `ClaudeArtifactSharingUpdated object` + - `ClaudeArtifactCreated object` - An artifact's sharing settings were updated. + An artifact was created. - `actor: object or object or object or 8 more` @@ -7597,43 +7424,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `audience: array of object or object or object` - - Sharing audience for the project. If empty, this it's only visible to the creating user. - - - `ArtifactSharingAudienceOrganization object` - - Sharing audience: visible to the owning organization. - - - `type: optional "organization"` - - default: organization - - - `ArtifactSharingAudienceUsers object` - - Sharing audience: visible to an explicit allowlist of users. - - - `type: optional "users"` - - default: users - - - `ArtifactSharingAudienceAnyoneWithLink object` - - Sharing audience: anyone with the link, including anonymous viewers - (an artifact shared to the open internet). - - - `type: optional "anyone_with_link"` - - default: anyone_with_link - - `claude_artifact_id: string` - The artifact's identifier. - - - `claude_artifact_version_id: string` - - The artifact version's identifier. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -7644,22 +7436,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `new_mode: optional string or null` - - The read-axis sharing mode after the change: `owner`, `users`, or `org`. - - - `new_user_count: optional number or null` - - The number of accounts on the explicit read allowlist after the change. Only meaningful when `new_mode` is `users`. - - - `new_write_mode: optional string or null` - - The write-axis sharing mode after the change: `owner`, `users`, or `org`. - - - `new_write_user_count: optional number or null` - - The number of accounts on the explicit write allowlist after the change. Only meaningful when `new_write_mode` is `users`. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -7668,29 +7444,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mode: optional string or null` - - The read-axis sharing mode before the change: `owner`, `users`, or `org`. - - - `previous_user_count: optional number or null` - - The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`. - - - `previous_write_mode: optional string or null` - - The write-axis sharing mode before the change: `owner`, `users`, or `org`. - - - `previous_write_user_count: optional number or null` - - The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`. - - - `type: optional "claude_artifact_sharing_updated"` + - `type: optional "claude_artifact_created"` - default: claude_artifact_sharing_updated + default: claude_artifact_created - - `ClaudeArtifactViewed object` + - `ClaudePublishedArtifactDeleted object` - An artifact was viewed. + A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation). - `actor: object or object or object or 8 more` @@ -7903,18 +7663,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_artifact_id: string` + - `claude_published_artifact_id: string` - The artifact's identifier. + The published artifact's identifier. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_version_id: optional string or null` - - The version of the artifact the user was served, when known. - - `created_at: optional string` When this activity occurred. @@ -7929,13 +7685,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_artifact_viewed"` + - `type: optional "claude_published_artifact_deleted"` - default: claude_artifact_viewed + default: claude_published_artifact_deleted - - `AuditLogExportAccessed object` + - `ClaudeArtifactPublished object` - Audit log export file was accessed/downloaded via signed URL. + A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded on every save, including saves of private artifacts, and changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated. - `actor: object or object or object or 8 more` @@ -8148,16 +7904,40 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `artifact_type: string` + + Artifact type (code, html, react, etc.) + + - `claude_published_artifact_id: string` + + The published artifact's identifier. + + - `title: string` + + Title of the published artifact + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_artifact_version_id: optional string or null` + + The version identifier recorded as live by this publish. + - `created_at: optional string` When this activity occurred. format: date-time + - `description: optional string or null` + + Optional gallery-card description supplied at publish time. Same provenance as title (caller-authored, reader-visible). + + - `is_redeploy: optional boolean or null` + + True when the publish updated an existing artifact; false when the publish created the artifact. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -8166,13 +7946,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "audit_log_export_accessed"` + - `type: optional "claude_artifact_published"` - default: audit_log_export_accessed + default: claude_artifact_published - - `AuditLogExportStarted object` + - `ClaudeArtifactSharingUpdated object` - Audit log export was initiated. + An artifact's sharing settings were updated. - `actor: object or object or object or 8 more` @@ -8385,6 +8165,43 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `audience: array of object or object or object` + + Sharing audience for the project. If empty, this it's only visible to the creating user. + + - `ArtifactSharingAudienceOrganization object` + + Sharing audience: visible to the owning organization. + + - `type: optional "organization"` + + default: organization + + - `ArtifactSharingAudienceUsers object` + + Sharing audience: visible to an explicit allowlist of users. + + - `type: optional "users"` + + default: users + + - `ArtifactSharingAudienceAnyoneWithLink object` + + Sharing audience: anyone with the link, including anonymous viewers + (an artifact shared to the open internet). + + - `type: optional "anyone_with_link"` + + default: anyone_with_link + + - `claude_artifact_id: string` + + The artifact's identifier. + + - `claude_artifact_version_id: string` + + The artifact version's identifier. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -8395,9 +8212,21 @@ compliance activities that can be filtered by various criteria. format: date-time - - `from_date: optional string or null` + - `new_mode: optional string or null` - Start date of the export range + The read-axis sharing mode after the change: `owner`, `users`, or `org`. + + - `new_user_count: optional number or null` + + The number of accounts on the explicit read allowlist after the change. Only meaningful when `new_mode` is `users`. + + - `new_write_mode: optional string or null` + + The write-axis sharing mode after the change: `owner`, `users`, or `org`. + + - `new_write_user_count: optional number or null` + + The number of accounts on the explicit write allowlist after the change. Only meaningful when `new_write_mode` is `users`. - `organization_id: optional string or null` @@ -8407,17 +8236,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `to_date: optional string or null` + - `previous_mode: optional string or null` - End date of the export range + The read-axis sharing mode before the change: `owner`, `users`, or `org`. - - `type: optional "audit_log_export_started"` + - `previous_user_count: optional number or null` - default: audit_log_export_started + The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`. - - `BillingEmailsUpdated object` + - `previous_write_mode: optional string or null` - The organization's billing email recipients were updated. + The write-axis sharing mode before the change: `owner`, `users`, or `org`. + + - `previous_write_user_count: optional number or null` + + The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`. + + - `type: optional "claude_artifact_sharing_updated"` + + default: claude_artifact_sharing_updated + + - `ClaudeArtifactViewed object` + + An artifact was viewed. - `actor: object or object or object or 8 more` @@ -8630,13 +8471,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_artifact_id: string` + + The artifact's identifier. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cc_email_count: optional number or null` + - `claude_artifact_version_id: optional string or null` - Number of 'cc' email recipients. + The version of the artifact the user was served, when known. - `created_at: optional string` @@ -8652,21 +8497,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `primary_email_set: optional boolean or null` - - Whether a primary billing email is configured. - - - `to_email_count: optional number or null` - - Number of 'to' email recipients. - - - `type: optional "billing_emails_updated"` + - `type: optional "claude_artifact_viewed"` - default: billing_emails_updated + default: claude_artifact_viewed - - `CcrAgentCreated object` + - `AuditLogExportAccessed object` - A Claude Code agent was created. + Audit log export file was accessed/downloaded via signed URL. - `actor: object or object or object or 8 more` @@ -8879,26 +8716,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was created, e.g. "cagt_01HX...". - - - `default_source_urls_truncated: boolean` - - Whether default_source_urls was capped and omits some of the granted repositories. - - - `display_name: string` - - The agent's display name at creation time. - - - `omitted_source_url_count: number` - - Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. - - - `slug: string` - - The agent's URL-safe identifier, unique within the organization. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -8909,14 +8726,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_source_urls: optional array of string` - - The repository URLs the agent works on by default, reduced to scheme, host, and path — credentials and query parameters are never included. Empty with a zero omitted_source_url_count means the agent was created without any default repositories; empty with a non-zero count means repositories were granted but could not be safely rendered. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - - - `guest_policy: optional string or null` - - Whether the agent responds in Slack channels that include guest users: "allow", "restrict", or "channel" (the agent responds, using only that channel's own content and configuration). Omitted when the agent inherits the default policy. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -8925,17 +8734,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `slack_alias: optional string or null` - - The Slack trigger word that routes mentions to this agent. An empty value means the agent responds to bare "@Claude" mentions. Omitted when the agent is not addressable from Slack. - - - `type: optional "ccr_agent_created"` + - `type: optional "audit_log_export_accessed"` - default: ccr_agent_created + default: audit_log_export_accessed - - `CcrAgentDeleted object` + - `AuditLogExportStarted object` - A Claude Code agent was deleted. + Audit log export was initiated. - `actor: object or object or object or 8 more` @@ -9148,32 +8953,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was deleted, e.g. "cagt_01HX...". - - - `cascaded_agent_ids_truncated: boolean` - - True when more agents were deleted in this cascade than are individually recorded. On a cascade parent event (cascaded_from_agent_id unset), cascaded_agent_ids is capped at 100. On a cascade child event (cascaded_from_agent_id set, emitted when the parent deletion failed after committing child deletions), one event is emitted per deleted child up to 100, and this field indicates additional children were deleted in the same cascade. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascaded_agent_ids: optional array of string` - - Agents assigned to individual Slack channels that were also deleted because agent_id was the agent assigned to their entire Slack workspace. Empty when no such agents were deleted, and always empty on a cascade child event (cascaded_from_agent_id set) — the child's siblings are recorded as their own events, not listed here. Capped at 100 entries; cascaded_agent_ids_truncated is set when the actual count exceeded the cap. - - - `cascaded_from_agent_id: optional string or null` - - When set, the Slack workspace's dedicated agent whose deletion attempt caused this agent to be deleted. The parent's own deletion may have failed after the cascade committed — check for a separate event with agent_id = cascaded_from_agent_id to confirm. Unset on a direct deletion. - - `created_at: optional string` When this activity occurred. format: date-time + - `from_date: optional string or null` + + Start date of the export range + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -9182,13 +8975,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_deleted"` + - `to_date: optional string or null` - default: ccr_agent_deleted + End date of the export range - - `CcrAgentProxyCredentialCreated object` + - `type: optional "audit_log_export_started"` - A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself. + default: audit_log_export_started + + - `BillingEmailsUpdated object` + + The organization's billing email recipients were updated. - `actor: object or object or object or 8 more` @@ -9401,57 +9198,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential that was created, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - - - `display_name: string` - - The credential's display name. - - - `host_constraint_truncated: boolean` - - Whether host_constraint was capped and omits some of the configured host name patterns. - - - `profile_id: string` - - The agent proxy profile the credential belongs to, e.g. "capp_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `authorization_basis: optional object or null` - - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - - - `slack_channel_id: string` - - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - - - `slack_enterprise_id: string` - - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. - - - `slack_team_id: string` - - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". - - - `via_entitlement_leg: boolean` - - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. - - - `via_full_manage: boolean` - - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. - - - `granting_role_ids: optional array of string` + - `cc_email_count: optional number or null` - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + Number of 'cc' email recipients. - `created_at: optional string` @@ -9459,10 +9212,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `host_constraint: optional array of string` - - The host name patterns the credential may be sent to, e.g. "api.example.com" or "*.example.com". At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -9471,13 +9220,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_created"` + - `primary_email_set: optional boolean or null` - default: ccr_agent_proxy_credential_created + Whether a primary billing email is configured. - - `CcrAgentProxyCredentialDeleted object` + - `to_email_count: optional number or null` - A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host. + Number of 'to' email recipients. + + - `type: optional "billing_emails_updated"` + + default: billing_emails_updated + + - `CcrAgentCreated object` + + A Claude Code agent was created. - `actor: object or object or object or 8 more` @@ -9690,51 +9447,43 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential that was deleted, e.g. "apc_01HX...". - - - `profile_id: string` - - The agent proxy profile the credential belonged to, e.g. "capp_01HX...". Carried so the deletion can be correlated with the profile's other audit events after the credential row no longer exists. - - - `id: optional string` + - `agent_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The agent that was created, e.g. "cagt_01HX...". - - `authorization_basis: optional object or null` + - `default_source_urls_truncated: boolean` - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + Whether default_source_urls was capped and omits some of the granted repositories. - - `slack_channel_id: string` + - `display_name: string` - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + The agent's display name at creation time. - - `slack_enterprise_id: string` + - `omitted_source_url_count: number` - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. - - `slack_team_id: string` + - `slug: string` - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + The agent's URL-safe identifier, unique within the organization. - - `via_entitlement_leg: boolean` + - `id: optional string` - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `via_full_manage: boolean` + - `created_at: optional string` - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + When this activity occurred. - - `granting_role_ids: optional array of string` + format: date-time - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + - `default_source_urls: optional array of string` - - `created_at: optional string` + The repository URLs the agent works on by default, reduced to scheme, host, and path — credentials and query parameters are never included. Empty with a zero omitted_source_url_count means the agent was created without any default repositories; empty with a non-zero count means repositories were granted but could not be safely rendered. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - When this activity occurred. + - `guest_policy: optional string or null` - format: date-time + Whether the agent responds in Slack channels that include guest users, and in Slack Connect channels shared with other organizations: "allow", "restrict", or "channel" (the agent responds, using only that channel's own content and configuration). In Slack Connect channels "allow" gives at most "channel" access. Omitted when the agent inherits the default policy. - `organization_id: optional string or null` @@ -9744,13 +9493,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_deleted"` + - `slack_alias: optional string or null` - default: ccr_agent_proxy_credential_deleted + The Slack trigger word that routes mentions to this agent. An empty value means the agent responds to bare "@Claude" mentions. Omitted when the agent is not addressable from Slack. - - `CcrAgentProxyCredentialRotated object` + - `type: optional "ccr_agent_created"` - A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement. + default: ccr_agent_created + + - `CcrAgentDeleted object` + + A Claude Code agent was deleted. - `actor: object or object or object or 8 more` @@ -9963,65 +9716,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The replacement credential, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - - - `destinations_repointed: number` - - The number of agent proxy destinations that referenced the old credential and now reference the replacement. - - - `display_name: string` - - The credential's display name. - - - `previous_credential_id: string` - - The credential that was replaced, e.g. "apc_01HX...". - - - `profile_id: string` + - `agent_id: string` - The agent proxy profile the credential belongs to, e.g. "capp_01HX...". + The agent that was deleted, e.g. "cagt_01HX...". - - `rules_repointed: number` + - `cascaded_agent_ids_truncated: boolean` - The number of agent proxy rules that referenced the old credential and now reference the replacement. + True when more agents were deleted in this cascade than are individually recorded. On a cascade parent event (cascaded_from_agent_id unset), cascaded_agent_ids is capped at 100. On a cascade child event (cascaded_from_agent_id set, emitted when the parent deletion failed after committing child deletions), one event is emitted per deleted child up to 100, and this field indicates additional children were deleted in the same cascade. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `authorization_basis: optional object or null` - - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - - - `slack_channel_id: string` - - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - - - `slack_enterprise_id: string` - - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. - - - `slack_team_id: string` - - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". - - - `via_entitlement_leg: boolean` - - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. - - - `via_full_manage: boolean` + - `cascaded_agent_ids: optional array of string` - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + Agents assigned to individual Slack channels that were also deleted because agent_id was the agent assigned to their entire Slack workspace. Empty when no such agents were deleted, and always empty on a cascade child event (cascaded_from_agent_id set) — the child's siblings are recorded as their own events, not listed here. Capped at 100 entries; cascaded_agent_ids_truncated is set when the actual count exceeded the cap. - - `granting_role_ids: optional array of string` + - `cascaded_from_agent_id: optional string or null` - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + When set, the Slack workspace's dedicated agent whose deletion attempt caused this agent to be deleted. The parent's own deletion may have failed after the cascade committed — check for a separate event with agent_id = cascaded_from_agent_id to confirm. Unset on a direct deletion. - `created_at: optional string` @@ -10037,13 +9750,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_rotated"` + - `type: optional "ccr_agent_deleted"` - default: ccr_agent_proxy_credential_rotated + default: ccr_agent_deleted - - `CcrAgentProxyCredentialUpdated object` + - `CcrAgentProxyCredentialCreated object` - A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation. + A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself. - `actor: object or object or object or 8 more` @@ -10258,11 +9971,15 @@ compliance activities that can be filtered by various criteria. - `credential_id: string` - The credential that was updated, e.g. "apc_01HX...". + The credential that was created, e.g. "apc_01HX...". + + - `credential_type: string` + + The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - `display_name: string` - The credential's display name after the update. + The credential's display name. - `host_constraint_truncated: boolean` @@ -10312,7 +10029,7 @@ compliance activities that can be filtered by various criteria. - `host_constraint: optional array of string` - The host name patterns the credential may be sent to after the update, e.g. "api.example.com" or "*.example.com". Populated only when the update changed them. At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. + The host name patterns the credential may be sent to, e.g. "api.example.com" or "*.example.com". At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. - `organization_id: optional string or null` @@ -10322,17 +10039,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_updated"` - - default: ccr_agent_proxy_credential_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_proxy_credential_created"` - Names of the settings included in the update: "display_name", "host_constraint". + default: ccr_agent_proxy_credential_created - - `CcrAgentProxyDestinationDeleted object` + - `CcrAgentProxyCredentialDeleted object` - An agent proxy destination was deleted. + A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host. - `actor: object or object or object or 8 more` @@ -10545,25 +10258,45 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_with_profile: boolean` - - True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyDestination call. - - - `destination_id: string` + - `credential_id: string` - The destination that was deleted, e.g. "apd_01HX...". + The credential that was deleted, e.g. "apc_01HX...". - `profile_id: string` - The agent proxy profile the destination belonged to, e.g. "capp_01HX...". + The agent proxy profile the credential belonged to, e.g. "capp_01HX...". Carried so the deletion can be correlated with the profile's other audit events after the credential row no longer exists. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascade_trigger_credential_id: optional string or null` + - `authorization_basis: optional object or null` - Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the destination's client_tls_credential was the deleted credential). Unset for a direct DeleteAgentProxyDestination call and for the profile-delete cascade (see deleted_with_profile). + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + + - `slack_channel_id: string` + + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). - `created_at: optional string` @@ -10579,13 +10312,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_destination_deleted"` + - `type: optional "ccr_agent_proxy_credential_deleted"` - default: ccr_agent_proxy_destination_deleted + default: ccr_agent_proxy_credential_deleted - - `CcrAgentProxyNetworkEventsListed object` + - `CcrAgentProxyCredentialRotated object` - A Claude Code network activity export was accessed for the given hour. + A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement. - `actor: object or object or object or 8 more` @@ -10798,23 +10531,69 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `failed: boolean` + - `credential_id: string` - True when the export request did not complete successfully. + The replacement credential, e.g. "apc_01HX...". + + - `credential_type: string` + + The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". + + - `destinations_repointed: number` + + The number of agent proxy destinations that referenced the old credential and now reference the replacement. + + - `display_name: string` + + The credential's display name. + + - `previous_credential_id: string` + + The credential that was replaced, e.g. "apc_01HX...". + + - `profile_id: string` + + The agent proxy profile the credential belongs to, e.g. "capp_01HX...". + + - `rules_repointed: number` + + The number of agent proxy rules that referenced the old credential and now reference the replacement. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `created_at: optional string` + - `authorization_basis: optional object or null` - When this activity occurred. + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - format: date-time + - `slack_channel_id: string` - - `hour: optional string or null` + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - The UTC hour that was exported. + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + + - `created_at: optional string` + + When this activity occurred. format: date-time @@ -10826,13 +10605,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_network_events_listed"` + - `type: optional "ccr_agent_proxy_credential_rotated"` - default: ccr_agent_proxy_network_events_listed + default: ccr_agent_proxy_credential_rotated - - `CcrAgentProxyProfileBound object` + - `CcrAgentProxyCredentialUpdated object` - A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope. + A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation. - `actor: object or object or object or 8 more` @@ -11045,28 +10824,64 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `profile_id: string` + - `credential_id: string` - The profile that was bound, e.g. "capp_01HX...". + The credential that was updated, e.g. "apc_01HX...". - - `scope_id: string` + - `display_name: string` - The identifier of the scope the profile was bound to. + The credential's display name after the update. - - `scope_kind: string` + - `host_constraint_truncated: boolean` - The kind of scope the profile was bound to: "organization", "environment", "account", or "agent". + Whether host_constraint was capped and omits some of the configured host name patterns. + + - `profile_id: string` + + The agent proxy profile the credential belongs to, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `authorization_basis: optional object or null` + + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + + - `slack_channel_id: string` + + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + - `created_at: optional string` When this activity occurred. format: date-time + - `host_constraint: optional array of string` + + The host name patterns the credential may be sent to after the update, e.g. "api.example.com" or "*.example.com". Populated only when the update changed them. At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11075,13 +10890,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_bound"` + - `type: optional "ccr_agent_proxy_credential_updated"` - default: ccr_agent_proxy_profile_bound + default: ccr_agent_proxy_credential_updated - - `CcrAgentProxyProfileCreated object` + - `updated_fields: optional array of string` - A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization. + Names of the settings included in the update: "display_name", "host_constraint". + + - `CcrAgentProxyDestinationDeleted object` + + An agent proxy destination was deleted. - `actor: object or object or object or 8 more` @@ -11294,60 +11113,32 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` + - `deleted_with_profile: boolean` - The profile's display name at creation time. + True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyDestination call. - - `profile_id: string` + - `destination_id: string` - The profile that was created, e.g. "capp_01HX...". + The destination that was deleted, e.g. "apd_01HX...". - - `slug: string` + - `profile_id: string` - The profile's URL-safe identifier, unique within the organization. + The agent proxy profile the destination belonged to, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `cascade_trigger_credential_id: optional string or null` + + Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the destination's client_tls_credential was the deleted credential). Unset for a direct DeleteAgentProxyDestination call and for the profile-delete cascade (see deleted_with_profile). + - `created_at: optional string` When this activity occurred. format: date-time - - `github_access: optional array of object` - - The GitHub repository access the profile grants, one entry per GitHub App installation. Empty when the profile grants no GitHub access. - - - `access_mode: string` - - How repository access is granted: "none" (no access), "list" (exactly the repositories in repos), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. - - - `github_installation_id: number` - - The GitHub App installation the access applies to. - - - `repo_count: number` - - The total number of repositories granted, including any omitted from repos. - - - `repos_truncated: boolean` - - Whether repos was capped and omits some of the granted repositories. - - - `ghe_configuration_id: optional number or null` - - The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. - - - `repo_ids: optional array of number` - - The numeric GitHub repository IDs the profile grants access to, in the same order as repos (and subject to the same 100-entry cap). These IDs are the authoritative identity of the granted repositories — access is enforced against them, not against the display names in repos. - - - `repos: optional array of string` - - Repository names (owner/name) the profile grants access to, populated when access_mode is "list". Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids are the authoritative identity of the granted repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when the granted set is larger. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11356,13 +11147,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_created"` + - `type: optional "ccr_agent_proxy_destination_deleted"` - default: ccr_agent_proxy_profile_created + default: ccr_agent_proxy_destination_deleted - - `CcrAgentProxyProfileDeleted object` + - `CcrAgentProxyNetworkEventsListed object` - A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to. + A Claude Code network activity export was accessed for the given hour. - `actor: object or object or object or 8 more` @@ -11575,33 +11366,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_credential_count: number` - - Number of credentials deleted together with the profile — deleting a profile also deletes the credentials attached to it. Each deleted credential additionally emits its own ccr_agent_proxy_credential_deleted activity, at most 100 per profile deletion. Best-effort: when deleted_credentials_unknown is true the count could not be determined and 0 here does not mean the profile had no credentials. - - - `deleted_credentials_unknown: boolean` - - Whether the number of credentials deleted with the profile could not be determined. When true, deleted_credential_count is 0 and no per-credential deletion activities were emitted, even though the deletion may have destroyed credentials. - - - `deleted_destination_count: number` - - Number of destinations deleted together with the profile. Each deleted destination additionally emits its own ccr_agent_proxy_destination_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_destinations_unknown is true the count could not be determined and 0 here does not mean the profile had no destinations. - - - `deleted_destinations_unknown: boolean` - - Whether the number of destinations deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - - `deleted_rule_count: number` - - Number of rules deleted together with the profile. Each deleted rule additionally emits its own ccr_agent_proxy_rule_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_rules_unknown is true the count could not be determined and 0 here does not mean the profile had no rules. - - - `deleted_rules_unknown: boolean` - - Whether the number of rules deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - - `profile_id: string` + - `failed: boolean` - The profile that was deleted, e.g. "capp_01HX...". + True when the export request did not complete successfully. - `id: optional string` @@ -11613,6 +11380,12 @@ compliance activities that can be filtered by various criteria. format: date-time + - `hour: optional string or null` + + The UTC hour that was exported. + + format: date-time + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11621,13 +11394,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_deleted"` + - `type: optional "ccr_agent_proxy_network_events_listed"` - default: ccr_agent_proxy_profile_deleted + default: ccr_agent_proxy_network_events_listed - - `CcrAgentProxyProfileUnbound object` + - `CcrAgentProxyProfileBound object` - A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope. + A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope. - `actor: object or object or object or 8 more` @@ -11842,15 +11615,15 @@ compliance activities that can be filtered by various criteria. - `profile_id: string` - The profile that was unbound, e.g. "capp_01HX...". + The profile that was bound, e.g. "capp_01HX...". - `scope_id: string` - The identifier of the scope the profile was unbound from. + The identifier of the scope the profile was bound to. - `scope_kind: string` - The kind of scope the profile was unbound from: "organization", "environment", "account", or "agent". + The kind of scope the profile was bound to: "organization", "environment", "account", or "agent". - `id: optional string` @@ -11870,13 +11643,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_unbound"` + - `type: optional "ccr_agent_proxy_profile_bound"` - default: ccr_agent_proxy_profile_unbound + default: ccr_agent_proxy_profile_bound - - `CcrAgentProxyProfileUpdated object` + - `CcrAgentProxyProfileCreated object` - A Claude Code agent proxy profile's configuration was updated. + A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization. - `actor: object or object or object or 8 more` @@ -12089,9 +11862,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `display_name: string` + + The profile's display name at creation time. + - `profile_id: string` - The profile that was updated, e.g. "capp_01HX...". + The profile that was created, e.g. "capp_01HX...". + + - `slug: string` + + The profile's URL-safe identifier, unique within the organization. - `id: optional string` @@ -12103,49 +11884,37 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_access_changes: optional array of object` + - `github_access: optional array of object` - How the profile's GitHub repository access changed, one entry per GitHub App installation whose access changed. Empty when the update did not change GitHub access. + The GitHub repository access the profile grants, one entry per GitHub App installation. Empty when the profile grants no GitHub access. - `access_mode: string` - How repository access is granted after the change: "none" (no access), "list" (access is restricted to an explicit repository list — repos_added/repos_removed carry this change's delta and repo_count the post-change total), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. + How repository access is granted: "none" (no access), "list" (exactly the repositories in repos), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. - `github_installation_id: number` - The GitHub App installation the change applies to. + The GitHub App installation the access applies to. - `repo_count: number` - The total number of repositories granted after the change. + The total number of repositories granted, including any omitted from repos. - `repos_truncated: boolean` - Whether repos_added or repos_removed was capped and omits some of the changed repositories. + Whether repos was capped and omits some of the granted repositories. - `ghe_configuration_id: optional number or null` The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. - - `previous_access_mode: optional string or null` - - How repository access was granted before the change. Present only when the access mode changed. - - - `repo_ids_added: optional array of number` - - The numeric GitHub repository IDs added to the granted set, in the same order as repos_added (and subject to the same 100-entry cap). These IDs are the authoritative identity of the added repositories — access is enforced against them, not against the display names in repos_added. - - - `repo_ids_removed: optional array of number` - - The numeric GitHub repository IDs removed from the granted set, in the same order as repos_removed (and subject to the same 100-entry cap). These IDs are the authoritative identity of the removed repositories. - - - `repos_added: optional array of string` + - `repo_ids: optional array of number` - Repository names (owner/name) added to the granted set. Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids_added are the authoritative identity of the added repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when more were added. Empty when the change involves "all" access, which grants every repository regardless of any explicit list. + The numeric GitHub repository IDs the profile grants access to, in the same order as repos (and subject to the same 100-entry cap). These IDs are the authoritative identity of the granted repositories — access is enforced against them, not against the display names in repos. - - `repos_removed: optional array of string` + - `repos: optional array of string` - Repository names (owner/name) removed from the granted set. Same rendering, cap, and "all" handling as repos_added; repo_ids_removed carries the authoritative identity of the removed repositories. + Repository names (owner/name) the profile grants access to, populated when access_mode is "list". Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids are the authoritative identity of the granted repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when the granted set is larger. - `organization_id: optional string or null` @@ -12155,17 +11924,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_updated"` - - default: ccr_agent_proxy_profile_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_proxy_profile_created"` - Names of the configuration fields included in the update, e.g. "display_name", "github_installation_permissions". + default: ccr_agent_proxy_profile_created - - `CcrAgentProxyProvisioningCredentialRejected object` + - `CcrAgentProxyProfileDeleted object` - An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution. + A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to. - `actor: object or object or object or 8 more` @@ -12378,25 +12143,33 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` + - `deleted_credential_count: number` - The credential the member submitted, e.g. "apc_01HX...". + Number of credentials deleted together with the profile — deleting a profile also deletes the credentials attached to it. Each deleted credential additionally emits its own ccr_agent_proxy_credential_deleted activity, at most 100 per profile deletion. Best-effort: when deleted_credentials_unknown is true the count could not be determined and 0 here does not mean the profile had no credentials. - - `link_id: string` + - `deleted_credentials_unknown: boolean` - The provisioning link's identifier. + Whether the number of credentials deleted with the profile could not be determined. When true, deleted_credential_count is 0 and no per-credential deletion activities were emitted, even though the deletion may have destroyed credentials. - - `profile_id: string` + - `deleted_destination_count: number` - The agent proxy profile the credential lived in, e.g. "capp_01HX...". + Number of destinations deleted together with the profile. Each deleted destination additionally emits its own ccr_agent_proxy_destination_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_destinations_unknown is true the count could not be determined and 0 here does not mean the profile had no destinations. - - `rule_id: string` + - `deleted_destinations_unknown: boolean` - The disabled rule that was deleted alongside the credential, e.g. "apr_01HX...". + Whether the number of destinations deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - `submitted_by_user_id: string` + - `deleted_rule_count: number` - The tagged account ID of the user who originally submitted the credential, e.g. "user_01HX...". + Number of rules deleted together with the profile. Each deleted rule additionally emits its own ccr_agent_proxy_rule_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_rules_unknown is true the count could not be determined and 0 here does not mean the profile had no rules. + + - `deleted_rules_unknown: boolean` + + Whether the number of rules deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. + + - `profile_id: string` + + The profile that was deleted, e.g. "capp_01HX...". - `id: optional string` @@ -12416,13 +12189,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_credential_rejected"` + - `type: optional "ccr_agent_proxy_profile_deleted"` - default: ccr_agent_proxy_provisioning_credential_rejected + default: ccr_agent_proxy_profile_deleted - - `CcrAgentProxyProvisioningLinkEnabled object` + - `CcrAgentProxyProfileUnbound object` - An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event. + A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope. - `actor: object or object or object or 8 more` @@ -12635,21 +12408,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential the member submitted, e.g. "apc_01HX...". - - - `link_id: string` + - `profile_id: string` - The provisioning link's identifier. + The profile that was unbound, e.g. "capp_01HX...". - - `profile_id: string` + - `scope_id: string` - The agent proxy profile the credential lives in, e.g. "capp_01HX...". + The identifier of the scope the profile was unbound from. - - `rule_id: string` + - `scope_kind: string` - The rule that was flipped to enforce, e.g. "apr_01HX...". + The kind of scope the profile was unbound from: "organization", "environment", "account", or "agent". - `id: optional string` @@ -12669,13 +12438,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_enabled"` + - `type: optional "ccr_agent_proxy_profile_unbound"` - default: ccr_agent_proxy_provisioning_link_enabled + default: ccr_agent_proxy_profile_unbound - - `CcrAgentProxyProvisioningLinkGenerated object` + - `CcrAgentProxyProfileUpdated object` - An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role. + A Claude Code agent proxy profile's configuration was updated. - `actor: object or object or object or 8 more` @@ -12888,13 +12657,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `link_id: string` - - The provisioning link's identifier. Correlation only; redemption requires an org-member session, so this is not a bearer credential. - - `profile_id: string` - The agent proxy profile the submitted credential will be created in, e.g. "capp_01HX...". + The profile that was updated, e.g. "capp_01HX...". - `id: optional string` @@ -12906,6 +12671,50 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_access_changes: optional array of object` + + How the profile's GitHub repository access changed, one entry per GitHub App installation whose access changed. Empty when the update did not change GitHub access. + + - `access_mode: string` + + How repository access is granted after the change: "none" (no access), "list" (access is restricted to an explicit repository list — repos_added/repos_removed carry this change's delta and repo_count the post-change total), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. + + - `github_installation_id: number` + + The GitHub App installation the change applies to. + + - `repo_count: number` + + The total number of repositories granted after the change. + + - `repos_truncated: boolean` + + Whether repos_added or repos_removed was capped and omits some of the changed repositories. + + - `ghe_configuration_id: optional number or null` + + The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. + + - `previous_access_mode: optional string or null` + + How repository access was granted before the change. Present only when the access mode changed. + + - `repo_ids_added: optional array of number` + + The numeric GitHub repository IDs added to the granted set, in the same order as repos_added (and subject to the same 100-entry cap). These IDs are the authoritative identity of the added repositories — access is enforced against them, not against the display names in repos_added. + + - `repo_ids_removed: optional array of number` + + The numeric GitHub repository IDs removed from the granted set, in the same order as repos_removed (and subject to the same 100-entry cap). These IDs are the authoritative identity of the removed repositories. + + - `repos_added: optional array of string` + + Repository names (owner/name) added to the granted set. Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids_added are the authoritative identity of the added repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when more were added. Empty when the change involves "all" access, which grants every repository regardless of any explicit list. + + - `repos_removed: optional array of string` + + Repository names (owner/name) removed from the granted set. Same rendering, cap, and "all" handling as repos_added; repo_ids_removed carries the authoritative identity of the removed repositories. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -12914,13 +12723,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_generated"` + - `type: optional "ccr_agent_proxy_profile_updated"` - default: ccr_agent_proxy_provisioning_link_generated + default: ccr_agent_proxy_profile_updated - - `CcrAgentProxyProvisioningLinkRevoked object` + - `updated_fields: optional array of string` - An organization owner revoked an unfilled agent proxy provisioning link. + Names of the configuration fields included in the update, e.g. "display_name", "github_installation_permissions". + + - `CcrAgentProxyProvisioningCredentialRejected object` + + An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution. - `actor: object or object or object or 8 more` @@ -13133,13 +12946,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `credential_id: string` + + The credential the member submitted, e.g. "apc_01HX...". + - `link_id: string` The provisioning link's identifier. - `profile_id: string` - The agent proxy profile the link targeted, e.g. "capp_01HX...". + The agent proxy profile the credential lived in, e.g. "capp_01HX...". + + - `rule_id: string` + + The disabled rule that was deleted alongside the credential, e.g. "apr_01HX...". + + - `submitted_by_user_id: string` + + The tagged account ID of the user who originally submitted the credential, e.g. "user_01HX...". - `id: optional string` @@ -13159,13 +12984,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_revoked"` + - `type: optional "ccr_agent_proxy_provisioning_credential_rejected"` - default: ccr_agent_proxy_provisioning_link_revoked + default: ccr_agent_proxy_provisioning_credential_rejected - - `CcrAgentProxyProvisioningLinkSubmitted object` + - `CcrAgentProxyProvisioningLinkEnabled object` - A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created. + An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event. - `actor: object or object or object or 8 more` @@ -13380,11 +13205,7 @@ compliance activities that can be filtered by various criteria. - `credential_id: string` - The credential that was created, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer" or "basic". + The credential the member submitted, e.g. "apc_01HX...". - `link_id: string` @@ -13392,7 +13213,11 @@ compliance activities that can be filtered by various criteria. - `profile_id: string` - The agent proxy profile the credential was created in, e.g. "capp_01HX...". + The agent proxy profile the credential lives in, e.g. "capp_01HX...". + + - `rule_id: string` + + The rule that was flipped to enforce, e.g. "apr_01HX...". - `id: optional string` @@ -13404,10 +13229,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `host_constraint: optional array of string` - - The host name patterns the credential may be sent to. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -13416,13 +13237,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_submitted"` + - `type: optional "ccr_agent_proxy_provisioning_link_enabled"` - default: ccr_agent_proxy_provisioning_link_submitted + default: ccr_agent_proxy_provisioning_link_enabled - - `CcrAgentProxyRuleDeleted object` + - `CcrAgentProxyProvisioningLinkGenerated object` - An agent proxy rule was deleted. + An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role. - `actor: object or object or object or 8 more` @@ -13635,26 +13456,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_with_profile: boolean` + - `link_id: string` - True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyRule call or a provisioning-link reject (RejectAgentProxyProvisionedCredential) — the reject case also emits CcrAgentProxyProvisioningCredentialRejected with the same rule_id in the same batch. + The provisioning link's identifier. Correlation only; redemption requires an org-member session, so this is not a bearer credential. - `profile_id: string` - The agent proxy profile the rule belonged to, e.g. "capp_01HX...". - - - `rule_id: string` - - The rule that was deleted, e.g. "apr_01HX...". + The agent proxy profile the submitted credential will be created in, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascade_trigger_credential_id: optional string or null` - - Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the rule inject_credential-referenced the deleted credential). Unset for a direct DeleteAgentProxyRule call, for the profile-delete cascade (see deleted_with_profile), and for a provisioning-link reject that removed the provisioned rule. - - `created_at: optional string` When this activity occurred. @@ -13669,13 +13482,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_rule_deleted"` + - `type: optional "ccr_agent_proxy_provisioning_link_generated"` - default: ccr_agent_proxy_rule_deleted + default: ccr_agent_proxy_provisioning_link_generated - - `CcrAgentSlackAccessScopeCreated object` + - `CcrAgentProxyProvisioningLinkRevoked object` - A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to. + An organization owner revoked an unfilled agent proxy provisioning link. - `actor: object or object or object or 8 more` @@ -13888,21 +13701,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was granted access, e.g. "cagt_01HX...". - - - `can_write: boolean` - - Whether the grant includes permission to post messages in the channel, in addition to reading it. - - - `slack_channel_id: string` + - `link_id: string` - The Slack channel the agent was granted access to, e.g. "C01ABC...". Empty when the grant covers the entire workspace. + The provisioning link's identifier. - - `slack_team_id: string` + - `profile_id: string` - The Slack workspace containing the channel, e.g. "T01ABC...". + The agent proxy profile the link targeted, e.g. "capp_01HX...". - `id: optional string` @@ -13922,13 +13727,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_access_scope_created"` + - `type: optional "ccr_agent_proxy_provisioning_link_revoked"` - default: ccr_agent_slack_access_scope_created + default: ccr_agent_proxy_provisioning_link_revoked - - `CcrAgentSlackAccessScopeDeleted object` + - `CcrAgentProxyProvisioningLinkSubmitted object` - A Claude Code agent's access to an additional Slack channel was revoked. + A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created. - `actor: object or object or object or 8 more` @@ -14141,17 +13946,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `credential_id: string` - The agent whose access was revoked, e.g. "cagt_01HX...". + The credential that was created, e.g. "apc_01HX...". - - `slack_channel_id: string` + - `credential_type: string` - The Slack channel the agent's access was revoked from, e.g. "C01ABC...". Empty when the revoked grant covered the entire workspace. + The kind of credential, e.g. "bearer" or "basic". - - `slack_team_id: string` + - `link_id: string` - The Slack workspace containing the channel, e.g. "T01ABC...". + The provisioning link's identifier. + + - `profile_id: string` + + The agent proxy profile the credential was created in, e.g. "capp_01HX...". - `id: optional string` @@ -14163,6 +13972,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `host_constraint: optional array of string` + + The host name patterns the credential may be sent to. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -14171,13 +13984,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_access_scope_deleted"` + - `type: optional "ccr_agent_proxy_provisioning_link_submitted"` - default: ccr_agent_slack_access_scope_deleted + default: ccr_agent_proxy_provisioning_link_submitted - - `CcrAgentSlackBindingCreated object` + - `CcrAgentProxyRuleDeleted object` - A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent. + An agent proxy rule was deleted. - `actor: object or object or object or 8 more` @@ -14390,22 +14203,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deleted_with_profile: boolean` - The agent the binding was created for, e.g. "cagt_01HX...". + True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyRule call or a provisioning-link reject (RejectAgentProxyProvisionedCredential) — the reject case also emits CcrAgentProxyProvisioningCredentialRejected with the same rule_id in the same batch. - - `slack_channel_id: string` + - `profile_id: string` - The Slack channel the agent was assigned to, e.g. "C01ABC...". Empty when the agent was assigned to the entire workspace. + The agent proxy profile the rule belonged to, e.g. "capp_01HX...". - - `slack_team_id: string` + - `rule_id: string` - The Slack workspace the agent was assigned to, e.g. "T01ABC...". + The rule that was deleted, e.g. "apr_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `cascade_trigger_credential_id: optional string or null` + + Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the rule inject_credential-referenced the deleted credential). Unset for a direct DeleteAgentProxyRule call, for the profile-delete cascade (see deleted_with_profile), and for a provisioning-link reject that removed the provisioned rule. + - `created_at: optional string` When this activity occurred. @@ -14420,13 +14237,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_binding_created"` + - `type: optional "ccr_agent_proxy_rule_deleted"` - default: ccr_agent_slack_binding_created + default: ccr_agent_proxy_rule_deleted - - `CcrAgentSlackBindingDeleted object` + - `CcrAgentSlackAccessScopeCreated object` - A Claude Code agent's assignment to a Slack channel or workspace was removed. + A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to. - `actor: object or object or object or 8 more` @@ -14641,15 +14458,19 @@ compliance activities that can be filtered by various criteria. - `agent_id: string` - The agent the binding was removed from, e.g. "cagt_01HX...". + The agent that was granted access, e.g. "cagt_01HX...". + + - `can_write: boolean` + + Whether the grant includes permission to post messages in the channel, in addition to reading it. - `slack_channel_id: string` - The Slack channel the agent was unassigned from, e.g. "C01ABC...". Empty when the assignment covered the entire workspace. + The Slack channel the agent was granted access to, e.g. "C01ABC...". Empty when the grant covers the entire workspace. - `slack_team_id: string` - The Slack workspace the agent was unassigned from, e.g. "T01ABC...". + The Slack workspace containing the channel, e.g. "T01ABC...". - `id: optional string` @@ -14669,13 +14490,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_binding_deleted"` + - `type: optional "ccr_agent_slack_access_scope_created"` - default: ccr_agent_slack_binding_deleted + default: ccr_agent_slack_access_scope_created - - `CcrAgentUpdated object` + - `CcrAgentSlackAccessScopeDeleted object` - A Claude Code agent's configuration was updated. Also emitted with updated_fields ["is_virtual"] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it. + A Claude Code agent's access to an additional Slack channel was revoked. - `actor: object or object or object or 8 more` @@ -14890,15 +14711,15 @@ compliance activities that can be filtered by various criteria. - `agent_id: string` - The agent that was updated, e.g. "cagt_01HX...". + The agent whose access was revoked, e.g. "cagt_01HX...". - - `default_source_urls_truncated: boolean` + - `slack_channel_id: string` - Whether default_source_urls was capped and omits some of the granted repositories. + The Slack channel the agent's access was revoked from, e.g. "C01ABC...". Empty when the revoked grant covered the entire workspace. - - `omitted_source_url_count: number` + - `slack_team_id: string` - Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. + The Slack workspace containing the channel, e.g. "T01ABC...". - `id: optional string` @@ -14910,14 +14731,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_source_urls: optional array of string` - - The agent's default repository URLs after the update, reduced to scheme, host, and path — credentials and query parameters are never included. Populated only when the update changed them — "default_source_urls" appears in updated_fields. Empty while listed in updated_fields AND omitted_source_url_count is 0 means all default repositories were removed. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - - - `guest_policy: optional string or null` - - The agent's guest-user response policy after the update: "allow", "restrict", "channel" (the agent responds, using only that channel's own content and configuration), or "default" when the update removed the agent-specific policy so the agent inherits the surrounding default. Present only when the update changed it. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -14926,21 +14739,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `slack_alias: optional string or null` - - The agent's Slack trigger word after the update. Present only when the update changed it. An empty value means the agent responds to bare "@Claude" mentions. - - - `type: optional "ccr_agent_updated"` - - default: ccr_agent_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_slack_access_scope_deleted"` - Names of the configuration fields included in the update, e.g. "display_name", "system_prompt_addendum", "guest_policy". Includes "is_virtual" when this update was the first administrator action on an auto-provisioned agent — a durable state change even when no other field was supplied. + default: ccr_agent_slack_access_scope_deleted - - `CcrRoleChannelAssignmentDeleted object` + - `CcrAgentSlackBindingCreated object` - CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels). + A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent. - `actor: object or object or object or 8 more` @@ -15153,13 +14958,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `previous_channel_count: number` + - `agent_id: string` - Number of (team, channel) pairs the role was assigned before deletion. + The agent the binding was created for, e.g. "cagt_01HX...". - - `role_id: string` + - `slack_channel_id: string` - Tagged ID of the role whose channel assignment was removed. + The Slack channel the agent was assigned to, e.g. "C01ABC...". Empty when the agent was assigned to the entire workspace. + + - `slack_team_id: string` + + The Slack workspace the agent was assigned to, e.g. "T01ABC...". - `id: optional string` @@ -15179,13 +14988,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_role_channel_assignment_deleted"` + - `type: optional "ccr_agent_slack_binding_created"` - default: ccr_role_channel_assignment_deleted + default: ccr_agent_slack_binding_created - - `CcrRoleChannelAssignmentUpdated object` + - `CcrAgentSlackBindingDeleted object` - CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface. + A Claude Code agent's assignment to a Slack channel or workspace was removed. - `actor: object or object or object or 8 more` @@ -15398,26 +15207,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `channel_count: number` + - `agent_id: string` - Number of channels assigned after the write. + The agent the binding was removed from, e.g. "cagt_01HX...". - - `previous_channel_count: number` + - `slack_channel_id: string` - Number of channels assigned before the write. + The Slack channel the agent was unassigned from, e.g. "C01ABC...". Empty when the assignment covered the entire workspace. - - `role_id: string` + - `slack_team_id: string` - Tagged ID of the role whose channel assignment was written. + The Slack workspace the agent was unassigned from, e.g. "T01ABC...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `agent_ids: optional array of string` - - The channel-silo agents (cagt_...) assigned after the write. Capped at 100 entries; channel_count carries the uncapped total. - - `created_at: optional string` When this activity occurred. @@ -15432,13 +15237,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_role_channel_assignment_updated"` + - `type: optional "ccr_agent_slack_binding_deleted"` - default: ccr_role_channel_assignment_updated + default: ccr_agent_slack_binding_deleted - - `CcrSessionCreated object` + - `CcrAgentUpdated object` - A Claude Code session was created. A session is one coding interaction with Claude. + A Claude Code agent's configuration was updated. Also emitted with updated_fields ["is_virtual"] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it. - `actor: object or object or object or 8 more` @@ -15651,17 +15456,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `agent_id: string` - The session that was created, e.g. "cse_01HX...". + The agent that was updated, e.g. "cagt_01HX...". - - `id: optional string` + - `default_source_urls_truncated: boolean` - Unique identifier for the activity e.g. 'activity_abcd1234' + Whether default_source_urls was capped and omits some of the granted repositories. - - `agent_id: optional string or null` + - `omitted_source_url_count: number` - The Claude Code agent attached to the session, e.g. "cagt_01HX...". Omitted when the session was created without an agent. + Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -15669,6 +15478,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `default_source_urls: optional array of string` + + The agent's default repository URLs after the update, reduced to scheme, host, and path — credentials and query parameters are never included. Populated only when the update changed them — "default_source_urls" appears in updated_fields. Empty while listed in updated_fields AND omitted_source_url_count is 0 means all default repositories were removed. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. + + - `guest_policy: optional string or null` + + The agent's response policy for Slack channels that include guest users and Slack Connect channels shared with other organizations, after the update: "allow", "restrict", "channel" (the agent responds, using only that channel's own content and configuration), or "default" when the update removed the agent-specific policy so the agent inherits the surrounding default. In Slack Connect channels "allow" gives at most "channel" access. Present only when the update changed it. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -15677,13 +15494,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_created"` + - `slack_alias: optional string or null` - default: ccr_session_created + The agent's Slack trigger word after the update. Present only when the update changed it. An empty value means the agent responds to bare "@Claude" mentions. - - `CcrSessionDeleted object` + - `type: optional "ccr_agent_updated"` - A Claude Code session was deleted. + default: ccr_agent_updated + + - `updated_fields: optional array of string` + + Names of the configuration fields included in the update, e.g. "display_name", "system_prompt_addendum", "guest_policy". Includes "is_virtual" when this update was the first administrator action on an auto-provisioned agent — a durable state change even when no other field was supplied. + + - `CcrRoleChannelAssignmentDeleted object` + + CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels). - `actor: object or object or object or 8 more` @@ -15896,9 +15721,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `previous_channel_count: number` - The session that was deleted, e.g. "cse_01HX...". + Number of (team, channel) pairs the role was assigned before deletion. + + - `role_id: string` + + Tagged ID of the role whose channel assignment was removed. - `id: optional string` @@ -15918,13 +15747,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_deleted"` + - `type: optional "ccr_role_channel_assignment_deleted"` - default: ccr_session_deleted + default: ccr_role_channel_assignment_deleted - - `CcrSessionUpdated object` + - `CcrRoleChannelAssignmentUpdated object` - A Claude Code session's settings were updated. + CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface. - `actor: object or object or object or 8 more` @@ -16137,14 +15966,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `channel_count: number` - The session that was updated, e.g. "cse_01HX...". + Number of channels assigned after the write. + + - `previous_channel_count: number` + + Number of channels assigned before the write. + + - `role_id: string` + + Tagged ID of the role whose channel assignment was written. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `agent_ids: optional array of string` + + The channel-silo agents (cagt_...) assigned after the write. Capped at 100 entries; channel_count carries the uncapped total. + - `created_at: optional string` When this activity occurred. @@ -16159,17 +16000,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_updated"` - - default: ccr_session_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_role_channel_assignment_updated"` - Names of the fields included in the update, e.g. "add_tags", "remove_tags". + default: ccr_role_channel_assignment_updated - - `ClaudeChatSettingsUpdated object` + - `CcrSessionCreated object` - User updated the settings for a conversation. + A Claude Code session was created. A session is one coding interaction with Claude. - `actor: object or object or object or 8 more` @@ -16382,15 +16219,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `session_id: string` + + The session that was created, e.g. "cse_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` + - `agent_id: optional string or null` - Project ID this chat belongs to, if any + The Claude Code agent attached to the session, e.g. "cagt_01HX...". Omitted when the session was created without an agent. - `created_at: optional string` @@ -16406,13 +16245,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_settings_updated"` + - `type: optional "ccr_session_created"` - default: claude_chat_settings_updated + default: ccr_session_created - - `ClaudeChatSnapshotCreated object` + - `CcrSessionDeleted object` - User created/shared a chat snapshot. + A Claude Code session was deleted. - `actor: object or object or object or 8 more` @@ -16625,9 +16464,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `session_id: string` - - `claude_chat_snapshot_id: string` + The session that was deleted, e.g. "cse_01HX...". - `id: optional string` @@ -16647,13 +16486,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_created"` + - `type: optional "ccr_session_deleted"` - default: claude_chat_snapshot_created + default: ccr_session_deleted - - `ClaudeChatSnapshotDeleted object` + - `CcrSessionUpdated object` - User deleted/unshared a chat snapshot. + A Claude Code session's settings were updated. - `actor: object or object or object or 8 more` @@ -16866,14 +16705,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_snapshot_id: string` + - `session_id: string` + + The session that was updated, e.g. "cse_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -16888,13 +16727,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_deleted"` + - `type: optional "ccr_session_updated"` - default: claude_chat_snapshot_deleted + default: ccr_session_updated - - `ClaudeChatSnapshotViewed object` + - `updated_fields: optional array of string` - User viewed a chat snapshot (authenticated or public/unauthenticated). + Names of the fields included in the update, e.g. "add_tags", "remove_tags". + + - `ClaudeChatSettingsUpdated object` + + User updated the settings for a conversation. - `actor: object or object or object or 8 more` @@ -17107,13 +16950,15 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_snapshot_id: string` + - `claude_chat_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` + - `claude_project_id: optional string or null` + + Project ID this chat belongs to, if any - `created_at: optional string` @@ -17129,13 +16974,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_viewed"` + - `type: optional "claude_chat_settings_updated"` - default: claude_chat_snapshot_viewed + default: claude_chat_settings_updated - - `ClaudeArtifactDuplicated object` + - `ClaudeChatSnapshotCreated object` - A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified. + User created/shared a chat snapshot. - `actor: object or object or object or 8 more` @@ -17348,13 +17193,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_artifact_id: string` - - Tagged ID of the new artifact created by the duplication. It is owned by the actor and is independent of the source artifact. - - - `source_claude_artifact_id: string` + - `claude_chat_id: string` - Tagged ID of the artifact that was copied. + - `claude_chat_snapshot_id: string` - `id: optional string` @@ -17374,17 +17215,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `source_claude_artifact_version_id: optional string or null` - - The version of the source artifact that was copied into the new artifact. - - - `type: optional "claude_artifact_duplicated"` + - `type: optional "claude_chat_snapshot_created"` - default: claude_artifact_duplicated + default: claude_chat_snapshot_created - - `ClaudeChatAccessFailed object` + - `ClaudeChatSnapshotDeleted object` - A user was denied access to a Claude.ai chat conversation. + User deleted/unshared a chat snapshot. - `actor: object or object or object or 8 more` @@ -17597,14 +17434,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` - - The chat conversation the user was denied access to, e.g. "claude_chat_01Ab...". + - `claude_chat_snapshot_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_chat_id: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -17619,13 +17456,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_access_failed"` + - `type: optional "claude_chat_snapshot_deleted"` - default: claude_chat_access_failed + default: claude_chat_snapshot_deleted - - `ClaudeChatCreated object` + - `ClaudeChatSnapshotViewed object` - User created a chat. + User viewed a chat snapshot (authenticated or public/unauthenticated). - `actor: object or object or object or 8 more` @@ -17838,17 +17675,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` - - Tagged ID of the created conversation, e.g. "claude_chat_01HX...". + - `claude_chat_snapshot_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` - - Tagged ID of the project the chat was created in, if any, e.g. "claude_proj_01HX...". + - `claude_chat_id: optional string or null` - `created_at: optional string` @@ -17864,13 +17697,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_created"` + - `type: optional "claude_chat_snapshot_viewed"` - default: claude_chat_created + default: claude_chat_snapshot_viewed - - `ClaudeChatDeleted object` + - `ClaudeArtifactDuplicated object` - A user deleted a Claude.ai chat conversation. + A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified. - `actor: object or object or object or 8 more` @@ -18083,17 +17916,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_artifact_id: string` - The chat conversation that was deleted, e.g. "claude_chat_01HX...". + Tagged ID of the new artifact created by the duplication. It is owned by the actor and is independent of the source artifact. - - `id: optional string` + - `source_claude_artifact_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the artifact that was copied. - - `claude_project_id: optional string or null` + - `id: optional string` - The project the chat belonged to, if any, e.g. "claude_proj_01HX...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -18109,13 +17942,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_deleted"` + - `source_claude_artifact_version_id: optional string or null` - default: claude_chat_deleted + The version of the source artifact that was copied into the new artifact. - - `ClaudeChatDeletionFailed object` + - `type: optional "claude_artifact_duplicated"` - A request to delete a Claude.ai chat conversation failed. + default: claude_artifact_duplicated + + - `ClaudeChatAccessFailed object` + + A user was denied access to a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -18330,7 +18167,7 @@ compliance activities that can be filtered by various criteria. - `claude_chat_id: string` - The chat conversation the user attempted to delete, e.g. "claude_chat_01HX...". + The chat conversation the user was denied access to, e.g. "claude_chat_01Ab...". - `id: optional string` @@ -18350,13 +18187,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_deletion_failed"` + - `type: optional "claude_chat_access_failed"` - default: claude_chat_deletion_failed + default: claude_chat_access_failed - - `ClaudeChatSyncSourceCreated object` + - `ClaudeChatCreated object` - A sync source was connected for syncing external content into Claude chats. + User created a chat. - `actor: object or object or object or 8 more` @@ -18569,18 +18406,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was created. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + Tagged ID of the created conversation, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the chat was created in, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. @@ -18595,17 +18432,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_chat_sync_source_created"` + - `type: optional "claude_chat_created"` - default: claude_chat_sync_source_created + default: claude_chat_created - - `ClaudeChatSyncSourceDeleted object` + - `ClaudeChatDeleted object` - A sync source was disconnected from Claude chats. + A user deleted a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -18818,18 +18651,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was deleted. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source. Always `unspecified` for deletion events. + The chat conversation that was deleted, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + The project the chat belonged to, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. @@ -18844,13 +18677,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_sync_source_deleted"` + - `type: optional "claude_chat_deleted"` - default: claude_chat_sync_source_deleted + default: claude_chat_deleted - - `ClaudeChatSyncSourceUpdated object` + - `ClaudeChatDeletionFailed object` - A Claude chat sync source's configuration was updated. + A request to delete a Claude.ai chat conversation failed. - `actor: object or object or object or 8 more` @@ -19063,22 +18896,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was updated. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + The chat conversation the user attempted to delete, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `config_changed: optional boolean or null` - - Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - - `created_at: optional string` When this activity occurred. @@ -19093,17 +18918,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_chat_sync_source_updated"` + - `type: optional "claude_chat_deletion_failed"` - default: claude_chat_sync_source_updated + default: claude_chat_deletion_failed - - `ClaudeChatUpdated object` + - `ClaudeChatSyncSourceCreated object` - User updated the chat metadata (e.g name, model). + A sync source was connected for syncing external content into Claude chats. - `actor: object or object or object or 8 more` @@ -19316,17 +19137,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_chat_sync_source_id: string` - Tagged ID of the updated conversation, e.g. "claude_chat_01HX...". + Tagged ID of the chat-scoped sync source that was created. - - `id: optional string` + - `provider: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - - `claude_project_id: optional string or null` + - `id: optional string` - Tagged ID of the project the chat belongs to, if any, e.g. "claude_proj_01HX...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -19342,13 +19163,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_updated"` + - `resource_descriptor: optional string or null` - default: claude_chat_updated + A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `ClaudeChatViewed object` + - `type: optional "claude_chat_sync_source_created"` - A user viewed a Claude.ai chat conversation. + default: claude_chat_sync_source_created + + - `ClaudeChatSyncSourceDeleted object` + + A sync source was disconnected from Claude chats. - `actor: object or object or object or 8 more` @@ -19561,17 +19386,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_chat_sync_source_id: string` - The chat conversation that was viewed, e.g. "claude_chat_01Ab...". + Tagged ID of the chat-scoped sync source that was deleted. - - `id: optional string` + - `provider: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The external provider backing the sync source. Always `unspecified` for deletion events. - - `claude_project_id: optional string or null` + - `id: optional string` - The project the chat belongs to, if any, e.g. "claude_proj_01Ab...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -19587,13 +19412,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_viewed"` + - `type: optional "claude_chat_sync_source_deleted"` - default: claude_chat_viewed + default: claude_chat_sync_source_deleted - - `ClaudeCodeCredentialRevoked object` + - `ClaudeChatSyncSourceUpdated object` - A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded. + A Claude chat sync source's configuration was updated. - `actor: object or object or object or 8 more` @@ -19806,25 +19631,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_type: "runner_pool_key" or "runner_token" or "session_token" or "unspecified"` - - The kind of credential the revoked target identifies, when known. Subject-targeted revocations cascade to every credential delegated from the target regardless of kind; this field describes the target itself, not the full set of credentials the cascade reached. For a revocation submitted as a pasted credential the kind is best-effort and may be inaccurate; the recorded jti and the revocation itself are unaffected. - - - `"runner_pool_key"` + - `claude_chat_sync_source_id: string` - - `"runner_token"` + Tagged ID of the chat-scoped sync source that was updated. - - `"session_token"` + - `provider: string` - - `"unspecified"` + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `agent_id: optional string or null` + - `config_changed: optional boolean or null` - The agent identity whose Claude Code credentials were revoked, when revocation targeted every session created by an agent identity, e.g. "cagt_01HX...". + Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - `created_at: optional string` @@ -19832,14 +19653,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `delegating_jti: optional string or null` - - The credential identifier whose delegated credentials were revoked (a chain revoke): every credential delegated from this one was revoked, but the credential itself was not. Distinct from `jti`, which records a revocation of the credential itself and its delegates. - - - `jti: optional string or null` - - The unique identifier of the revoked credential, recorded in its canonical form. Revoking a runner pool key also revokes every runner and session token delegated from it. A revocation submitted as a pasted credential is recorded by that credential's identifier. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -19848,29 +19661,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_id: optional string or null` - - The runner whose credentials were revoked, when revocation targeted every credential delegated from the runner, e.g. "ccrunner_01HX...". - - - `runner_pool_id: optional string or null` - - The runner pool whose credentials were revoked, when revocation targeted every credential delegated from the pool, e.g. "ccpool_01HX...". - - - `session_id: optional string or null` - - The session whose credentials were revoked, when revocation targeted every credential delegated from the session, e.g. "cse_01HX...". - - - `type: optional "claude_code_credential_revoked"` + - `resource_descriptor: optional string or null` - default: claude_code_credential_revoked + A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `user_id: optional string or null` + - `type: optional "claude_chat_sync_source_updated"` - The user whose Claude Code credentials were revoked, when revocation targeted every credential minted for a user. Carries the user's tagged account ID, e.g. "user_01HX..." — the only form the revocation API accepts, so the field joins against other activities' account identifiers and never carries an email. + default: claude_chat_sync_source_updated - - `ClaudeCodeReviewConfigUpdated object` + - `ClaudeChatUpdated object` - Claude Code Review configuration was enabled/disabled for an org. + User updated the chat metadata (e.g name, model). - `actor: object or object or object or 8 more` @@ -20083,28 +19884,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` + - `claude_chat_id: string` - Whether code review is now enabled + Tagged ID of the updated conversation, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the chat belongs to, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time - - `environment_id: optional string or null` - - Environment used for code review - - - `model: optional string or null` - - Model configured for code review - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20113,49 +19910,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `per_review_limit_usd: optional string or null` - - Per-review spend limit in USD - - - `previous_enabled: optional boolean or null` - - Whether code review was enabled before the change. Absent when no configuration existed before this update. - - - `previous_environment_id: optional string or null` - - Environment used for code review before the change. Absent when no configuration existed before this update or no environment was set. - - - `previous_model: optional string or null` - - Model configured for code review before the change. Absent when no configuration existed before this update or no model was set. - - - `previous_per_review_limit_usd: optional string or null` - - Per-review spend limit in USD before the change. Absent when no configuration existed before this update or no limit was set. - - - `previous_show_tips: optional boolean or null` - - Whether tip-style pull-request comments were enabled before the change. Absent when no configuration existed before this update. - - - `previous_verification_enabled: optional boolean or null` - - Whether the verification stage of code review was enabled for the organization before the change. Absent when no configuration existed before this update or no preference was set. - - - `show_tips: optional boolean or null` - - Whether tip-style pull-request comments are now enabled - - - `type: optional "claude_code_review_config_updated"` - - default: claude_code_review_config_updated - - - `verification_enabled: optional boolean or null` + - `type: optional "claude_chat_updated"` - Whether the verification stage of code review is now enabled for the organization. Absent when the organization has not set a preference and the default applies. + default: claude_chat_updated - - `ClaudeCodeReviewRepositoryAdded object` + - `ClaudeChatViewed object` - A repository was added to org-level Claude Code Review configuration. + A user viewed a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -20368,26 +20129,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` - - ID of the repository configuration - - - `repo_name: string` - - Repository name - - - `repo_owner: string` - - Repository owner (GitHub org/user) - - - `trigger_mode: string` + - `claude_chat_id: string` - When code review is triggered + The chat conversation that was viewed, e.g. "claude_chat_01Ab...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + The project the chat belongs to, if any, e.g. "claude_proj_01Ab...". + - `created_at: optional string` When this activity occurred. @@ -20402,13 +20155,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_review_repository_added"` + - `type: optional "claude_chat_viewed"` - default: claude_code_review_repository_added + default: claude_chat_viewed - - `ClaudeCodeReviewRepositoryRemoved object` + - `ClaudeCodeCredentialRevoked object` - A repository was removed from org-level Claude Code Review configuration. + A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded. - `actor: object or object or object or 8 more` @@ -20621,28 +20374,40 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` + - `credential_type: "runner_pool_key" or "runner_token" or "session_token" or "unspecified"` - ID of the deleted repository configuration + The kind of credential the revoked target identifies, when known. Subject-targeted revocations cascade to every credential delegated from the target regardless of kind; this field describes the target itself, not the full set of credentials the cascade reached. For a revocation submitted as a pasted credential the kind is best-effort and may be inaccurate; the recorded jti and the revocation itself are unaffected. - - `repo_name: string` + - `"runner_pool_key"` - Repository name at deletion time + - `"runner_token"` - - `repo_owner: string` + - `"session_token"` - Repository owner at deletion time + - `"unspecified"` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `agent_id: optional string or null` + + The agent identity whose Claude Code credentials were revoked, when revocation targeted every session created by an agent identity, e.g. "cagt_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time + - `delegating_jti: optional string or null` + + The credential identifier whose delegated credentials were revoked (a chain revoke): every credential delegated from this one was revoked, but the credential itself was not. Distinct from `jti`, which records a revocation of the credential itself and its delegates. + + - `jti: optional string or null` + + The unique identifier of the revoked credential, recorded in its canonical form. Revoking a runner pool key also revokes every runner and session token delegated from it. A revocation submitted as a pasted credential is recorded by that credential's identifier. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20651,13 +20416,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_review_repository_removed"` + - `runner_id: optional string or null` - default: claude_code_review_repository_removed + The runner whose credentials were revoked, when revocation targeted every credential delegated from the runner, e.g. "ccrunner_01HX...". - - `ClaudeCodeReviewRepositoryUpdated object` + - `runner_pool_id: optional string or null` - A Claude Code Review repository configuration was updated. + The runner pool whose credentials were revoked, when revocation targeted every credential delegated from the pool, e.g. "ccpool_01HX...". + + - `session_id: optional string or null` + + The session whose credentials were revoked, when revocation targeted every credential delegated from the session, e.g. "cse_01HX...". + + - `type: optional "claude_code_credential_revoked"` + + default: claude_code_credential_revoked + + - `user_id: optional string or null` + + The user whose Claude Code credentials were revoked, when revocation targeted every credential minted for a user. Carries the user's tagged account ID, e.g. "user_01HX..." — the only form the revocation API accepts, so the field joins against other activities' account identifiers and never carries an email. + + - `ClaudeCodeReviewConfigUpdated object` + + Claude Code Review configuration was enabled/disabled for an org. - `actor: object or object or object or 8 more` @@ -20870,17 +20651,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` - - ID of the repository configuration - - - `repo_name: string` - - Repository name - - - `repo_owner: string` + - `enabled: boolean` - Repository owner + Whether code review is now enabled - `id: optional string` @@ -20892,6 +20665,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `environment_id: optional string or null` + + Environment used for code review + + - `model: optional string or null` + + Model configured for code review + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20900,21 +20681,49 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `status: optional string or null` + - `per_review_limit_usd: optional string or null` - Updated status (ACTIVE/INACTIVE) + Per-review spend limit in USD - - `trigger_mode: optional string or null` + - `previous_enabled: optional boolean or null` - Updated trigger mode + Whether code review was enabled before the change. Absent when no configuration existed before this update. - - `type: optional "claude_code_review_repository_updated"` + - `previous_environment_id: optional string or null` - default: claude_code_review_repository_updated + Environment used for code review before the change. Absent when no configuration existed before this update or no environment was set. - - `ClaudeCodeRunnerDeleted object` + - `previous_model: optional string or null` - A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again. + Model configured for code review before the change. Absent when no configuration existed before this update or no model was set. + + - `previous_per_review_limit_usd: optional string or null` + + Per-review spend limit in USD before the change. Absent when no configuration existed before this update or no limit was set. + + - `previous_show_tips: optional boolean or null` + + Whether tip-style pull-request comments were enabled before the change. Absent when no configuration existed before this update. + + - `previous_verification_enabled: optional boolean or null` + + Whether the verification stage of code review was enabled for the organization before the change. Absent when no configuration existed before this update or no preference was set. + + - `show_tips: optional boolean or null` + + Whether tip-style pull-request comments are now enabled + + - `type: optional "claude_code_review_config_updated"` + + default: claude_code_review_config_updated + + - `verification_enabled: optional boolean or null` + + Whether the verification stage of code review is now enabled for the organization. Absent when the organization has not set a preference and the default applies. + + - `ClaudeCodeReviewRepositoryAdded object` + + A repository was added to org-level Claude Code Review configuration. - `actor: object or object or object or 8 more` @@ -21127,9 +20936,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `runner_id: string` + - `config_id: string` - The runner that was removed, e.g. "ccrunner_01HX...". + ID of the repository configuration + + - `repo_name: string` + + Repository name + + - `repo_owner: string` + + Repository owner (GitHub org/user) + + - `trigger_mode: string` + + When code review is triggered - `id: optional string` @@ -21149,17 +20970,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_pool_id: optional string or null` - - The pool the runner was removed from, e.g. "ccpool_01HX...". - - - `type: optional "claude_code_runner_deleted"` + - `type: optional "claude_code_review_repository_added"` - default: claude_code_runner_deleted + default: claude_code_review_repository_added - - `ClaudeCodeRunnerPoolCreated object` + - `ClaudeCodeReviewRepositoryRemoved object` - A self-hosted runner pool for Claude Code was created. + A repository was removed from org-level Claude Code Review configuration. - `actor: object or object or object or 8 more` @@ -21372,13 +21189,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` + - `config_id: string` - The display name the pool was created with. + ID of the deleted repository configuration - - `runner_pool_id: string` + - `repo_name: string` - The runner pool that was created, e.g. "ccpool_01HX...". + Repository name at deletion time + + - `repo_owner: string` + + Repository owner at deletion time - `id: optional string` @@ -21398,13 +21219,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_created"` + - `type: optional "claude_code_review_repository_removed"` - default: claude_code_runner_pool_created + default: claude_code_review_repository_removed - - `ClaudeCodeRunnerPoolDeleted object` + - `ClaudeCodeReviewRepositoryUpdated object` - A self-hosted runner pool was deleted. + A Claude Code Review repository configuration was updated. - `actor: object or object or object or 8 more` @@ -21617,9 +21438,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `runner_pool_id: string` + - `config_id: string` - The runner pool that was deleted, e.g. "ccpool_01HX...". + ID of the repository configuration + + - `repo_name: string` + + Repository name + + - `repo_owner: string` + + Repository owner - `id: optional string` @@ -21631,10 +21460,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `display_name: optional string or null` - - The pool's display name at deletion time. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -21643,13 +21468,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_deleted"` + - `status: optional string or null` - default: claude_code_runner_pool_deleted + Updated status (ACTIVE/INACTIVE) - - `ClaudeCodeRunnerPoolSecretMinted object` + - `trigger_mode: optional string or null` - A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded. + Updated trigger mode + + - `type: optional "claude_code_review_repository_updated"` + + default: claude_code_review_repository_updated + + - `ClaudeCodeRunnerDeleted object` + + A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again. - `actor: object or object or object or 8 more` @@ -21862,13 +21695,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `jti: string` - - The minted key's unique identifier (its JWT `jti` claim), usable to revoke that key later. - - - `runner_pool_id: string` + - `runner_id: string` - The runner pool the key was minted for, e.g. "ccpool_01HX...". + The runner that was removed, e.g. "ccrunner_01HX...". - `id: optional string` @@ -21880,16 +21709,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `expires_at: optional string or null` - - When the minted key expires. - - format: date-time - - - `label: optional string or null` - - The label the key was minted with. The key minted automatically when a pool is created carries the label "Initial key". - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -21898,25 +21717,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_secret_minted"` - - default: claude_code_runner_pool_secret_minted - - - `ClaudeCodeRunnerPoolSessionQueueUpdated object` - - An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt. - - - `action: "dismissed" or "provisioning_retried" or "requeued" or "unspecified"` + - `runner_pool_id: optional string or null` - What changed about the session's queue state. + The pool the runner was removed from, e.g. "ccpool_01HX...". - - `"dismissed"` + - `type: optional "claude_code_runner_deleted"` - - `"provisioning_retried"` + default: claude_code_runner_deleted - - `"requeued"` + - `ClaudeCodeRunnerPoolCreated object` - - `"unspecified"` + A self-hosted runner pool for Claude Code was created. - `actor: object or object or object or 8 more` @@ -22129,9 +21940,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `display_name: string` - The session whose queue state changed, e.g. "cse_01HX...". + The display name the pool was created with. + + - `runner_pool_id: string` + + The runner pool that was created, e.g. "ccpool_01HX...". - `id: optional string` @@ -22143,10 +21958,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `excluded_runner_id: optional string or null` - - The runner the session was moved off, when action is "requeued", e.g. "ccrunner_01HX...". - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22155,17 +21966,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_pool_id: optional string or null` - - The runner pool whose queue the session is in, when known, e.g. "ccpool_01HX...". - - - `type: optional "claude_code_runner_pool_session_queue_updated"` + - `type: optional "claude_code_runner_pool_created"` - default: claude_code_runner_pool_session_queue_updated + default: claude_code_runner_pool_created - - `ClaudeCodeRunnerPoolUpdated object` + - `ClaudeCodeRunnerPoolDeleted object` - A self-hosted runner pool's settings were updated. + A self-hosted runner pool was deleted. - `actor: object or object or object or 8 more` @@ -22378,13 +22185,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` - - The pool's display name after the update. - - `runner_pool_id: string` - The runner pool that was updated, e.g. "ccpool_01HX...". + The runner pool that was deleted, e.g. "ccpool_01HX...". - `id: optional string` @@ -22396,6 +22199,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `display_name: optional string or null` + + The pool's display name at deletion time. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22404,17 +22211,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_display_name: optional string or null` - - The pool's display name before the update. Absent when the name was unchanged or the previous value was unavailable. - - - `type: optional "claude_code_runner_pool_updated"` + - `type: optional "claude_code_runner_pool_deleted"` - default: claude_code_runner_pool_updated + default: claude_code_runner_pool_deleted - - `ClaudeCodeSecurityCenterConfigUpdated object` + - `ClaudeCodeRunnerPoolSecretMinted object` - Claude Code Security Center scanning was enabled/disabled for an org. + A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded. - `actor: object or object or object or 8 more` @@ -22627,9 +22430,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` + - `jti: string` - Whether Security Center is now enabled + The minted key's unique identifier (its JWT `jti` claim), usable to revoke that key later. + + - `runner_pool_id: string` + + The runner pool the key was minted for, e.g. "ccpool_01HX...". - `id: optional string` @@ -22641,9 +22448,15 @@ compliance activities that can be filtered by various criteria. format: date-time - - `environment_id: optional string or null` + - `expires_at: optional string or null` - Environment used for security scanning + When the minted key expires. + + format: date-time + + - `label: optional string or null` + + The label the key was minted with. The key minted automatically when a pool is created carries the label "Initial key". - `organization_id: optional string or null` @@ -22653,13 +22466,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_center_config_updated"` + - `type: optional "claude_code_runner_pool_secret_minted"` - default: claude_code_security_center_config_updated + default: claude_code_runner_pool_secret_minted - - `ClaudeCodeSecurityScanCancelled object` + - `ClaudeCodeRunnerPoolSessionQueueUpdated object` - In-flight Claude Code Security scans were cancelled for a project. + An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt. + + - `action: "dismissed" or "provisioning_retried" or "requeued" or "unspecified"` + + What changed about the session's queue state. + + - `"dismissed"` + + - `"provisioning_retried"` + + - `"requeued"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -22872,11 +22697,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_project_id: string` - - Tagged ID of the scan project + - `session_id: string` - - `scans_cancelled: number` + The session whose queue state changed, e.g. "cse_01HX...". - `id: optional string` @@ -22888,6 +22711,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `excluded_runner_id: optional string or null` + + The runner the session was moved off, when action is "requeued", e.g. "ccrunner_01HX...". + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22896,13 +22723,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_cancelled"` + - `runner_pool_id: optional string or null` - default: claude_code_security_scan_cancelled + The runner pool whose queue the session is in, when known, e.g. "ccpool_01HX...". - - `ClaudeCodeSecurityScanCreated object` + - `type: optional "claude_code_runner_pool_session_queue_updated"` - A Claude Code Security scan was started. + default: claude_code_runner_pool_session_queue_updated + + - `ClaudeCodeRunnerPoolUpdated object` + + A self-hosted runner pool's settings were updated. - `actor: object or object or object or 8 more` @@ -23115,13 +22946,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `display_name: string` - Tagged ID of the created scan + The pool's display name after the update. - - `scan_project_id: string` + - `runner_pool_id: string` - Tagged ID of the scan project the scan belongs to + The runner pool that was updated, e.g. "ccpool_01HX...". - `id: optional string` @@ -23141,25 +22972,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_created"` - - default: claude_code_security_scan_created - - - `ClaudeCodeSecurityScanProjectMemberUpdated object` - - A person's access to a Claude Code Security scan project was granted, changed, or revoked. - - - `action: "member_added" or "member_removed" or "member_role_changed" or "unspecified"` + - `previous_display_name: optional string or null` - Whether the member was granted access, had their role changed, or was revoked + The pool's display name before the update. Absent when the name was unchanged or the previous value was unavailable. - - `"member_added"` + - `type: optional "claude_code_runner_pool_updated"` - - `"member_removed"` + default: claude_code_runner_pool_updated - - `"member_role_changed"` + - `ClaudeCodeSecurityCenterConfigUpdated object` - - `"unspecified"` + Claude Code Security Center scanning was enabled/disabled for an org. - `actor: object or object or object or 8 more` @@ -23372,13 +23195,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `member_id: string` - - Tagged ID of the member whose access changed - - - `scan_project_id: string` + - `enabled: boolean` - Tagged ID of the scan project + Whether Security Center is now enabled - `id: optional string` @@ -23390,6 +23209,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `environment_id: optional string or null` + + Environment used for security scanning + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -23398,31 +23221,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `role: optional string or null` - - Role granted to the member (full, view_triage, or view); omitted for revocations - - - `type: optional "claude_code_security_scan_project_member_updated"` - - default: claude_code_security_scan_project_member_updated - - - `ClaudeCodeSecurityScanProjectUpdated object` - - A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience. - - - `action: "archived" or "created" or "migrated" or 2 more` - - The state change applied to the scan project. - - - `"archived"` - - - `"created"` + - `type: optional "claude_code_security_center_config_updated"` - - `"migrated"` + default: claude_code_security_center_config_updated - - `"unarchived"` + - `ClaudeCodeSecurityScanCancelled object` - - `"unspecified"` + In-flight Claude Code Security scans were cancelled for a project. - `actor: object or object or object or 8 more` @@ -23639,6 +23444,8 @@ compliance activities that can be filtered by various criteria. Tagged ID of the scan project + - `scans_cancelled: number` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -23657,23 +23464,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_project_updated"` - - default: claude_code_security_scan_project_updated - - - `ClaudeCodeSecurityScanProjectVisibilityUpdated object` - - A Claude Code Security scan project was shared with the organization or made private. - - - `action: "shared" or "unshared" or "unspecified"` - - Whether the project was shared with the organization or made private + - `type: optional "claude_code_security_scan_cancelled"` - - `"shared"` + default: claude_code_security_scan_cancelled - - `"unshared"` + - `ClaudeCodeSecurityScanCreated object` - - `"unspecified"` + A Claude Code Security scan was started. - `actor: object or object or object or 8 more` @@ -23886,18 +23683,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `scan_id: string` + + Tagged ID of the created scan + - `scan_project_id: string` - Tagged ID of the scan project + Tagged ID of the scan project the scan belongs to - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `access_level: optional string or null` - - Access level granted to organization members (read_only or full); only set when shared - - `created_at: optional string` When this activity occurred. @@ -23912,25 +23709,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_project_visibility_updated"` - - default: claude_code_security_scan_project_visibility_updated + - `type: optional "claude_code_security_scan_created"` - - `ClaudeCodeSecurityScanRunUpdated object` + default: claude_code_security_scan_created - A single Claude Code Security scan run was archived or unarchived. + - `ClaudeCodeSecurityScanProjectMemberUpdated object` - - `action: "archived" or "created" or "migrated" or 2 more` + A person's access to a Claude Code Security scan project was granted, changed, or revoked. - The state change applied to the scan run + - `action: "member_added" or "member_removed" or "member_role_changed" or "unspecified"` - - `"archived"` + Whether the member was granted access, had their role changed, or was revoked - - `"created"` + - `"member_added"` - - `"migrated"` + - `"member_removed"` - - `"unarchived"` + - `"member_role_changed"` - `"unspecified"` @@ -24145,9 +23940,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `member_id: string` - Tagged ID of the scan the request named — any scan in the archived run, not necessarily its canonical (run_index=0) scan + Tagged ID of the member whose access changed + + - `scan_project_id: string` + + Tagged ID of the scan project - `id: optional string` @@ -24167,13 +23966,33 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_run_updated"` + - `role: optional string or null` - default: claude_code_security_scan_run_updated + Role granted to the member (full, view_triage, or view); omitted for revocations - - `ClaudeCodeSecurityScanScheduleDeleted object` + - `type: optional "claude_code_security_scan_project_member_updated"` - A recurring scan schedule was deleted for a Claude Code Security project. + default: claude_code_security_scan_project_member_updated + + - `ClaudeCodeSecurityScanProjectUpdated object` + + A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience. + + - `action: "archived" or "created" or "migrated" or 3 more` + + The state change applied to the scan project. + + - `"archived"` + + - `"created"` + + - `"migrated"` + + - `"resumed"` + + - `"unarchived"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24408,13 +24227,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_schedule_deleted"` + - `type: optional "claude_code_security_scan_project_updated"` - default: claude_code_security_scan_schedule_deleted + default: claude_code_security_scan_project_updated - - `ClaudeCodeSecurityScanScheduleUpdated object` + - `ClaudeCodeSecurityScanProjectVisibilityUpdated object` - A recurring scan schedule was set or replaced for a Claude Code Security project. + A Claude Code Security scan project was shared with the organization or made private. + + - `action: "shared" or "unshared" or "unspecified"` + + Whether the project was shared with the organization or made private + + - `"shared"` + + - `"unshared"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24627,8 +24456,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cadence: string` - - `scan_project_id: string` Tagged ID of the scan project @@ -24637,6 +24464,10 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_level: optional string or null` + + Access level granted to organization members (read_only or full); only set when shared + - `created_at: optional string` When this activity occurred. @@ -24651,13 +24482,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_schedule_updated"` + - `type: optional "claude_code_security_scan_project_visibility_updated"` - default: claude_code_security_scan_schedule_updated + default: claude_code_security_scan_project_visibility_updated - - `ClaudeCodeSecurityVulnerabilityFixSessionCreated object` + - `ClaudeCodeSecurityScanRunUpdated object` - A Claude Code remediation session was created for a Claude Code Security vulnerability finding. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. + + - `action: "archived" or "created" or "migrated" or 3 more` + + The state change applied to the scan run + + - `"archived"` + + - `"created"` + + - `"migrated"` + + - `"resumed"` + + - `"unarchived"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24872,11 +24719,7 @@ compliance activities that can be filtered by various criteria. - `scan_id: string` - Tagged ID of the scan the finding belongs to - - - `session_id: string` - - ID of the created remediation session + Tagged ID of the scan the request named — for archive/unarchive any scan in the run, not necessarily its canonical (run_index=0) scan; for resume, the paused scan - `id: optional string` @@ -24896,27 +24739,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_vulnerability_fix_session_created"` - - default: claude_code_security_vulnerability_fix_session_created - - - `ClaudeCodeSecurityVulnerabilityUpdated object` - - A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened. - - - `action: "dismissed" or "fixed" or "restored" or 2 more` - - The state change applied to the finding - - - `"dismissed"` - - - `"fixed"` + - `type: optional "claude_code_security_scan_run_updated"` - - `"restored"` + default: claude_code_security_scan_run_updated - - `"unfixed"` + - `ClaudeCodeSecurityScanScheduleDeleted object` - - `"unspecified"` + A recurring scan schedule was deleted for a Claude Code Security project. - `actor: object or object or object or 8 more` @@ -25129,9 +24958,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `scan_project_id: string` - Tagged ID of the scan the finding belongs to + Tagged ID of the scan project - `id: optional string` @@ -25143,10 +24972,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `dismissal_reason: optional string or null` - - The categorized dismissal reason (only set when the finding was dismissed) - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -25155,13 +24980,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_vulnerability_updated"` + - `type: optional "claude_code_security_scan_schedule_deleted"` - default: claude_code_security_vulnerability_updated + default: claude_code_security_scan_schedule_deleted - - `ClaudeCodeSecurityWebhookCreated object` + - `ClaudeCodeSecurityScanScheduleUpdated object` - A Claude Code Security outbound webhook was created. + A recurring scan schedule was set or replaced for a Claude Code Security project. - `actor: object or object or object or 8 more` @@ -25374,11 +25199,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `url: string` + - `cadence: string` - - `webhook_id: string` + - `scan_project_id: string` - Tagged ID of the webhook + Tagged ID of the scan project - `id: optional string` @@ -25398,17 +25223,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` - - Tagged ID of the scan project (null for organization-wide webhooks) - - - `type: optional "claude_code_security_webhook_created"` + - `type: optional "claude_code_security_scan_schedule_updated"` - default: claude_code_security_webhook_created + default: claude_code_security_scan_schedule_updated - - `ClaudeCodeSecurityWebhookDeleted object` + - `ClaudeCodeSecurityVulnerabilityFixSessionCreated object` - A Claude Code Security outbound webhook was deleted. + A Claude Code remediation session was created for a Claude Code Security vulnerability finding. - `actor: object or object or object or 8 more` @@ -25621,9 +25442,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `webhook_id: string` + - `scan_id: string` - Tagged ID of the webhook + Tagged ID of the scan the finding belongs to + + - `session_id: string` + + ID of the created remediation session - `id: optional string` @@ -25643,17 +25468,27 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` + - `type: optional "claude_code_security_vulnerability_fix_session_created"` - Tagged ID of the scan project (null for organization-wide webhooks) + default: claude_code_security_vulnerability_fix_session_created - - `type: optional "claude_code_security_webhook_deleted"` + - `ClaudeCodeSecurityVulnerabilityUpdated object` - default: claude_code_security_webhook_deleted + A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened. - - `ClaudeCodeSecurityWebhookSecretUpdated object` + - `action: "dismissed" or "fixed" or "restored" or 2 more` - The HMAC signing secret for a Claude Code Security webhook was rotated. + The state change applied to the finding + + - `"dismissed"` + + - `"fixed"` + + - `"restored"` + + - `"unfixed"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -25866,9 +25701,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `webhook_id: string` + - `scan_id: string` - Tagged ID of the webhook + Tagged ID of the scan the finding belongs to - `id: optional string` @@ -25880,6 +25715,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `dismissal_reason: optional string or null` + + The categorized dismissal reason (only set when the finding was dismissed) + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -25888,17 +25727,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` - - Tagged ID of the scan project (null for organization-wide webhooks) - - - `type: optional "claude_code_security_webhook_secret_updated"` + - `type: optional "claude_code_security_vulnerability_updated"` - default: claude_code_security_webhook_secret_updated + default: claude_code_security_vulnerability_updated - - `ClaudeCodeSecurityWebhookUpdated object` + - `ClaudeCodeSecurityWebhookCreated object` - A Claude Code Security outbound webhook was updated. + A Claude Code Security outbound webhook was created. - `actor: object or object or object or 8 more` @@ -26111,6 +25946,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `url: string` + - `webhook_id: string` Tagged ID of the webhook @@ -26137,23 +25974,13 @@ compliance activities that can be filtered by various criteria. Tagged ID of the scan project (null for organization-wide webhooks) - - `type: optional "claude_code_security_webhook_updated"` - - default: claude_code_security_webhook_updated - - - `ClaudeCodeTeamMemoryACLUpdated object` - - An RBAC group was added to or removed from the Claude Code team-memory ACL. - - - `action: "removed" or "set" or "unspecified"` - - Whether the group was set (added/updated) or removed + - `type: optional "claude_code_security_webhook_created"` - - `"removed"` + default: claude_code_security_webhook_created - - `"set"` + - `ClaudeCodeSecurityWebhookDeleted object` - - `"unspecified"` + A Claude Code Security outbound webhook was deleted. - `actor: object or object or object or 8 more` @@ -26366,18 +26193,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` + - `webhook_id: string` - Tagged ID of the RBAC group + Tagged ID of the webhook - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `access_level: optional string or null` - - Access level granted (when action=set) - - `created_at: optional string` When this activity occurred. @@ -26392,17 +26215,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_access_level: optional string or null` + - `scan_project_id: optional string or null` - Access level the group had before this change; absent when the group was not previously in the access list. For removals this is the access level that was removed. + Tagged ID of the scan project (null for organization-wide webhooks) - - `type: optional "claude_code_team_memory_acl_updated"` + - `type: optional "claude_code_security_webhook_deleted"` - default: claude_code_team_memory_acl_updated + default: claude_code_security_webhook_deleted - - `ClaudeCodeTeamMemoryUpdated object` + - `ClaudeCodeSecurityWebhookSecretUpdated object` - Claude Code team memory shared with the organization was updated. + The HMAC signing secret for a Claude Code Security webhook was rotated. - `actor: object or object or object or 8 more` @@ -26615,9 +26438,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `webhook_id: string` - True when the entire team memory store for this scope was deleted in one request. + Tagged ID of the webhook - `id: optional string` @@ -26629,26 +26452,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of team memory entries removed. - - - `keys_written: optional array of string` - - Withdrawn — never populated. See `keys_written_count`. - - - `keys_written_count: optional number or null` - - Number of team memory entries created or updated. - - - `new_checksum: optional string or null` - - Checksum of the team memory after this change. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -26657,37 +26460,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_checksum: optional string or null` - - Checksum of the team memory before this change; null when it did not exist. - - - `repo: optional string or null` - - Withdrawn — never populated. - - - `type: optional "claude_code_team_memory_updated"` - - default: claude_code_team_memory_updated - - - `version: optional number or null` - - Version number of the team memory store after this change. - - - `ClaudeCodeTeamOnboardingGuideUpdated object` - - A Claude Code team onboarding guide was created, updated, or deleted. - - - `action: "created" or "deleted" or "unspecified" or "updated"` + - `scan_project_id: optional string or null` - The state change applied to the onboarding guide. + Tagged ID of the scan project (null for organization-wide webhooks) - - `"created"` + - `type: optional "claude_code_security_webhook_secret_updated"` - - `"deleted"` + default: claude_code_security_webhook_secret_updated - - `"unspecified"` + - `ClaudeCodeSecurityWebhookUpdated object` - - `"updated"` + A Claude Code Security outbound webhook was updated. - `actor: object or object or object or 8 more` @@ -26900,9 +26683,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `guide_short_code: string` + - `webhook_id: string` - Short code identifying the onboarding guide — the public URL handle shown in the share link. + Tagged ID of the webhook - `id: optional string` @@ -26914,37 +26697,35 @@ compliance activities that can be filtered by various criteria. format: date-time - - `guide_id: optional string or null` - - Tagged ID of the onboarding guide. + - `organization_id: optional string or null` - - `guide_name: optional string or null` + Organization ID this activity is associated with - Withdrawn — never populated. + - `organization_uuid: optional string or null` - - `new_checksum: optional string or null` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - Checksum of the guide content after this change; null when the guide was deleted. + - `scan_project_id: optional string or null` - - `organization_id: optional string or null` + Tagged ID of the scan project (null for organization-wide webhooks) - Organization ID this activity is associated with + - `type: optional "claude_code_security_webhook_updated"` - - `organization_uuid: optional string or null` + default: claude_code_security_webhook_updated - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `ClaudeCodeTeamMemoryACLUpdated object` - - `previous_checksum: optional string or null` + An RBAC group was added to or removed from the Claude Code team-memory ACL. - Checksum of the guide content before this change; null when the guide did not exist. + - `action: "removed" or "set" or "unspecified"` - - `type: optional "claude_code_team_onboarding_guide_updated"` + Whether the group was set (added/updated) or removed - default: claude_code_team_onboarding_guide_updated + - `"removed"` - - `ClaudeCodeUserMarketplacesUpdated object` + - `"set"` - A user's Claude Code plugin marketplace selections were updated on Anthropic servers. + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -27157,40 +26938,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `group_id: string` - True when all of the user's marketplace selections were removed in one request. + Tagged ID of the RBAC group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_level: optional string or null` + + Access level granted (when action=set) + - `created_at: optional string` When this activity occurred. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of marketplace selections removed. - - - `keys_written: optional array of string` - - Withdrawn — never populated. See `keys_written_count`. - - - `keys_written_count: optional number or null` - - Number of marketplace selections added or whose source changed. - - - `new_value: optional string or null` - - Withdrawn — never populated. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -27199,17 +26964,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional string or null` + - `previous_access_level: optional string or null` - Withdrawn — never populated. + Access level the group had before this change; absent when the group was not previously in the access list. For removals this is the access level that was removed. - - `type: optional "claude_code_user_marketplaces_updated"` + - `type: optional "claude_code_team_memory_acl_updated"` - default: claude_code_user_marketplaces_updated + default: claude_code_team_memory_acl_updated - - `ClaudeCodeUserMemoryUpdated object` + - `ClaudeCodeTeamMemoryUpdated object` - A user's synced private Claude Code memory was updated or deleted on Anthropic servers. + Claude Code team memory shared with the organization was updated. - `actor: object or object or object or 8 more` @@ -27424,7 +27189,7 @@ compliance activities that can be filtered by various criteria. - `deleted_all: boolean` - True when the user's entire synced memory for this scope was deleted in one request. + True when the entire team memory store for this scope was deleted in one request. - `id: optional string` @@ -27442,7 +27207,7 @@ compliance activities that can be filtered by various criteria. - `keys_deleted_count: optional number or null` - Number of memory file paths removed. + Number of team memory entries removed. - `keys_written: optional array of string` @@ -27450,11 +27215,11 @@ compliance activities that can be filtered by various criteria. - `keys_written_count: optional number or null` - Number of memory file paths created or updated. + Number of team memory entries created or updated. - `new_checksum: optional string or null` - Checksum of the user's synced memory after this change. + Checksum of the team memory after this change. - `organization_id: optional string or null` @@ -27466,19 +27231,35 @@ compliance activities that can be filtered by various criteria. - `previous_checksum: optional string or null` - Checksum of the user's synced memory before this change; null when the store did not exist. + Checksum of the team memory before this change; null when it did not exist. - `repo: optional string or null` Withdrawn — never populated. - - `type: optional "claude_code_user_memory_updated"` + - `type: optional "claude_code_team_memory_updated"` - default: claude_code_user_memory_updated + default: claude_code_team_memory_updated - - `ClaudeCodeUserPluginsUpdated object` + - `version: optional number or null` - A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers. + Version number of the team memory store after this change. + + - `ClaudeCodeTeamOnboardingGuideUpdated object` + + A Claude Code team onboarding guide was created, updated, or deleted. + + - `action: "created" or "deleted" or "unspecified" or "updated"` + + The state change applied to the onboarding guide. + + - `"created"` + + - `"deleted"` + + - `"unspecified"` + + - `"updated"` - `actor: object or object or object or 8 more` @@ -27691,9 +27472,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `guide_short_code: string` - True when all of the user's plugin selections were removed in one request. + Short code identifying the onboarding guide — the public URL handle shown in the share link. - `id: optional string` @@ -27705,25 +27486,17 @@ compliance activities that can be filtered by various criteria. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of plugin selections removed. - - - `keys_written: optional array of string` + - `guide_id: optional string or null` - Withdrawn — never populated. See `keys_written_count`. + Tagged ID of the onboarding guide. - - `keys_written_count: optional number or null` + - `guide_name: optional string or null` - Number of plugin selections added or whose enabled state changed. + Withdrawn — never populated. - - `new_value: optional string or null` + - `new_checksum: optional string or null` - The targeted plugin's new enabled state, when a single plugin's state changed. + Checksum of the guide content after this change; null when the guide was deleted. - `organization_id: optional string or null` @@ -27733,17 +27506,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional string or null` + - `previous_checksum: optional string or null` - The targeted plugin's previous enabled state, when a single plugin's state changed; null when the plugin did not previously exist or multiple plugins changed. + Checksum of the guide content before this change; null when the guide did not exist. - - `type: optional "claude_code_user_plugins_updated"` + - `type: optional "claude_code_team_onboarding_guide_updated"` - default: claude_code_user_plugins_updated + default: claude_code_team_onboarding_guide_updated - - `ClaudeCodeUserSettingsUpdated object` + - `ClaudeCodeUserMarketplacesUpdated object` - A user's synced Claude Code settings were updated or deleted on Anthropic servers. + A user's Claude Code plugin marketplace selections were updated on Anthropic servers. - `actor: object or object or object or 8 more` @@ -27958,7 +27731,7 @@ compliance activities that can be filtered by various criteria. - `deleted_all: boolean` - True when the user's entire synced settings store was deleted in one request. + True when all of the user's marketplace selections were removed in one request. - `id: optional string` @@ -27976,7 +27749,7 @@ compliance activities that can be filtered by various criteria. - `keys_deleted_count: optional number or null` - Number of settings entries removed. + Number of marketplace selections removed. - `keys_written: optional array of string` @@ -27984,11 +27757,11 @@ compliance activities that can be filtered by various criteria. - `keys_written_count: optional number or null` - Number of settings entries created or updated. + Number of marketplace selections added or whose source changed. - - `new_checksum: optional string or null` + - `new_value: optional string or null` - Checksum of the user's synced settings after this change. + Withdrawn — never populated. - `organization_id: optional string or null` @@ -27998,17 +27771,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_checksum: optional string or null` + - `previous_value: optional string or null` - Checksum of the user's synced settings before this change; null when the store did not exist. + Withdrawn — never populated. - - `type: optional "claude_code_user_settings_updated"` + - `type: optional "claude_code_user_marketplaces_updated"` - default: claude_code_user_settings_updated + default: claude_code_user_marketplaces_updated - - `ClaudeFileAccessFailed object` + - `ClaudeCodeUserMemoryUpdated object` - A user was denied access to a file in Claude.ai. + A user's synced private Claude Code memory was updated or deleted on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28221,27 +27994,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` + - `deleted_all: boolean` - The file the user was denied access to, e.g. "claude_file_01HX...". + True when the user's entire synced memory for this scope was deleted in one request. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_id: optional string or null` + - `created_at: optional string` - The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + When this activity occurred. - - `claude_project_id: optional string or null` + format: date-time - The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `keys_deleted: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_deleted_count`. - When this activity occurred. + - `keys_deleted_count: optional number or null` - format: date-time + Number of memory file paths removed. + + - `keys_written: optional array of string` + + Withdrawn — never populated. See `keys_written_count`. + + - `keys_written_count: optional number or null` + + Number of memory file paths created or updated. + + - `new_checksum: optional string or null` + + Checksum of the user's synced memory after this change. - `organization_id: optional string or null` @@ -28251,19 +28036,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_access_failed"` + - `previous_checksum: optional string or null` - default: claude_file_access_failed + Checksum of the user's synced memory before this change; null when the store did not exist. - - `filename: optional string or null` + - `repo: optional string or null` - **Deprecated** + Withdrawn — never populated. - Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + - `type: optional "claude_code_user_memory_updated"` - - `ClaudeFileExported object` + default: claude_code_user_memory_updated - A file was exported from Claude to an external storage destination. + - `ClaudeCodeUserPluginsUpdated object` + + A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28476,35 +28263,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `export_destination: "google_drive" or "unspecified"` + - `deleted_all: boolean` - The external destination the file was exported to. + True when all of the user's plugin selections were removed in one request. - - `"google_drive"` + - `id: optional string` - - `"unspecified"` + Unique identifier for the activity e.g. 'activity_abcd1234' - - `filename: string` + - `created_at: optional string` - Name of the exported file. + When this activity occurred. - - `id: optional string` + format: date-time - Unique identifier for the activity e.g. 'activity_abcd1234' + - `keys_deleted: optional array of string` - - `claude_chat_id: optional string or null` + Withdrawn — never populated. See `keys_deleted_count`. - The chat conversation the file was exported from, if the export originated in a chat, e.g. "claude_chat_01HX...". + - `keys_deleted_count: optional number or null` - - `claude_file_id: optional string or null` + Number of plugin selections removed. - The exported file, e.g. "claude_file_01HX...", if the file has a stored file record; files that exist only inside a session have no file ID. + - `keys_written: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_written_count`. - When this activity occurred. + - `keys_written_count: optional number or null` - format: date-time + Number of plugin selections added or whose enabled state changed. + + - `new_value: optional string or null` + + The targeted plugin's new enabled state, when a single plugin's state changed. - `organization_id: optional string or null` @@ -28514,13 +28305,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_exported"` + - `previous_value: optional string or null` - default: claude_file_exported + The targeted plugin's previous enabled state, when a single plugin's state changed; null when the plugin did not previously exist or multiple plugins changed. - - `ClaudeFileViewed object` + - `type: optional "claude_code_user_plugins_updated"` - A user viewed a file in Claude.ai. + default: claude_code_user_plugins_updated + + - `ClaudeCodeUserSettingsUpdated object` + + A user's synced Claude Code settings were updated or deleted on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28733,27 +28528,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` + - `deleted_all: boolean` - The file that was viewed, e.g. "claude_file_01HX...". + True when the user's entire synced settings store was deleted in one request. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_id: optional string or null` + - `created_at: optional string` - The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + When this activity occurred. - - `claude_project_id: optional string or null` + format: date-time - The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `keys_deleted: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_deleted_count`. - When this activity occurred. + - `keys_deleted_count: optional number or null` - format: date-time + Number of settings entries removed. + + - `keys_written: optional array of string` + + Withdrawn — never populated. See `keys_written_count`. + + - `keys_written_count: optional number or null` + + Number of settings entries created or updated. + + - `new_checksum: optional string or null` + + Checksum of the user's synced settings after this change. - `organization_id: optional string or null` @@ -28763,19 +28570,27 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_viewed"` + - `previous_checksum: optional string or null` - default: claude_file_viewed + Checksum of the user's synced settings before this change; null when the store did not exist. - - `filename: optional string or null` + - `type: optional "claude_code_user_settings_updated"` - **Deprecated** + default: claude_code_user_settings_updated - Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + - `ClaudeEnterpriseUpgradeCreditUpdated object` - - `ClaudeProjectSyncSourceCreated object` + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. - A sync source was connected to a Claude project's knowledge base. + - `action: "cancelled" or "resumed" or "unspecified"` + + Whether the credit was cancelled or turned back on + + - `"cancelled"` + + - `"resumed"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -28988,18 +28803,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` - - Tagged ID of the project the sync source was connected to. - - - `claude_project_sync_source_id: string` - - Tagged ID of the per-project sync source that was created. - - - `provider: string` - - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -29018,17 +28821,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_project_sync_source_created"` + - `type: optional "claude_enterprise_upgrade_credit_updated"` - default: claude_project_sync_source_created + default: claude_enterprise_upgrade_credit_updated - - `ClaudeProjectSyncSourceDeleted object` + - `ClaudeFileAccessFailed object` - A sync source was disconnected from a Claude project's knowledge base. + A user was denied access to a file in Claude.ai. - `actor: object or object or object or 8 more` @@ -29241,21 +29040,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `claude_file_id: string` - Tagged ID of the project the sync source was disconnected from. + The file the user was denied access to, e.g. "claude_file_01HX...". - - `claude_project_sync_source_id: string` + - `id: optional string` - Tagged ID of the per-project sync source that was deleted. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `provider: string` + - `claude_artifact_id: optional string or null` - The external provider backing the sync source. Always `unspecified` for deletion events. + The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". - - `id: optional string` + - `claude_project_id: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The project the file was accessed through, if any, e.g. "claude_proj_01HX...". - `created_at: optional string` @@ -29271,13 +29070,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_sync_source_deleted"` + - `type: optional "claude_file_access_failed"` - default: claude_project_sync_source_deleted + default: claude_file_access_failed - - `ClaudeProjectSyncSourceUpdated object` + - `filename: optional string or null` - A Claude project sync source's configuration was updated. + **Deprecated** + + Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + + - `ClaudeFileExported object` + + A file was exported from Claude to an external storage destination. - `actor: object or object or object or 8 more` @@ -29490,25 +29295,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `export_destination: "google_drive" or "unspecified"` - Tagged ID of the project the sync source belongs to. + The external destination the file was exported to. - - `claude_project_sync_source_id: string` + - `"google_drive"` - Tagged ID of the per-project sync source that was updated. + - `"unspecified"` - - `provider: string` + - `filename: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + Name of the exported file. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `config_changed: optional boolean or null` + - `claude_chat_id: optional string or null` - Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. + The chat conversation the file was exported from, if the export originated in a chat, e.g. "claude_chat_01HX...". + + - `claude_file_id: optional string or null` + + The exported file, e.g. "claude_file_01HX...", if the file has a stored file record; files that exist only inside a session have no file ID. - `created_at: optional string` @@ -29524,17 +29333,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_project_sync_source_updated"` + - `type: optional "claude_file_exported"` - default: claude_project_sync_source_updated + default: claude_file_exported - - `ClaudeUserSeatTierUpdated object` + - `ClaudeFileViewed object` - An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed. + A user viewed a file in Claude.ai. - `actor: object or object or object or 8 more` @@ -29747,28 +29552,28 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_email: string` - - Email address of the member at the time of the change. - - - `user_id: string` + - `claude_file_id: string` - Tagged ID of the member whose seat tier changed. + The file that was viewed, e.g. "claude_file_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_artifact_id: optional string or null` + + The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + + - `claude_project_id: optional string or null` + + The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time - - `current_seat_tier: optional string or null` - - The member's seat tier after this change, or null if the seat was removed. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -29777,17 +29582,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_seat_tier: optional string or null` + - `type: optional "claude_file_viewed"` - The member's seat tier before this change, or null if no seat was assigned. + default: claude_file_viewed - - `type: optional "claude_user_seat_tier_updated"` + - `filename: optional string or null` - default: claude_user_seat_tier_updated + **Deprecated** - - `CliPluginExecPolicyUpdated object` + Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. - Admin set or cleared the per-op permission ceiling for a plugin CLI. + - `ClaudeProjectSyncSourceCreated object` + + A sync source was connected to a Claude project's knowledge base. - `actor: object or object or object or 8 more` @@ -30000,25 +29807,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cli_name: string` - - CLI name as declared by the plugin manifest - - - `marketplace_id: string` - - Marketplace ID owning the plugin - - - `op_name: string` + - `claude_project_id: string` - Op name (or '*' for the per-CLI default) + Tagged ID of the project the sync source was connected to. - - `plugin_id: string` + - `claude_project_sync_source_id: string` - Plugin ID resolved from the URL + Tagged ID of the per-project sync source that was created. - - `plugin_name: string` + - `provider: string` - Plugin name within its marketplace + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - `id: optional string` @@ -30030,10 +29829,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `max_permission: optional string or null` - - New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -30042,17 +29837,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_max_permission: optional string or null` + - `resource_descriptor: optional string or null` - Max permission the op had before this change ('allow' | 'ask' | 'blocked'), or null when no policy existed for the op + A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `type: optional "cli_plugin_exec_policy_updated"` + - `type: optional "claude_project_sync_source_created"` - default: cli_plugin_exec_policy_updated + default: claude_project_sync_source_created - - `ClaudeCommandCreated object` + - `ClaudeProjectSyncSourceDeleted object` - Command was created. + A sync source was disconnected from a Claude project's knowledge base. - `actor: object or object or object or 8 more` @@ -30265,13 +30060,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `claude_project_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the project the sync source was disconnected from. - - `command_id: optional string or null` + - `claude_project_sync_source_id: string` - - `command_name: optional string or null` + Tagged ID of the per-project sync source that was deleted. + + - `provider: string` + + The external provider backing the sync source. Always `unspecified` for deletion events. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -30287,13 +30090,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_created"` + - `type: optional "claude_project_sync_source_deleted"` - default: claude_command_created + default: claude_project_sync_source_deleted - - `ClaudeCommandDeleted object` + - `ClaudeProjectSyncSourceUpdated object` - Command was deleted. + A Claude project sync source's configuration was updated. - `actor: object or object or object or 8 more` @@ -30506,13 +30309,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_project_id: string` + + Tagged ID of the project the sync source belongs to. + + - `claude_project_sync_source_id: string` + + Tagged ID of the per-project sync source that was updated. + + - `provider: string` + + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `command_id: optional string or null` + - `config_changed: optional boolean or null` - - `command_name: optional string or null` + Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - `created_at: optional string` @@ -30528,13 +30343,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_deleted"` + - `resource_descriptor: optional string or null` - default: claude_command_deleted + A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `ClaudeCommandReplaced object` + - `type: optional "claude_project_sync_source_updated"` - Command was replaced. + default: claude_project_sync_source_updated + + - `ClaudeUserSeatTierUpdated object` + + An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed. - `actor: object or object or object or 8 more` @@ -30747,13 +30566,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `user_email: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Email address of the member at the time of the change. - - `command_id: optional string or null` + - `user_id: string` - - `command_name: optional string or null` + Tagged ID of the member whose seat tier changed. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -30761,6 +30584,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_seat_tier: optional string or null` + + The member's seat tier after this change, or null if the seat was removed. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -30769,13 +30596,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_replaced"` + - `previous_seat_tier: optional string or null` - default: claude_command_replaced + The member's seat tier before this change, or null if no seat was assigned. - - `ComplianceAPIAccessed object` + - `type: optional "claude_user_seat_tier_updated"` - Logging event auto-generated for each compliance API request. + default: claude_user_seat_tier_updated + + - `CliPluginExecPolicyUpdated object` + + Admin set or cleared the per-op permission ceiling for a plugin CLI. - `actor: object or object or object or 8 more` @@ -30988,23 +30819,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `request_id: string` + - `cli_name: string` - - `request_method: "DELETE" or "GET" or "POST" or "PUT"` + CLI name as declared by the plugin manifest - - `"DELETE"` + - `marketplace_id: string` - - `"GET"` + Marketplace ID owning the plugin - - `"POST"` + - `op_name: string` - - `"PUT"` + Op name (or '*' for the per-CLI default) - - `status_code: number` + - `plugin_id: string` - HTTP status code + Plugin ID resolved from the URL - - `url: string` + - `plugin_name: string` + + Plugin name within its marketplace - `id: optional string` @@ -31016,6 +30849,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `max_permission: optional string or null` + + New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -31024,17 +30861,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `request_body: optional string or null` + - `previous_max_permission: optional string or null` - Serialized JSON request body + Max permission the op had before this change ('allow' | 'ask' | 'blocked'), or null when no policy existed for the op - - `type: optional "compliance_api_accessed"` + - `type: optional "cli_plugin_exec_policy_updated"` - default: compliance_api_accessed + default: cli_plugin_exec_policy_updated - - `CoworkSessionUpdated object` + - `ClaudeCommandCreated object` - A Cowork session was updated. + Command was created. - `actor: object or object or object or 8 more` @@ -31247,17 +31084,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cowork_session_id: string` - - Tagged ID of the updated session, e.g. "sess_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` + - `command_id: optional string or null` - Tagged ID of the project the session was moved to, if any, e.g. "claude_proj_01HX...". Absent when the session was removed from its project. + - `command_name: optional string or null` - `created_at: optional string` @@ -31273,13 +31106,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "cowork_session_updated"` + - `type: optional "claude_command_created"` - default: cowork_session_updated + default: claude_command_created - - `DesignProjectArtifactPublished object` + - `ClaudeCommandDeleted object` - A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings. + Command was deleted. - `actor: object or object or object or 8 more` @@ -31492,24 +31325,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project whose content was published, e.g. "design_proj_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `command_id: optional string or null` + + - `command_name: optional string or null` + - `created_at: optional string` When this activity occurred. format: date-time - - `is_public: optional boolean or null` - - True when the published artifact is publicly viewable after this call (anyone with the link). False when it is not — by default, a newly published artifact is visible only to the person who published it. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -31518,17 +31347,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_artifact_published"` + - `type: optional "claude_command_deleted"` - default: design_project_artifact_published + default: claude_command_deleted - - `DesignProjectCreated object` + - `ClaudeCommandReplaced object` - A Claude Design project was created. + Command was replaced. - `actor: object or object or object or 8 more` @@ -31741,18 +31566,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `creation_method: string` - - How the project was created: "direct", "duplicate", "remix", or "template_from_project". - - - `design_project_id: string` - - The Design project that was created, e.g. "design_proj_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `command_id: optional string or null` + + - `command_name: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -31767,21 +31588,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project type: "project", "template", or "design_system". - - - `source_project_id: optional string or null` - - The source project this was created from, when created via duplicate, remix, or template-from-project. Unset for direct creation. - - - `type: optional "design_project_created"` + - `type: optional "claude_command_replaced"` - default: design_project_created + default: claude_command_replaced - - `DesignProjectDeleted object` + - `ComplianceAPIAccessed object` - A Claude Design project was deleted. + Logging event auto-generated for each compliance API request. - `actor: object or object or object or 8 more` @@ -31994,9 +31807,31 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` + - `request_id: string` - The Design project that was deleted, e.g. "design_proj_01HX...". + Identifier of the request, as returned in the response's request-id header + + - `request_method: "DELETE" or "GET" or "POST" or 2 more` + + HTTP method of the request + + - `"DELETE"` + + - `"GET"` + + - `"POST"` + + - `"PUT"` + + - `"unspecified"` + + - `status_code: number` + + HTTP status code + + - `url: string` + + Full URL that was requested, including any query string - `id: optional string` @@ -32016,13 +31851,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "design_project_deleted"` + - `request_body: optional string or null` - default: design_project_deleted + Serialized JSON request body - - `DesignProjectMemberAdded object` + - `type: optional "compliance_api_accessed"` - A member was granted access to a Claude Design project. + default: compliance_api_accessed + + - `CoworkSessionUpdated object` + + A Cowork session was updated. - `actor: object or object or object or 8 more` @@ -32235,26 +32074,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project the member was added to, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` - - The kind of member that was added: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). - - - `role: string` + - `cowork_session_id: string` - The role the member was granted: "viewer", "commenter", or "editor". Access-group ("compartment") members are always view-only. + Tagged ID of the updated session, e.g. "sess_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the session was moved to, if any, e.g. "claude_proj_01HX...". Absent when the session was removed from its project. + - `created_at: optional string` When this activity occurred. @@ -32269,17 +32100,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_member_added"` + - `type: optional "cowork_session_updated"` - default: design_project_member_added + default: cowork_session_updated - - `DesignProjectMemberRemoved object` + - `DesignProjectArtifactPublished object` - A member's access to a Claude Design project was revoked. + A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings. - `actor: object or object or object or 8 more` @@ -32494,15 +32321,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project the member was removed from, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` - - The kind of member that was removed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + The Design project whose content was published, e.g. "design_proj_01HX...". - `id: optional string` @@ -32514,6 +32333,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `is_public: optional boolean or null` + + True when the published artifact is publicly viewable after this call (anyone with the link). False when it is not — by default, a newly published artifact is visible only to the person who published it. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -32526,13 +32349,13 @@ compliance activities that can be filtered by various criteria. The project's type: "project", "template", or "design_system". - - `type: optional "design_project_member_removed"` + - `type: optional "design_project_artifact_published"` - default: design_project_member_removed + default: design_project_artifact_published - - `DesignProjectMemberRoleUpdated object` + - `DesignProjectCreated object` - A Claude Design project member's role was changed. + A Claude Design project was created. - `actor: object or object or object or 8 more` @@ -32745,21 +32568,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project the member belongs to, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` + - `creation_method: string` - The kind of member whose role was changed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + How the project was created: "direct", "duplicate", "remix", or "template_from_project". - - `role: string` + - `design_project_id: string` - The member's role after the change: "viewer", "commenter", or "editor". + The Design project that was created, e.g. "design_proj_01HX...". - `id: optional string` @@ -32779,21 +32594,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_role: optional string or null` + - `project_type: optional string or null` - The member's role before the change. + The project type: "project", "template", or "design_system". - - `project_type: optional string or null` + - `source_project_id: optional string or null` - The project's type: "project", "template", or "design_system". + The source project this was created from, when created via duplicate, remix, or template-from-project. Unset for direct creation. - - `type: optional "design_project_member_role_updated"` + - `type: optional "design_project_created"` - default: design_project_member_role_updated + default: design_project_created - - `DesignProjectPublished object` + - `DesignProjectDeleted object` - A Claude Design template or design system was published, making it discoverable by everyone in its organization. + A Claude Design project was deleted. - `actor: object or object or object or 8 more` @@ -33008,7 +32823,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was published, e.g. "design_proj_01HX...". + The Design project that was deleted, e.g. "design_proj_01HX...". - `id: optional string` @@ -33028,17 +32843,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "template" or "design_system". - - - `type: optional "design_project_published"` + - `type: optional "design_project_deleted"` - default: design_project_published + default: design_project_deleted - - `DesignProjectSharingUpdated object` + - `DesignProjectMemberAdded object` - A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added). + A member was granted access to a Claude Design project. - `actor: object or object or object or 8 more` @@ -33253,15 +33064,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project whose sharing settings changed, e.g. "design_proj_01HX...". + The Design project the member was added to, e.g. "design_proj_01HX...". - - `new_link_permission: string` + - `principal_id: string` - What people opening the project through its link may do after the change: "view", "comment", or "edit". + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - `new_scope: string` + - `principal_type: string` - Who the project link is set to work for after the change: "invited" (only the owner and individually invited members) or "org" (anyone in the project's organization, where the organization's own sharing settings allow org-wide visibility). This records the project's stored setting as changed by the actor; organization-level settings can further restrict who the link actually admits, and changes to those settings are not project events. Projects created before link sharing was restricted may also report a legacy "public" value. + The kind of member that was added: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + + - `role: string` + + The role the member was granted: "viewer", "commenter", or "editor". Access-group ("compartment") members are always view-only. - `id: optional string` @@ -33281,25 +33096,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_link_permission: optional string or null` - - What people opening the project through its link could do before the change. - - - `previous_scope: optional string or null` - - Who the project link was set to work for before the change — the stored setting, with the same organization-level caveat as new_scope. May include the legacy "public" value. - - `project_type: optional string or null` The project's type: "project", "template", or "design_system". - - `type: optional "design_project_sharing_updated"` + - `type: optional "design_project_member_added"` - default: design_project_sharing_updated + default: design_project_member_added - - `DesignProjectUnpublished object` + - `DesignProjectMemberRemoved object` - A Claude Design template or design system was unpublished, removing it from its organization's shared gallery. + A member's access to a Claude Design project was revoked. - `actor: object or object or object or 8 more` @@ -33514,7 +33321,15 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was unpublished, e.g. "design_proj_01HX...". + The Design project the member was removed from, e.g. "design_proj_01HX...". + + - `principal_id: string` + + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". + + - `principal_type: string` + + The kind of member that was removed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). - `id: optional string` @@ -33536,15 +33351,15 @@ compliance activities that can be filtered by various criteria. - `project_type: optional string or null` - The project's type: "template" or "design_system". + The project's type: "project", "template", or "design_system". - - `type: optional "design_project_unpublished"` + - `type: optional "design_project_member_removed"` - default: design_project_unpublished + default: design_project_member_removed - - `DesignProjectUpdated object` + - `DesignProjectMemberRoleUpdated object` - A Claude Design project's metadata was updated. + A Claude Design project member's role was changed. - `actor: object or object or object or 8 more` @@ -33759,7 +33574,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was updated, e.g. "design_proj_01HX...". + The Design project the member belongs to, e.g. "design_proj_01HX...". + + - `principal_id: string` + + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". + + - `principal_type: string` + + The kind of member whose role was changed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + + - `role: string` + + The member's role after the change: "viewer", "commenter", or "editor". - `id: optional string` @@ -33779,21 +33606,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` + - `previous_role: optional string or null` - The project's type after the update: "project", "template", or "design_system". Present only when the update changed it. + The member's role before the change. - - `type: optional "design_project_updated"` + - `project_type: optional string or null` - default: design_project_updated + The project's type: "project", "template", or "design_system". - - `updated_fields: optional array of string` + - `type: optional "design_project_member_role_updated"` - Names of the fields changed by this update, e.g. "name", "description", "project_type", "design_systems". + default: design_project_member_role_updated - - `DesignProjectVersionRestored object` + - `DesignProjectPublished object` - A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files. + A Claude Design template or design system was published, making it discoverable by everyone in its organization. - `actor: object or object or object or 8 more` @@ -34008,7 +33835,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was restored, e.g. "design_proj_01HX...". + The Design project that was published, e.g. "design_proj_01HX...". - `id: optional string` @@ -34030,19 +33857,15 @@ compliance activities that can be filtered by various criteria. - `project_type: optional string or null` - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_version_restored"` + The project's type: "template" or "design_system". - default: design_project_version_restored + - `type: optional "design_project_published"` - - `DesignProjectViewed object` + default: design_project_published - A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader. + - `DesignProjectSharingUpdated object` - This activity type is retired: project content reads are no longer - recorded. Events of this type may still appear in feeds for reads that - occurred while it was active. + A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added). - `actor: object or object or object or 8 more` @@ -34257,19 +34080,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project whose content was read, e.g. "design_proj_01HX...". + The Design project whose sharing settings changed, e.g. "design_proj_01HX...". - - `surface: string` + - `new_link_permission: string` - Which read surface recorded this open: "project" (the project was opened), "project_data" (the project's full contents were read or made readable — either a direct data read, which also includes the project's conversations when the reader's access extends to them, or a render-token request, which exposes the project's files for the token's lifetime; the two share this value and are not distinguished), "file" (one of the project's files was read), "version" (a saved version of the project's files, including their contents, was read — version-history browsing that lists names without contents is not recorded), or "export" (an authenticated export of the project's contents was requested). + What people opening the project through its link may do after the change: "view", "comment", or "edit". - - `id: optional string` + - `new_scope: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Who the project link is set to work for after the change: "invited" (only the owner and individually invited members) or "org" (anyone in the project's organization, where the organization's own sharing settings allow org-wide visibility). This records the project's stored setting as changed by the actor; organization-level settings can further restrict who the link actually admits, and changes to those settings are not project events. Projects created before link sharing was restricted may also report a legacy "public" value. - - `access_via: optional string or null` + - `id: optional string` - How the viewer was authorized to open the project: "owner" (the project's owner), "member_grant" (an individually invited member), "org_link" (org-wide link sharing), "trusted_service" (an authorized agent), or "design_system_reference" (an indirect read of a design system through a project that uses it). + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -34285,17 +34108,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `previous_link_permission: optional string or null` + + What people opening the project through its link could do before the change. + + - `previous_scope: optional string or null` + + Who the project link was set to work for before the change — the stored setting, with the same organization-level caveat as new_scope. May include the legacy "public" value. + - `project_type: optional string or null` The project's type: "project", "template", or "design_system". - - `type: optional "design_project_viewed"` + - `type: optional "design_project_sharing_updated"` - default: design_project_viewed + default: design_project_sharing_updated - - `DesktopExtensionAllowlisted object` + - `DesignProjectUnpublished object` - A desktop extension was added to an org's allowlist. + A Claude Design template or design system was unpublished, removing it from its organization's shared gallery. - `actor: object or object or object or 8 more` @@ -34508,9 +34339,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - Allowlisted DXT extension ID + The Design project that was unpublished, e.g. "design_proj_01HX...". - `id: optional string` @@ -34530,13 +34361,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_allowlisted"` + - `project_type: optional string or null` - default: desktop_extension_allowlisted + The project's type: "template" or "design_system". - - `DesktopExtensionBlocklisted object` + - `type: optional "design_project_unpublished"` - A desktop extension was added to the global blocklist. + default: design_project_unpublished + + - `DesignProjectUpdated object` + + A Claude Design project's metadata was updated. - `actor: object or object or object or 8 more` @@ -34749,9 +34584,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - Blocklisted DXT extension ID + The Design project that was updated, e.g. "design_proj_01HX...". - `id: optional string` @@ -34771,13 +34606,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_blocklisted"` + - `project_type: optional string or null` - default: desktop_extension_blocklisted + The project's type after the update: "project", "template", or "design_system". Present only when the update changed it. - - `DesktopExtensionDeleted object` + - `type: optional "design_project_updated"` - A desktop extension was deleted, either globally by an admin or org-scoped by an org owner. + default: design_project_updated + + - `updated_fields: optional array of string` + + Names of the fields changed by this update, e.g. "name", "description", "project_type", "design_systems". + + - `DesignProjectVersionRestored object` + + A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files. - `actor: object or object or object or 8 more` @@ -34990,9 +34833,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - DXT extension ID + The Design project that was restored, e.g. "design_proj_01HX...". - `id: optional string` @@ -35012,17 +34855,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_deleted"` + - `project_type: optional string or null` - default: desktop_extension_deleted + The project's type: "project", "template", or "design_system". - - `version: optional string or null` + - `type: optional "design_project_version_restored"` - Specific version deleted (null if all versions) + default: design_project_version_restored - - `DesktopExtensionRemovedFromAllowlist object` + - `DesignProjectViewed object` - A desktop extension was removed from an org's allowlist. + A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader. + + This activity type is retired: project content reads are no longer + recorded. Events of this type may still appear in feeds for reads that + occurred while it was active. - `actor: object or object or object or 8 more` @@ -35235,14 +35082,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - DXT extension ID removed from allowlist + The Design project whose content was read, e.g. "design_proj_01HX...". + + - `surface: string` + + Which read surface recorded this open: "project" (the project was opened), "project_data" (the project's full contents were read or made readable — either a direct data read, which also includes the project's conversations when the reader's access extends to them, or a render-token request, which exposes the project's files for the token's lifetime; the two share this value and are not distinguished), "file" (one of the project's files was read), "version" (a saved version of the project's files, including their contents, was read — version-history browsing that lists names without contents is not recorded), or "export" (an authenticated export of the project's contents was requested). - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_via: optional string or null` + + How the viewer was authorized to open the project: "owner" (the project's owner), "member_grant" (an individually invited member), "org_link" (org-wide link sharing), "trusted_service" (an authorized agent), or "design_system_reference" (an indirect read of a design system through a project that uses it). + - `created_at: optional string` When this activity occurred. @@ -35257,13 +35112,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_removed_from_allowlist"` + - `project_type: optional string or null` - default: desktop_extension_removed_from_allowlist + The project's type: "project", "template", or "design_system". - - `DesktopExtensionUnblocked object` + - `type: optional "design_project_viewed"` - A desktop extension was removed from the global blocklist. + default: design_project_viewed + + - `DesktopExtensionAllowlisted object` + + A desktop extension was added to an org's allowlist. - `actor: object or object or object or 8 more` @@ -35478,7 +35337,7 @@ compliance activities that can be filtered by various criteria. - `extension_id: string` - Unblocked DXT extension ID + Allowlisted DXT extension ID - `id: optional string` @@ -35498,13 +35357,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_unblocked"` + - `type: optional "desktop_extension_allowlisted"` - default: desktop_extension_unblocked + default: desktop_extension_allowlisted - - `DesktopExtensionUploaded object` + - `DesktopExtensionBlocklisted object` - A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner. + A desktop extension was added to the global blocklist. - `actor: object or object or object or 8 more` @@ -35719,11 +35578,7 @@ compliance activities that can be filtered by various criteria. - `extension_id: string` - DXT extension ID - - - `version: string` - - Version string from the manifest + Blocklisted DXT extension ID - `id: optional string` @@ -35743,13 +35598,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_uploaded"` + - `type: optional "desktop_extension_blocklisted"` - default: desktop_extension_uploaded + default: desktop_extension_blocklisted - - `DesktopExtensionVersionUploaded object` + - `DesktopExtensionDeleted object` - A new version of an existing org-owned desktop extension was uploaded. + A desktop extension was deleted, either globally by an admin or org-scoped by an org owner. - `actor: object or object or object or 8 more` @@ -35966,10 +35821,6 @@ compliance activities that can be filtered by various criteria. DXT extension ID - - `version: string` - - Version string from the manifest - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -35988,14 +35839,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_version_uploaded"` + - `type: optional "desktop_extension_deleted"` - default: desktop_extension_version_uploaded + default: desktop_extension_deleted - - `InferenceHooksConfigDeleted object` + - `version: optional string or null` - Inference hooks configuration was removed for the - organization. + Specific version deleted (null if all versions) + + - `DesktopExtensionRemovedFromAllowlist object` + + A desktop extension was removed from an org's allowlist. - `actor: object or object or object or 8 more` @@ -36208,6 +36062,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `extension_id: string` + + DXT extension ID removed from allowlist + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -36226,14 +36084,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "inference_hooks_config_deleted"` + - `type: optional "desktop_extension_removed_from_allowlist"` - default: inference_hooks_config_deleted + default: desktop_extension_removed_from_allowlist - - `InferenceHooksConfigUpdated object` + - `DesktopExtensionUnblocked object` - Inference hooks configuration was created or updated for the - organization. + A desktop extension was removed from the global blocklist. - `actor: object or object or object or 8 more` @@ -36446,29 +36303,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - Whether Inference hooks enforcement is enabled after this change. - - - `enforcement_mode: string` - - Whether Inference hooks inspects both prompts and responses (prompt_and_response) or prompts only (prompt_only). - - - `fail_mode: string` - - Whether requests are allowed (fail_open) or blocked (fail_closed) when the Inference hooks endpoint cannot be reached. - - - `final_verdict_timeout_ms: number` - - Milliseconds inference waits for the Inference hooks verdict on the response. - - - `prompt_verdict_timeout_ms: number` - - Milliseconds inference waits for the Inference hooks verdict on the prompt. - - - `webhook_url: string` + - `extension_id: string` - The endpoint that inspected prompts and responses are sent to. + Unblocked DXT extension ID - `id: optional string` @@ -36480,20 +36317,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `deny_message: optional string or null` - - Administrator-written text shown to users at the end of the error message when a request is blocked by the organization's Inference hooks policy, as configured after this change. Null when the built-in default message is in effect; an empty string when the administrator configured an empty message, in which case no text is appended. - - - `deny_message_enabled: optional boolean` - - Whether the organization has the appended deny message turned on, as configured after this change. When on, the administrator-written message (or the built-in default, when none is configured) is appended to the error users see when a request is blocked by the organization's Inference hooks policy; no text is appended when the administrator-written message is empty, or when this is off. - - default: true - - - `extra_header_names: optional array of string or null` - - Names of the custom HTTP headers attached to every Inference hooks request after this change, or null when this update did not change headers. Header values are write-only and are not recorded. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -36502,28 +36325,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reset_circuit_breaker: optional boolean` - - Whether this update carried an explicit request to clear the circuit breaker. A tripped breaker otherwise survives configuration updates; it also clears whenever an update enables enforcement. - - default: false - - - `rollout_percentage: optional number or null` - - Percentage of requests (0-100) inspected by Inference hooks after this change, or null when this update did not change it. 0 disables inspection; 100 inspects every request. - - - `shadow_mode: optional boolean or null` - - Whether the organization's Inference hooks run in shadow mode after this change, or null when this update did not change it. In shadow mode, prompts are still sent to the organization's endpoint and verdicts are recorded, but requests are never blocked. - - - `type: optional "inference_hooks_config_updated"` + - `type: optional "desktop_extension_unblocked"` - default: inference_hooks_config_updated + default: desktop_extension_unblocked - - `InferenceHooksSigningSecretGenerated object` + - `DesktopExtensionUploaded object` - A request signing secret was generated for the organization's - Inference hooks configuration. + A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner. - `actor: object or object or object or 8 more` @@ -36736,9 +36544,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `rotated: boolean` + - `extension_id: string` - Whether this generation replaced an existing signing secret (true) or created the organization's first one (false). Replacing a secret invalidates the previous one immediately. + DXT extension ID + + - `version: string` + + Version string from the manifest - `id: optional string` @@ -36758,13 +36570,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "inference_hooks_signing_secret_generated"` + - `type: optional "desktop_extension_uploaded"` - default: inference_hooks_signing_secret_generated + default: desktop_extension_uploaded - - `DomainClaimInitiated object` + - `DesktopExtensionVersionUploaded object` - Domain capture claim initiated over personal accounts on verified domains. + A new version of an existing org-owned desktop extension was uploaded. - `actor: object or object or object or 8 more` @@ -36977,6 +36789,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `extension_id: string` + + DXT extension ID + + - `version: string` + + Version string from the manifest + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -36995,13 +36815,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "domain_claim_initiated"` + - `type: optional "desktop_extension_version_uploaded"` - default: domain_claim_initiated + default: desktop_extension_version_uploaded - - `EndUserInviteRequested object` + - `InferenceHooksConfigDeleted object` - Non-admin member submitted an invite request for a new org member. + Inference hooks configuration was removed for the + organization. - `actor: object or object or object or 8 more` @@ -37214,8 +37035,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37234,13 +37053,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "end_user_invite_requested"` + - `type: optional "inference_hooks_config_deleted"` - default: end_user_invite_requested + default: inference_hooks_config_deleted - - `ExtraUsageBillingEnabled object` + - `InferenceHooksConfigUpdated object` - Usage credit billing was enabled for an organization. + Inference hooks configuration was created or updated for the + organization. - `actor: object or object or object or 8 more` @@ -37453,6 +37273,30 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + + Whether Inference hooks enforcement is enabled after this change. + + - `enforcement_mode: string` + + Whether Inference hooks inspects both prompts and responses (prompt_and_response) or prompts only (prompt_only). + + - `fail_mode: string` + + Whether requests are allowed (fail_open) or blocked (fail_closed) when the Inference hooks endpoint cannot be reached. + + - `final_verdict_timeout_ms: number` + + Milliseconds inference waits for the Inference hooks verdict on the response. + + - `prompt_verdict_timeout_ms: number` + + Milliseconds inference waits for the Inference hooks verdict on the prompt. + + - `webhook_url: string` + + The endpoint that inspected prompts and responses are sent to. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37463,6 +37307,20 @@ compliance activities that can be filtered by various criteria. format: date-time + - `deny_message: optional string or null` + + Administrator-written text shown to users at the end of the error message when a request is blocked by the organization's Inference hooks policy, as configured after this change. Null when the built-in default message is in effect; an empty string when the administrator configured an empty message, in which case no text is appended. + + - `deny_message_enabled: optional boolean` + + Whether the organization has the appended deny message turned on, as configured after this change. When on, the administrator-written message (or the built-in default, when none is configured) is appended to the error users see when a request is blocked by the organization's Inference hooks policy; no text is appended when the administrator-written message is empty, or when this is off. + + default: true + + - `extra_header_names: optional array of string or null` + + Names of the custom HTTP headers attached to every Inference hooks request after this change, or null when this update did not change headers. Header values are write-only and are not recorded. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -37471,13 +37329,28 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "extra_usage_billing_enabled"` + - `reset_circuit_breaker: optional boolean` - default: extra_usage_billing_enabled + Whether this update carried an explicit request to clear the circuit breaker. A tripped breaker otherwise survives configuration updates; it also clears whenever an update enables enforcement. - - `ExtraUsageCreditGranted object` + default: false - A promotional usage credit grant was claimed. + - `rollout_percentage: optional number or null` + + Percentage of requests (0-100) inspected by Inference hooks after this change, or null when this update did not change it. 0 disables inspection; 100 inspects every request. + + - `shadow_mode: optional boolean or null` + + Whether the organization's Inference hooks run in shadow mode after this change, or null when this update did not change it. In shadow mode, prompts are still sent to the organization's endpoint and verdicts are recorded, but requests are never blocked. + + - `type: optional "inference_hooks_config_updated"` + + default: inference_hooks_config_updated + + - `InferenceHooksSigningSecretGenerated object` + + A request signing secret was generated for the organization's + Inference hooks configuration. - `actor: object or object or object or 8 more` @@ -37690,6 +37563,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `rotated: boolean` + + Whether this generation replaced an existing signing secret (true) or created the organization's first one (false). Replacing a secret invalidates the previous one immediately. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37708,13 +37585,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "extra_usage_credit_granted"` + - `type: optional "inference_hooks_signing_secret_generated"` - default: extra_usage_credit_granted + default: inference_hooks_signing_secret_generated - - `ExtraUsageSpendLimitCreated object` + - `DomainClaimInitiated object` - Usage credit spend limit was created. + Domain capture claim initiated over personal accounts on verified domains. - `actor: object or object or object or 8 more` @@ -37931,24 +37808,12 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `amount: optional number or null` - - The monthly credit limit amount in minor units (e.g. cents). - - `created_at: optional string` When this activity occurred. format: date-time - - `is_enabled: optional boolean or null` - - Whether the spend limit is enabled. - - - `limit_type: optional string or null` - - The type of spend limit created (e.g. organization, seat_tier, member, service, group). - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -37957,23 +37822,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - Tagged ID of the spend limit. - - - `type: optional "extra_usage_spend_limit_created"` - - default: extra_usage_spend_limit_created - - - `user_id: optional string or null` - - **Deprecated** + - `type: optional "domain_claim_initiated"` - Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + default: domain_claim_initiated - - `ExtraUsageSpendLimitDeleted object` + - `EndUserInviteRequested object` - Usage credit spend limit was deleted. + Non-admin member submitted an invite request for a new org member. - `actor: object or object or object or 8 more` @@ -38186,6 +38041,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invitee_email: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -38204,23 +38061,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - Tagged ID of the spend limit. - - - `type: optional "extra_usage_spend_limit_deleted"` - - default: extra_usage_spend_limit_deleted - - - `user_id: optional string or null` - - **Deprecated** + - `type: optional "end_user_invite_requested"` - Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + default: end_user_invite_requested - - `ExtraUsageSpendLimitIncreaseRequestApproved object` + - `ExtraUsageBillingEnabled object` - A usage credit spend limit increase request was approved. + Usage credit billing was enabled for an organization. - `actor: object or object or object or 8 more` @@ -38437,8 +38284,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `amount: optional number or null` - - `created_at: optional string` When this activity occurred. @@ -38453,19 +38298,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `requester_user_id: optional string or null` - - - `spend_limit_id: optional string or null` - - - `spend_limit_increase_request_id: optional string or null` - - - `type: optional "extra_usage_spend_limit_increase_request_approved"` + - `type: optional "extra_usage_billing_enabled"` - default: extra_usage_spend_limit_increase_request_approved + default: extra_usage_billing_enabled - - `ExtraUsageSpendLimitIncreaseRequestDenied object` + - `ExtraUsageCreditGranted object` - A usage credit spend limit increase request was denied. + A promotional usage credit grant was claimed. - `actor: object or object or object or 8 more` @@ -38696,17 +38535,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `requester_user_id: optional string or null` - - - `spend_limit_increase_request_id: optional string or null` - - - `type: optional "extra_usage_spend_limit_increase_request_denied"` + - `type: optional "extra_usage_credit_granted"` - default: extra_usage_spend_limit_increase_request_denied + default: extra_usage_credit_granted - - `ExtraUsageSpendLimitUpdated object` + - `ExtraUsageSpendLimitCreated object` - Usage credit spend limit was updated. + Usage credit spend limit was created. - `actor: object or object or object or 8 more` @@ -38925,7 +38760,7 @@ compliance activities that can be filtered by various criteria. - `amount: optional number or null` - The new monthly credit limit amount in minor units (e.g. cents). + The monthly credit limit amount in minor units (e.g. cents). - `created_at: optional string` @@ -38939,7 +38774,7 @@ compliance activities that can be filtered by various criteria. - `limit_type: optional string or null` - The type of spend limit updated (e.g. organization, seat_tier, member, service, group). + The type of spend limit created (e.g. organization, seat_tier, member, service, group). - `organization_id: optional string or null` @@ -38953,9 +38788,9 @@ compliance activities that can be filtered by various criteria. Tagged ID of the spend limit. - - `type: optional "extra_usage_spend_limit_updated"` + - `type: optional "extra_usage_spend_limit_created"` - default: extra_usage_spend_limit_updated + default: extra_usage_spend_limit_created - `user_id: optional string or null` @@ -38963,9 +38798,9 @@ compliance activities that can be filtered by various criteria. Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. - - `ClaudeFileDeleted object` + - `ExtraUsageSpendLimitDeleted object` - A file was deleted. + Usage credit spend limit was deleted. - `actor: object or object or object or 8 more` @@ -39178,10 +39013,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` - - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -39200,13 +39031,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_deleted"` + - `spend_limit_id: optional string or null` - default: claude_file_deleted + Tagged ID of the spend limit. - - `ClaudeFileUploaded object` + - `type: optional "extra_usage_spend_limit_deleted"` - A file was uploaded. + default: extra_usage_spend_limit_deleted + + - `user_id: optional string or null` + + **Deprecated** + + Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + + - `ExtraUsageSpendLimitIncreaseRequestApproved object` + + A usage credit spend limit increase request was approved. - `actor: object or object or object or 8 more` @@ -39419,21 +39260,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` - - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` - - Chat ID if known at upload time (null for the upload-then-attach flow). To find which chats a file was later attached to, use `GET /v1/compliance/apps/chats/files/{claude_file_id}`. - - - `claude_project_id: optional string or null` - - Project ID if file was uploaded to a project + - `amount: optional number or null` - `created_at: optional string` @@ -39449,13 +39280,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_uploaded"` + - `requester_user_id: optional string or null` - default: claude_file_uploaded + - `spend_limit_id: optional string or null` - - `GheConfigurationCreated object` + - `spend_limit_increase_request_id: optional string or null` - Admin created a GHE configuration. + - `type: optional "extra_usage_spend_limit_increase_request_approved"` + + default: extra_usage_spend_limit_increase_request_approved + + - `ExtraUsageSpendLimitIncreaseRequestDenied object` + + A usage credit spend limit increase request was denied. - `actor: object or object or object or 8 more` @@ -39668,10 +39505,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` - - ID of the GHE configuration - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -39682,14 +39515,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `display_name: optional string or null` - - Display name given to the configuration - - - `hostname: optional string or null` - - Hostname of the GitHub Enterprise instance - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -39698,17 +39523,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` + - `requester_user_id: optional string or null` - Custom port, if not the HTTPS default + - `spend_limit_increase_request_id: optional string or null` - - `type: optional "ghe_configuration_created"` + - `type: optional "extra_usage_spend_limit_increase_request_denied"` - default: ghe_configuration_created + default: extra_usage_spend_limit_increase_request_denied - - `GheConfigurationDeleted object` + - `ExtraUsageSpendLimitUpdated object` - Admin deleted a GHE configuration. + Usage credit spend limit was updated. - `actor: object or object or object or 8 more` @@ -39921,27 +39746,27 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` - - ID of the GHE configuration - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `amount: optional number or null` + + The new monthly credit limit amount in minor units (e.g. cents). + - `created_at: optional string` When this activity occurred. format: date-time - - `display_name: optional string or null` + - `is_enabled: optional boolean or null` - Display name the configuration had when deleted + Whether the spend limit is enabled. - - `hostname: optional string or null` + - `limit_type: optional string or null` - Hostname of the GitHub Enterprise instance + The type of spend limit updated (e.g. organization, seat_tier, member, service, group). - `organization_id: optional string or null` @@ -39951,17 +39776,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` + - `spend_limit_id: optional string or null` - Custom port, if not the HTTPS default + Tagged ID of the spend limit. - - `type: optional "ghe_configuration_deleted"` + - `type: optional "extra_usage_spend_limit_updated"` - default: ghe_configuration_deleted + default: extra_usage_spend_limit_updated - - `GheConfigurationUpdated object` + - `user_id: optional string or null` - Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced. + **Deprecated** + + Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + + - `ClaudeFileDeleted object` + + A file was deleted. - `actor: object or object or object or 8 more` @@ -40174,9 +40005,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` + - `claude_file_id: string` - ID of the GHE configuration + - `filename: string or null` - `id: optional string` @@ -40188,38 +40019,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `custom_ca_certificate_updated: optional boolean or null` - - Whether the custom CA certificate was replaced in this update - - - `display_name: optional string or null` - - New display name, when it changed - - - `github_app_client_id: optional string or null` - - New GitHub App client ID, when it changed - - - `github_app_client_secret_updated: optional boolean or null` - - Whether the GitHub App client secret was replaced in this update - - - `github_app_id: optional number or null` - - New GitHub App ID, when it changed - - - `github_app_private_key_updated: optional boolean or null` - - Whether the GitHub App private key was replaced in this update - - - `hostname: optional string or null` - - Hostname of the GitHub Enterprise instance (immutable; included for context) - - - `is_active: optional boolean or null` - - New active state, when it changed - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40228,45 +40027,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` - - New port, when it changed - - - `previous_display_name: optional string or null` - - Display name before the change, when it changed - - - `previous_github_app_client_id: optional string or null` - - GitHub App client ID before the change, when it changed - - - `previous_github_app_id: optional number or null` - - GitHub App ID before the change, when it changed - - - `previous_is_active: optional boolean or null` - - Active state before the change, when it changed - - - `previous_port: optional number or null` - - Port before the change, when it changed - - - `read_replica_hostnames_updated: optional boolean or null` - - Whether the read replica hostnames were replaced in this update - - - `type: optional "ghe_configuration_updated"` - - default: ghe_configuration_updated - - - `webhook_secret_updated: optional boolean or null` + - `type: optional "claude_file_deleted"` - Whether the webhook secret was replaced in this update + default: claude_file_deleted - - `GheUserConnected object` + - `ClaudeFileUploaded object` - User connected to a GHE instance. + A file was uploaded. - `actor: object or object or object or 8 more` @@ -40479,20 +40246,28 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_file_id: string` + + - `filename: string or null` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_chat_id: optional string or null` + + Chat ID if known at upload time (null for the upload-then-attach flow). To find which chats a file was later attached to, use `GET /v1/compliance/apps/chats/files/{claude_file_id}`. + + - `claude_project_id: optional string or null` + + Project ID if file was uploaded to a project + - `created_at: optional string` When this activity occurred. format: date-time - - `ghe_configuration_id: optional string or null` - - ID of the GHE configuration - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40501,13 +40276,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_user_connected"` + - `type: optional "claude_file_uploaded"` - default: ghe_user_connected + default: claude_file_uploaded - - `GheUserDisconnected object` + - `GheConfigurationCreated object` - User disconnected from a GHE instance. + Admin created a GHE configuration. - `actor: object or object or object or 8 more` @@ -40720,6 +40495,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `ghe_configuration_id: string` + + ID of the GHE configuration + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -40730,9 +40509,13 @@ compliance activities that can be filtered by various criteria. format: date-time - - `ghe_configuration_id: optional string or null` + - `display_name: optional string or null` - ID of the GHE configuration + Display name given to the configuration + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance - `organization_id: optional string or null` @@ -40742,13 +40525,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_user_disconnected"` + - `port: optional number or null` - default: ghe_user_disconnected + Custom port, if not the HTTPS default - - `GheWebhookSignatureInvalid object` + - `type: optional "ghe_configuration_created"` - Webhook signature validation failed. + default: ghe_configuration_created + + - `GheConfigurationDeleted object` + + Admin deleted a GHE configuration. - `actor: object or object or object or 8 more` @@ -40975,6 +40762,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `display_name: optional string or null` + + Display name the configuration had when deleted + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40983,13 +40778,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_webhook_signature_invalid"` + - `port: optional number or null` - default: ghe_webhook_signature_invalid + Custom port, if not the HTTPS default - - `ClaudeGitHubIntegrationCreated object` + - `type: optional "ghe_configuration_deleted"` - A GitHub integration was enabled for the organization. + default: ghe_configuration_deleted + + - `GheConfigurationUpdated object` + + Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced. - `actor: object or object or object or 8 more` @@ -41202,7 +41001,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` + - `ghe_configuration_id: string` + + ID of the GHE configuration - `id: optional string` @@ -41214,33 +41015,85 @@ compliance activities that can be filtered by various criteria. format: date-time - - `enabled: optional boolean or null` + - `custom_ca_certificate_updated: optional boolean or null` - Whether the integration is enabled after this change. + Whether the custom CA certificate was replaced in this update + + - `display_name: optional string or null` + + New display name, when it changed + + - `github_app_client_id: optional string or null` + + New GitHub App client ID, when it changed + + - `github_app_client_secret_updated: optional boolean or null` + + Whether the GitHub App client secret was replaced in this update + + - `github_app_id: optional number or null` + + New GitHub App ID, when it changed + + - `github_app_private_key_updated: optional boolean or null` + + Whether the GitHub App private key was replaced in this update + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance (immutable; included for context) + + - `is_active: optional boolean or null` + + New active state, when it changed - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` + - `port: optional number or null` - Whether the integration was enabled before this change; null when the integration had never been configured. + New port, when it changed - - `repository_name: optional string or null` + - `previous_display_name: optional string or null` - - `type: optional "claude_github_integration_created"` + Display name before the change, when it changed - default: claude_github_integration_created + - `previous_github_app_client_id: optional string or null` - - `ClaudeGitHubIntegrationDeleted object` + GitHub App client ID before the change, when it changed - A GitHub integration was disabled for the organization. + - `previous_github_app_id: optional number or null` + + GitHub App ID before the change, when it changed + + - `previous_is_active: optional boolean or null` + + Active state before the change, when it changed + + - `previous_port: optional number or null` + + Port before the change, when it changed + + - `read_replica_hostnames_updated: optional boolean or null` + + Whether the read replica hostnames were replaced in this update + + - `type: optional "ghe_configuration_updated"` + + default: ghe_configuration_updated + + - `webhook_secret_updated: optional boolean or null` + + Whether the webhook secret was replaced in this update + + - `GheUserConnected object` + + User connected to a GHE instance. - `actor: object or object or object or 8 more` @@ -41453,8 +41306,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -41465,33 +41316,25 @@ compliance activities that can be filtered by various criteria. format: date-time - - `enabled: optional boolean or null` + - `ghe_configuration_id: optional string or null` - Whether the integration is enabled after this change. + ID of the GHE configuration - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether the integration was enabled before this change; null when the integration had never been configured. - - - `repository_name: optional string or null` - - - `type: optional "claude_github_integration_deleted"` + - `type: optional "ghe_user_connected"` - default: claude_github_integration_deleted + default: ghe_user_connected - - `ClaudeGitHubIntegrationUpdated object` + - `GheUserDisconnected object` - A GitHub integration's configuration was updated. + User disconnected from a GHE instance. - `actor: object or object or object or 8 more` @@ -41704,8 +41547,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -41716,25 +41557,25 @@ compliance activities that can be filtered by various criteria. format: date-time + - `ghe_configuration_id: optional string or null` + + ID of the GHE configuration + - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `repository_name: optional string or null` - - - `type: optional "claude_github_integration_updated"` + - `type: optional "ghe_user_disconnected"` - default: claude_github_integration_updated + default: ghe_user_disconnected - - `GitHubTokenImport object` + - `GheWebhookSignatureInvalid object` - A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed). + Webhook signature validation failed. - `actor: object or object or object or 8 more` @@ -41947,29 +41788,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `result: "failed_internal" or "imported" or "rejected_feature_disabled" or 5 more` - - The outcome of the import. - - - `"failed_internal"` - - - `"imported"` - - - `"rejected_feature_disabled"` - - - `"rejected_invalid_credential"` - - - `"rejected_missing_repo_scope"` - - - `"rejected_tenant_not_ready"` - - - `"rejected_zdr_policy"` - - - `"unspecified"` - - - `source: string` + - `ghe_configuration_id: string` - How the token was imported. + ID of the GHE configuration - `id: optional string` @@ -41981,14 +41802,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_username: optional string or null` - - The GitHub username the imported token authenticates as, when known. - - - `granted_scopes: optional string or null` - - The scopes granted to the imported token, when available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -41997,17 +41810,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `token_fingerprint_sha256: optional string or null` - - Org-scoped SHA-256 of the submitted token: `sha256(org_uuid || 0x00 || token)`, lowercase-hex-encoded, where `org_uuid` is the organization's UUID as a dashed lowercase string, `0x00` is a single zero byte, and `token` is the submitted value's raw bytes. Per-org correlation only — the same token in two orgs produces distinct fingerprints. Set only when the submitted value carries a known GitHub PAT prefix (a high-entropy token format); unset for all other submissions, including rejected non-PAT input. - - - `type: optional "github_token_import"` + - `type: optional "ghe_webhook_signature_invalid"` - default: github_token_import + default: ghe_webhook_signature_invalid - - `ClaudeGdriveIntegrationCreated object` + - `ClaudeGitHubIntegrationCreated object` - A Google Drive integration was enabled for the organization. + A GitHub integration was enabled for the organization. - `actor: object or object or object or 8 more` @@ -42232,23 +42041,33 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` + - `enabled: optional boolean or null` + + Whether the integration is enabled after this change. - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_created"` + - `previous_enabled: optional boolean or null` - default: claude_gdrive_integration_created + Whether the integration was enabled before this change; null when the integration had never been configured. - - `ClaudeGdriveIntegrationDeleted object` + - `repository_name: optional string or null` - A Google Drive integration was disabled for the organization. + - `type: optional "claude_github_integration_created"` + + default: claude_github_integration_created + + - `ClaudeGitHubIntegrationDeleted object` + + A GitHub integration was disabled for the organization. - `actor: object or object or object or 8 more` @@ -42473,23 +42292,33 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` + - `enabled: optional boolean or null` + + Whether the integration is enabled after this change. - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_deleted"` + - `previous_enabled: optional boolean or null` - default: claude_gdrive_integration_deleted + Whether the integration was enabled before this change; null when the integration had never been configured. - - `ClaudeGdriveIntegrationUpdated object` + - `repository_name: optional string or null` - A Google Drive integration's configuration was updated. + - `type: optional "claude_github_integration_deleted"` + + default: claude_github_integration_deleted + + - `ClaudeGitHubIntegrationUpdated object` + + A GitHub integration's configuration was updated. - `actor: object or object or object or 8 more` @@ -42714,23 +42543,25 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_updated"` + - `repository_name: optional string or null` - default: claude_gdrive_integration_updated + - `type: optional "claude_github_integration_updated"` - - `GroupCreated object` + default: claude_github_integration_updated - A group was created (RBAC admin or SCIM provisioning). + - `GitHubTokenImport object` + + A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed). - `actor: object or object or object or 8 more` @@ -42943,13 +42774,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` + - `result: "failed_internal" or "imported" or "rejected_feature_disabled" or 5 more` - Tagged ID of the created group + The outcome of the import. - - `group_name: string` + - `"failed_internal"` - Name of the created group + - `"imported"` + + - `"rejected_feature_disabled"` + + - `"rejected_invalid_credential"` + + - `"rejected_missing_repo_scope"` + + - `"rejected_tenant_not_ready"` + + - `"rejected_zdr_policy"` + + - `"unspecified"` + + - `source: string` + + How the token was imported. - `id: optional string` @@ -42961,6 +42808,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_username: optional string or null` + + The GitHub username the imported token authenticates as, when known. + + - `granted_scopes: optional string or null` + + The scopes granted to the imported token, when available. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -42969,13 +42824,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_created"` + - `token_fingerprint_sha256: optional string or null` - default: group_created + Org-scoped SHA-256 of the submitted token: `sha256(org_uuid || 0x00 || token)`, lowercase-hex-encoded, where `org_uuid` is the organization's UUID as a dashed lowercase string, `0x00` is a single zero byte, and `token` is the submitted value's raw bytes. Per-org correlation only — the same token in two orgs produces distinct fingerprints. Set only when the submitted value carries a known GitHub PAT prefix (a high-entropy token format); unset for all other submissions, including rejected non-PAT input. - - `GroupDeleted object` + - `type: optional "github_token_import"` - A group was deleted (RBAC admin or SCIM provisioning). + default: github_token_import + + - `ClaudeGdriveIntegrationCreated object` + + A Google Drive integration was enabled for the organization. - `actor: object or object or object or 8 more` @@ -43188,9 +43047,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the deleted group + - `integration_id: string` - `id: optional string` @@ -43202,6 +43059,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `folder_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43210,13 +43069,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_deleted"` + - `type: optional "claude_gdrive_integration_created"` - default: group_deleted + default: claude_gdrive_integration_created - - `GroupListViewed object` + - `ClaudeGdriveIntegrationDeleted object` - Admin viewed the list of RBAC groups. + A Google Drive integration was disabled for the organization. - `actor: object or object or object or 8 more` @@ -43429,6 +43288,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `integration_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -43439,6 +43300,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `folder_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43447,13 +43310,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_list_viewed"` + - `type: optional "claude_gdrive_integration_deleted"` - default: group_list_viewed + default: claude_gdrive_integration_deleted - - `GroupMemberAdded object` + - `ClaudeGdriveIntegrationUpdated object` - One or more members were added to a group. + A Google Drive integration's configuration was updated. - `actor: object or object or object or 8 more` @@ -43666,9 +43529,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the group + - `integration_id: string` - `id: optional string` @@ -43680,9 +43541,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members added: user IDs, or service account IDs (svac_...) when a service account was added + - `folder_id: optional string or null` - `organization_id: optional string or null` @@ -43692,13 +43551,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_added"` + - `type: optional "claude_gdrive_integration_updated"` - default: group_member_added + default: claude_gdrive_integration_updated - - `GroupMemberAdditionFailed object` + - `GroupCreated object` - A request to add members to a group failed. Some of the requested members may have been added before the failure. + A group was created (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -43913,7 +43772,11 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group + Tagged ID of the created group + + - `group_name: string` + + Name of the created group - `id: optional string` @@ -43925,10 +43788,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members the request attempted to add - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43937,13 +43796,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_addition_failed"` + - `type: optional "group_created"` - default: group_member_addition_failed + default: group_created - - `GroupMemberListViewed object` + - `GroupDeleted object` - Admin viewed the members of an RBAC group. + A group was deleted (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -44158,7 +44017,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group + Tagged ID of the deleted group - `id: optional string` @@ -44178,13 +44037,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_list_viewed"` + - `type: optional "group_deleted"` - default: group_member_list_viewed + default: group_deleted - - `GroupMemberRemovalFailed object` + - `GroupListViewed object` - A request to remove members from a group failed. Some of the requested members may have been removed before the failure. + Admin viewed the list of RBAC groups. - `actor: object or object or object or 8 more` @@ -44397,10 +44256,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the group - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -44411,10 +44266,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members the request attempted to remove. These are always recorded as user IDs, since whether a member was a service account is only established once its removal succeeds - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -44423,13 +44274,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_removal_failed"` + - `type: optional "group_list_viewed"` - default: group_member_removal_failed + default: group_list_viewed - - `GroupMemberRemoved object` + - `GroupMemberAdded object` - One or more members were removed from a group. + One or more members were added to a group. - `actor: object or object or object or 8 more` @@ -44658,7 +44509,7 @@ compliance activities that can be filtered by various criteria. - `member_ids: optional array of string` - Tagged IDs of the members removed: user IDs, or service account IDs (svac_...) when a service account was removed. A requested member that was not in the group is listed as a user ID + Tagged IDs of the members added: user IDs, or service account IDs (svac_...) when a service account was added - `organization_id: optional string or null` @@ -44668,13 +44519,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_removed"` + - `type: optional "group_member_added"` - default: group_member_removed + default: group_member_added - - `GroupProjectSharesRevoked object` + - `GroupMemberAdditionFailed object` - An RBAC group's project shares in one organization were revoked in bulk. + A request to add members to a group failed. Some of the requested members may have been added before the failure. - `actor: object or object or object or 8 more` @@ -44889,26 +44740,22 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose project shares were revoked. - - - `revoked_count: number` - - Number of distinct projects whose share with this group was revoked. + Tagged ID of the group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_ids: optional array of string` - - Tagged IDs of the projects whose share with this group was revoked. - - `created_at: optional string` When this activity occurred. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members the request attempted to add + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -44917,13 +44764,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_project_shares_revoked"` + - `type: optional "group_member_addition_failed"` - default: group_project_shares_revoked + default: group_member_addition_failed - - `GroupSkillSharesRevoked object` + - `GroupMemberListViewed object` - An RBAC group's skill shares in one organization were revoked in bulk. + Admin viewed the members of an RBAC group. - `actor: object or object or object or 8 more` @@ -45138,11 +44985,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose skill shares were revoked. - - - `revoked_count: number` - - Number of distinct skills and plugins whose share with this group was revoked: the combined size of `skill_ids` and `plugin_ids`. + Tagged ID of the group - `id: optional string` @@ -45162,21 +45005,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plugin_ids: optional array of string` - - Tagged IDs of the plugins whose share with this group was revoked. - - - `skill_ids: optional array of string` - - Tagged IDs of the skills whose share with this group was revoked. - - - `type: optional "group_skill_shares_revoked"` + - `type: optional "group_member_list_viewed"` - default: group_skill_shares_revoked + default: group_member_list_viewed - - `GroupUpdated object` + - `GroupMemberRemovalFailed object` - A group was updated (RBAC admin or SCIM provisioning). + A request to remove members from a group failed. Some of the requested members may have been removed before the failure. - `actor: object or object or object or 8 more` @@ -45391,7 +45226,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the updated group + Tagged ID of the group - `id: optional string` @@ -45403,6 +45238,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members the request attempted to remove. These are always recorded as user IDs, since whether a member was a service account is only established once its removal succeeds + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -45411,13 +45250,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_updated"` + - `type: optional "group_member_removal_failed"` - default: group_updated + default: group_member_removal_failed - - `GroupViewed object` + - `GroupMemberRemoved object` - A group was viewed. + One or more members were removed from a group. - `actor: object or object or object or 8 more` @@ -45632,7 +45471,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the viewed group + Tagged ID of the group - `id: optional string` @@ -45644,6 +45483,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members removed: user IDs, or service account IDs (svac_...) when a service account was removed. A requested member that was not in the group is listed as a user ID + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -45652,13 +45495,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_viewed"` + - `type: optional "group_member_removed"` - default: group_viewed + default: group_member_removed - - `GroupVisibilityUpdated object` + - `GroupProjectSharesRevoked object` - An RBAC group's visibility policy was updated. + An RBAC group's project shares in one organization were revoked in bulk. - `actor: object or object or object or 8 more` @@ -45873,12 +45716,20 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose visibility policy was updated. + Tagged ID of the group whose project shares were revoked. + + - `revoked_count: number` + + Number of distinct projects whose share with this group was revoked. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_ids: optional array of string` + + Tagged IDs of the projects whose share with this group was revoked. + - `created_at: optional string` When this activity occurred. @@ -45893,69 +45744,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `policies: optional array of object` - - The group's visibility policy after this update. - - - `audience: "everyone" or "members" or "none" or "unspecified"` - - The audience granted this visibility facet. - - - `"everyone"` - - - `"members"` - - - `"none"` - - - `"unspecified"` - - - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` - - The visibility facet this entry grants. - - - `"discover"` - - - `"share_with"` - - - `"unspecified"` - - - `"view_members"` - - - `previous_policies: optional array of object` - - The group's visibility policy before this update. - - - `audience: "everyone" or "members" or "none" or "unspecified"` - - The audience granted this visibility facet. - - - `"everyone"` - - - `"members"` - - - `"none"` - - - `"unspecified"` - - - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` - - The visibility facet this entry grants. - - - `"discover"` - - - `"share_with"` - - - `"unspecified"` - - - `"view_members"` - - - `type: optional "group_visibility_updated"` + - `type: optional "group_project_shares_revoked"` - default: group_visibility_updated + default: group_project_shares_revoked - - `InferenceHooksCircuitBreakerTripped object` + - `GroupSkillSharesRevoked object` - The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. The tripped state persists until an administrator re-enables Inference hooks inspection (or explicitly resets the circuit breaker). + An RBAC group's skill shares in one organization were revoked in bulk. - `actor: object or object or object or 8 more` @@ -46168,13 +45963,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `fail_mode: string` + - `group_id: string` - The failure handling in effect when the breaker tripped: "fail_open" (requests proceed uninspected) or "fail_closed" (requests are rejected). + Tagged ID of the group whose skill shares were revoked. - - `trigger_reason: string` + - `revoked_count: number` - The kind of failure that crossed the threshold. Currently always "webhook_error": repeated failures of calls to the organization's Inference hooks endpoint. + Number of distinct skills and plugins whose share with this group was revoked: the combined size of `skill_ids` and `plugin_ids`. - `id: optional string` @@ -46194,17 +45989,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `surface: optional string or null` + - `plugin_ids: optional array of string` - The product surface of the request whose failure tripped the breaker, e.g. "claude-ai" or "claude-code". + Tagged IDs of the plugins whose share with this group was revoked. - - `type: optional "inference_hooks_circuit_breaker_tripped"` + - `skill_ids: optional array of string` - default: inference_hooks_circuit_breaker_tripped + Tagged IDs of the skills whose share with this group was revoked. - - `InferenceHooksRequestDenied object` + - `type: optional "group_skill_shares_revoked"` - Inference hooks inspection denied a request. The request was blocked and no model response was produced. + default: group_skill_shares_revoked + + - `GroupUpdated object` + + A group was updated (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -46417,13 +46216,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `group_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the updated group - - `conversation_id: optional string or null` + - `id: optional string` - The conversation the denied request belonged to, when available. The identifier format depends on `surface`. + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -46439,25 +46238,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reference_id: optional string or null` - - The Inference hooks endpoint's own identifier for this scan, when it returned one — lets this denial be matched to the corresponding record in the inspection provider's console. - - - `request_id: optional string or null` - - Anthropic's identifier for the denied request — the same value sent to the Inference hooks endpoint as `request_id`. - - - `surface: optional string or null` - - The product surface the request came from, e.g. "claude-ai" or "claude-code". - - - `type: optional "inference_hooks_request_denied"` + - `type: optional "group_updated"` - default: inference_hooks_request_denied + default: group_updated - - `InferenceHooksRequestFailedOpen object` + - `GroupViewed object` - A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open. + A group was viewed. - `actor: object or object or object or 8 more` @@ -46670,26 +46457,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `reason: "endpoint_error" or "endpoint_timeout" or "internal_error" or "unspecified"` - - Why Inference hooks inspection did not return a verdict. - - - `"endpoint_error"` - - - `"endpoint_timeout"` - - - `"internal_error"` + - `group_id: string` - - `"unspecified"` + Tagged ID of the viewed group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `conversation_id: optional string or null` - - The conversation the request belonged to, when available. The identifier format depends on `surface`. - - `created_at: optional string` When this activity occurred. @@ -46704,17 +46479,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `surface: optional string or null` - - The product surface the request came from, e.g. "claude-ai" or "claude-code". - - - `type: optional "inference_hooks_request_failed_open"` + - `type: optional "group_viewed"` - default: inference_hooks_request_failed_open + default: group_viewed - - `IntegrationUserConnected object` + - `GroupVisibilityUpdated object` - User connected to an integration. + An RBAC group's visibility policy was updated. - `actor: object or object or object or 8 more` @@ -46927,6 +46698,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `group_id: string` + + Tagged ID of the group whose visibility policy was updated. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -46937,31 +46712,77 @@ compliance activities that can be filtered by various criteria. format: date-time - - `integration_type: optional string or null` + - `organization_id: optional string or null` - - `mcp_server_id: optional string or null` + Organization ID this activity is associated with - ID of the connected remote MCP server, when the integration is a remote MCP server. + - `organization_uuid: optional string or null` - - `mcp_server_name: optional string or null` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - Display name of the connected remote MCP server, when the integration is a remote MCP server. + - `policies: optional array of object` - - `organization_id: optional string or null` + The group's visibility policy after this update. - Organization ID this activity is associated with + - `audience: "everyone" or "members" or "none" or "unspecified"` - - `organization_uuid: optional string or null` + The audience granted this visibility facet. - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `"everyone"` - - `type: optional "integration_user_connected"` + - `"members"` - default: integration_user_connected + - `"none"` - - `IntegrationUserDisconnected object` + - `"unspecified"` - User disconnected from an integration. + - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` + + The visibility facet this entry grants. + + - `"discover"` + + - `"share_with"` + + - `"unspecified"` + + - `"view_members"` + + - `previous_policies: optional array of object` + + The group's visibility policy before this update. + + - `audience: "everyone" or "members" or "none" or "unspecified"` + + The audience granted this visibility facet. + + - `"everyone"` + + - `"members"` + + - `"none"` + + - `"unspecified"` + + - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` + + The visibility facet this entry grants. + + - `"discover"` + + - `"share_with"` + + - `"unspecified"` + + - `"view_members"` + + - `type: optional "group_visibility_updated"` + + default: group_visibility_updated + + - `InferenceHooksCircuitBreakerTripped object` + + The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. The tripped state persists until an administrator re-enables Inference hooks inspection (or explicitly resets the circuit breaker). - `actor: object or object or object or 8 more` @@ -47174,6 +46995,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `fail_mode: string` + + The failure handling in effect when the breaker tripped: "fail_open" (requests proceed uninspected) or "fail_closed" (requests are rejected). + + - `trigger_reason: string` + + The kind of failure that crossed the threshold. Currently always "webhook_error": repeated failures of calls to the organization's Inference hooks endpoint. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -47184,16 +47013,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `integration_type: optional string or null` - - - `mcp_server_id: optional string or null` - - ID of the disconnected remote MCP server, when the integration is a remote MCP server. - - - `mcp_server_name: optional string or null` - - Display name of the disconnected remote MCP server, when the integration is a remote MCP server. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47202,13 +47021,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "integration_user_disconnected"` + - `surface: optional string or null` - default: integration_user_disconnected + The product surface of the request whose failure tripped the breaker, e.g. "claude-ai" or "claude-code". - - `InvoiceCollectionMethodUpdated object` + - `type: optional "inference_hooks_circuit_breaker_tripped"` - Invoice collection method was changed. + default: inference_hooks_circuit_breaker_tripped + + - `InferenceHooksRequestDenied object` + + Inference hooks inspection denied a request. The request was blocked and no model response was produced. - `actor: object or object or object or 8 more` @@ -47425,16 +47248,16 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `conversation_id: optional string or null` + + The conversation the denied request belonged to, when available. The identifier format depends on `surface`. + - `created_at: optional string` When this activity occurred. format: date-time - - `new_collection_method: optional string or null` - - New collection method (e.g. charge_automatically, send_invoice). - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47443,13 +47266,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "invoice_collection_method_updated"` + - `reference_id: optional string or null` - default: invoice_collection_method_updated + The Inference hooks endpoint's own identifier for this scan, when it returned one — lets this denial be matched to the corresponding record in the inspection provider's console. - - `UserLoggedOut object` + - `request_id: optional string or null` - A user signed out of one or all sessions. + Anthropic's identifier for the denied request — the same value sent to the Inference hooks endpoint as `request_id`. + + - `surface: optional string or null` + + The product surface the request came from, e.g. "claude-ai" or "claude-code". + + - `type: optional "inference_hooks_request_denied"` + + default: inference_hooks_request_denied + + - `InferenceHooksRequestFailedOpen object` + + A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open. - `actor: object or object or object or 8 more` @@ -47662,10 +47497,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `reason: "endpoint_error" or "endpoint_timeout" or "internal_error" or "unspecified"` + + Why Inference hooks inspection did not return a verdict. + + - `"endpoint_error"` + + - `"endpoint_timeout"` + + - `"internal_error"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `conversation_id: optional string or null` + + The conversation the request belonged to, when available. The identifier format depends on `surface`. + - `created_at: optional string` When this activity occurred. @@ -47680,13 +47531,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "user_logged_out"` + - `surface: optional string or null` - default: user_logged_out + The product surface the request came from, e.g. "claude-ai" or "claude-code". - - `LtiLaunchInitiated object` + - `type: optional "inference_hooks_request_failed_open"` - LTI launch was initiated. + default: inference_hooks_request_failed_open + + - `IntegrationUserConnected object` + + User connected to an integration. - `actor: object or object or object or 8 more` @@ -47909,6 +47764,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `integration_type: optional string or null` + + - `mcp_server_id: optional string or null` + + ID of the connected remote MCP server, when the integration is a remote MCP server. + + - `mcp_server_name: optional string or null` + + Display name of the connected remote MCP server, when the integration is a remote MCP server. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47917,13 +47782,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_launch_initiated"` + - `token_vault_connect_mode: optional string or null` - default: lti_launch_initiated + How a token vault credential sign-in was completed: "authorization_server" for a sign-in at an administrator-provided authorization server, or "mcp_server" for a sign-in at a tool server the organization has not registered as a connector. - - `LtiLaunchSuccess object` + - `type: optional "integration_user_connected"` - LTI launch completed successfully. + default: integration_user_connected + + - `IntegrationUserDisconnected object` + + User disconnected from an integration. - `actor: object or object or object or 8 more` @@ -48146,6 +48015,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `integration_type: optional string or null` + + - `mcp_server_id: optional string or null` + + ID of the disconnected remote MCP server, when the integration is a remote MCP server. + + - `mcp_server_name: optional string or null` + + Display name of the disconnected remote MCP server, when the integration is a remote MCP server. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48154,13 +48033,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_launch_success"` + - `type: optional "integration_user_disconnected"` - default: lti_launch_success + default: integration_user_disconnected - - `LtiPlatformCreated object` + - `InvoiceCollectionMethodUpdated object` - Anthropic staff created an LTI platform integration on behalf of an org. + Invoice collection method was changed. - `actor: object or object or object or 8 more` @@ -48373,14 +48252,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `lti_platform_id: string` - - UUID of the LTI platform - - - `lti_platform_issuer: string` - - Platform issuer URL - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -48391,6 +48262,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `new_collection_method: optional string or null` + + New collection method (e.g. charge_automatically, send_invoice). + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48399,13 +48274,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_platform_created"` + - `type: optional "invoice_collection_method_updated"` - default: lti_platform_created + default: invoice_collection_method_updated - - `LtiPlatformUpdated object` + - `UserLoggedOut object` - Anthropic staff updated an LTI platform integration on behalf of an org. + A user signed out of one or all sessions. - `actor: object or object or object or 8 more` @@ -48618,10 +48493,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `lti_platform_id: string` - - UUID of the LTI platform - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -48632,10 +48503,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `lti_platform_issuer: optional string or null` - - Platform issuer URL - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48644,13 +48511,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_platform_updated"` + - `type: optional "user_logged_out"` - default: lti_platform_updated + default: user_logged_out - - `MagicLinkLoginFailed object` + - `LtiLaunchInitiated object` - A magic link sign-in attempt failed. + LTI launch was initiated. - `actor: object or object or object or 8 more` @@ -48881,13 +48748,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_failed"` + - `type: optional "lti_launch_initiated"` - default: magic_link_login_failed + default: lti_launch_initiated - - `MagicLinkLoginInitiated object` + - `LtiLaunchSuccess object` - A user requested a magic link sign-in email. + LTI launch completed successfully. - `actor: object or object or object or 8 more` @@ -49118,13 +48985,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_initiated"` + - `type: optional "lti_launch_success"` - default: magic_link_login_initiated + default: lti_launch_success - - `MagicLinkLoginSucceeded object` + - `LtiPlatformCreated object` - A user successfully signed in with a magic link email. + Anthropic staff created an LTI platform integration on behalf of an org. - `actor: object or object or object or 8 more` @@ -49337,15 +49204,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `lti_platform_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + UUID of the LTI platform - - `auth_method: optional "magic_link"` + - `lti_platform_issuer: string` - The method the user used to authenticate. May be absent on activities recorded before this field was introduced. + Platform issuer URL + + - `id: optional string` - default: magic_link + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -49353,10 +49222,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `mfa_method: optional "not_used" or null` - - The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -49365,13 +49230,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_succeeded"` + - `type: optional "lti_platform_created"` - default: magic_link_login_succeeded + default: lti_platform_created - - `ManagedOrganizationSetupCompleted object` + - `LtiPlatformUpdated object` - Managed (AWS Marketplace) organization setup was completed. + Anthropic staff updated an LTI platform integration on behalf of an org. - `actor: object or object or object or 8 more` @@ -49584,6 +49449,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `lti_platform_id: string` + + UUID of the LTI platform + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -49594,6 +49463,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `lti_platform_issuer: optional string or null` + + Platform issuer URL + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -49602,13 +49475,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "managed_organization_setup_completed"` + - `type: optional "lti_platform_updated"` - default: managed_organization_setup_completed + default: lti_platform_updated - - `MarketplaceCreated object` + - `MagicLinkLoginFailed object` - Admin created an organization marketplace. + A magic link sign-in attempt failed. - `actor: object or object or object or 8 more` @@ -49821,10 +49694,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -49843,13 +49712,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_created"` + - `type: optional "magic_link_login_failed"` - default: marketplace_created + default: magic_link_login_failed - - `MarketplaceDeleted object` + - `MagicLinkLoginInitiated object` - Admin deleted an organization marketplace. + A user requested a magic link sign-in email. - `actor: object or object or object or 8 more` @@ -50062,10 +49931,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -50084,13 +49949,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_deleted"` + - `type: optional "magic_link_login_initiated"` - default: marketplace_deleted + default: magic_link_login_initiated - - `MarketplaceUpdated object` + - `MagicLinkLoginSucceeded object` - Admin updated an organization marketplace. + A user successfully signed in with a magic link email. - `actor: object or object or object or 8 more` @@ -50303,20 +50168,32 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `auth_method: optional "magic_link" or "unspecified" or null` + + The method the user used to authenticate. May be absent on activities recorded before this field was introduced. + + - `"magic_link"` + + - `"unspecified"` + - `created_at: optional string` When this activity occurred. format: date-time + - `mfa_method: optional "not_used" or "unspecified" or null` + + The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. + + - `"not_used"` + + - `"unspecified"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -50325,13 +50202,250 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_updated"` + - `type: optional "magic_link_login_succeeded"` - default: marketplace_updated + default: magic_link_login_succeeded - - `MarketplaceWebhookDeleted object` + - `ManagedOrganizationSetupCompleted object` - Admin removed the GitHub push webhook for a marketplace. + Managed (AWS Marketplace) organization setup was completed. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "managed_organization_setup_completed"` + + default: managed_organization_setup_completed + + - `MarketplaceCreated object` + + Admin created an organization marketplace. - `actor: object or object or object or 8 more` @@ -50566,13 +50680,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_webhook_deleted"` + - `type: optional "marketplace_created"` - default: marketplace_webhook_deleted + default: marketplace_created - - `MarketplaceWebhookProvisioned object` + - `MarketplaceDeleted object` - Admin provisioned a GitHub push webhook for a marketplace. + Admin deleted an organization marketplace. - `actor: object or object or object or 8 more` @@ -50799,10 +50913,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_webhook_id: optional number or null` - - GitHub-assigned webhook ID returned by the hooks API - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -50811,13 +50921,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_webhook_provisioned"` + - `type: optional "marketplace_deleted"` - default: marketplace_webhook_provisioned + default: marketplace_deleted - - `McpDirectoryServerPublished object` + - `MarketplaceUpdated object` - The organization published its approved MCP directory listing. + Admin updated an organization marketplace. - `actor: object or object or object or 8 more` @@ -51030,13 +51140,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_directory_server_id: string` - - Tagged ID of the MCP directory listing - - - `mcp_directory_server_name: string` + - `marketplace_id: string` - Display name of the MCP directory listing + Tagged ID of the marketplace - `id: optional string` @@ -51056,13 +51162,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_directory_server_published"` + - `type: optional "marketplace_updated"` - default: mcp_directory_server_published + default: marketplace_updated - - `McpServerCreated object` + - `MarketplaceWebhookDeleted object` - An MCP server was added to the organization. + Admin removed the GitHub push webhook for a marketplace. - `actor: object or object or object or 8 more` @@ -51275,13 +51381,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_server_id: string` - - Tagged ID of the MCP server - - - `mcp_server_name: string` + - `marketplace_id: string` - Display name of the MCP server + Tagged ID of the marketplace - `id: optional string` @@ -51301,13 +51403,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_created"` + - `type: optional "marketplace_webhook_deleted"` - default: mcp_server_created + default: marketplace_webhook_deleted - - `McpServerDeleted object` + - `MarketplaceWebhookProvisioned object` - An MCP server was removed from the organization. + Admin provisioned a GitHub push webhook for a marketplace. - `actor: object or object or object or 8 more` @@ -51520,13 +51622,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_server_id: string` - - Tagged ID of the MCP server - - - `mcp_server_name: string` + - `marketplace_id: string` - Display name of the MCP server + Tagged ID of the marketplace - `id: optional string` @@ -51538,6 +51636,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_webhook_id: optional number or null` + + GitHub-assigned webhook ID returned by the hooks API + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -51546,13 +51648,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_deleted"` + - `type: optional "marketplace_webhook_provisioned"` - default: mcp_server_deleted + default: marketplace_webhook_provisioned - - `McpServerManagedAuthTokenExchanged object` + - `McpDirectoryServerPublished object` - A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests denied by organization policy before a token exchange is attempted are not reported, with the exception of the "connector_scope_not_granted" failures described under error_type. + The organization published its approved MCP directory listing. - `actor: object or object or object or 8 more` @@ -51765,48 +51867,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `managed_auth_mode: string` + - `mcp_directory_server_id: string` - The managed-authorization mode used for the exchange ("claude" or "sso"). + Tagged ID of the MCP directory listing - - `mcp_server_id: string` + - `mcp_directory_server_name: string` - The MCP server the exchange was attempted for, e.g. "mcpsrv_01Ab...". + Display name of the MCP directory listing - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `assertion_jti: optional string or null` - - The JWT ID of the identity assertion presented to the authorization server, when one was minted, for cross-reference with the identity provider's own logs. - - - `authorization_server_issuer: optional string or null` - - The issuer identifier of the authorization server the exchange was attempted against. - - - `correlation_id: optional string or null` - - An opaque identifier customers can quote when contacting Anthropic support about this exchange. - - `created_at: optional string` When this activity occurred. format: date-time - - `error_subtype: optional string or null` - - A more specific classification of the failure, when available. For authorization-server rejections this is the OAuth error code the server returned (for example "invalid_grant"); for identity-provider rejections this is the error code the identity provider returned. Values may be added over time; treat an unrecognized value as a generic failure. - - - `error_type: optional string or null` - - A short classification of why the exchange failed, when outcome is "failure". Values include "authorization_server_rejected", "authorization_server_unavailable", "identity_provider_rejected", "sso_session_invalid", "sso_connection_unsupported", and "connector_scope_not_granted" (the organization's role configuration grants no scopes on this connector, so the request was denied before a token exchange was attempted). Values may be added over time; treat an unrecognized value as a generic failure. - - - `mcp_server_name: optional string or null` - - The MCP server's display name at the time of the exchange, when available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -51815,17 +51893,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `outcome: optional string or null` - - Whether the token exchange succeeded ("success") or was rejected ("failure"). - - - `type: optional "mcp_server_managed_auth_token_exchanged"` + - `type: optional "mcp_directory_server_published"` - default: mcp_server_managed_auth_token_exchanged + default: mcp_directory_server_published - - `McpServerManagedAuthUpdated object` + - `McpServerCreated object` - An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server). + An MCP server was added to the organization. - `actor: object or object or object or 8 more` @@ -52050,36 +52124,12 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `allowed_scopes: optional string or null` - - The OAuth scopes managed authorization may request for the server after the change, as a space-delimited list. Null when no scope restriction is configured (or the server has no managed authorization settings); an empty string when the restriction permits no scopes. - - - `built_in_roles_included: optional boolean or null` - - Whether, after the change, managed authorization extends to members who hold one of the organization's built-in roles (such as User, Admin, or Owner) rather than a custom role, in addition to members whose custom role grants it. This describes whom managed authorization reaches and is reported on every change, independent of how built-in role access is configured. - - `created_at: optional string` When this activity occurred. format: date-time - - `individual_auth_enabled: optional boolean or null` - - Whether members may authorize the server individually, through their own sign-in and consent, after the change. - - - `managed_auth_enabled: optional boolean or null` - - Whether managed authorization is enabled for the server after the change, so that members whose role permits it are authorized through the organization's identity provider. - - - `managed_auth_mode: optional string or null` - - The managed-authorization mode after the change ("claude" or "sso"): how the identity assertion presented on members' behalf is issued. Recorded whenever managed authorization settings exist, whether or not managed authorization is enabled; null when the server has no managed authorization settings after the change. - - - `mcp_server_url: optional string or null` - - Base URL (scheme, host, port, and path only) of the MCP server at the time of the change; null when not available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -52088,29 +52138,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_allowed_scopes: optional string or null` - - The OAuth scope restriction before the change, as a space-delimited list; null when no scope restriction was configured. - - - `previous_built_in_roles_included: optional boolean or null` - - Whether managed authorization extended to members holding one of the organization's built-in roles before the change. - - - `previous_individual_auth_enabled: optional boolean or null` - - Whether members could authorize the server individually before the change. - - - `previous_managed_auth_enabled: optional boolean or null` - - Whether managed authorization was enabled for the server before the change. - - - `type: optional "mcp_server_managed_auth_updated"` + - `type: optional "mcp_server_created"` - default: mcp_server_managed_auth_updated + default: mcp_server_created - - `McpServerUpdated object` + - `McpServerDeleted object` - An MCP server's configuration was updated. + An MCP server was removed from the organization. - `actor: object or object or object or 8 more` @@ -52349,13 +52383,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_updated"` + - `type: optional "mcp_server_deleted"` - default: mcp_server_updated + default: mcp_server_deleted - - `McpToolPolicyUpdated object` + - `McpServerManagedAuthTokenExchanged object` - The permission restriction for an MCP tool was set or cleared. + A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests denied by organization policy before a token exchange is attempted are not reported, with the exception of the "connector_scope_not_granted" failures described under error_type. - `actor: object or object or object or 8 more` @@ -52568,21 +52602,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `managed_auth_mode: string` + + The managed-authorization mode used for the exchange ("claude" or "sso"). + - `mcp_server_id: string` - Tagged ID of the MCP server + The MCP server the exchange was attempted for, e.g. "mcpsrv_01Ab...". - - `mcp_server_name: string` + - `id: optional string` - Display name of the MCP server + Unique identifier for the activity e.g. 'activity_abcd1234' - - `tool_name: string` + - `assertion_jti: optional string or null` - Tool name (or '*' for the MCP-server-wide default) + The JWT ID of the identity assertion presented to the authorization server, when one was minted, for cross-reference with the identity provider's own logs. - - `id: optional string` + - `authorization_server_issuer: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The issuer identifier of the authorization server the exchange was attempted against. + + - `correlation_id: optional string or null` + + An opaque identifier customers can quote when contacting Anthropic support about this exchange. - `created_at: optional string` @@ -52590,9 +52632,17 @@ compliance activities that can be filtered by various criteria. format: date-time - - `max_permission: optional string or null` + - `error_subtype: optional string or null` - New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + A more specific classification of the failure, when available. For authorization-server rejections this is the OAuth error code the server returned (for example "invalid_grant"); for identity-provider rejections this is the error code the identity provider returned. Values may be added over time; treat an unrecognized value as a generic failure. + + - `error_type: optional string or null` + + A short classification of why the exchange failed, when outcome is "failure". Values include "authorization_server_rejected", "authorization_server_unavailable", "identity_provider_rejected", "sso_session_invalid", "sso_connection_unsupported", and "connector_scope_not_granted" (the organization's role configuration grants no scopes on this connector, so the request was denied before a token exchange was attempted). Values may be added over time; treat an unrecognized value as a generic failure. + + - `mcp_server_name: optional string or null` + + The MCP server's display name at the time of the exchange, when available. - `organization_id: optional string or null` @@ -52602,13 +52652,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_tool_policy_updated"` + - `outcome: optional string or null` - default: mcp_tool_policy_updated + Whether the token exchange succeeded ("success") or was rejected ("failure"). - - `OrgAnalyticsAPICapabilityUpdated object` + - `type: optional "mcp_server_managed_auth_token_exchanged"` - Organization analytics_api capability was enabled or disabled. + default: mcp_server_managed_auth_token_exchanged + + - `McpServerManagedAuthUpdated object` + + An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server). - `actor: object or object or object or 8 more` @@ -52821,19 +52875,47 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `mcp_server_id: string` + + Tagged ID of the MCP server + + - `mcp_server_name: string` + + Display name of the MCP server + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `allowed_scopes: optional string or null` + + The OAuth scopes managed authorization may request for the server after the change, as a space-delimited list. Null when no scope restriction is configured (or the server has no managed authorization settings); an empty string when the restriction permits no scopes. + + - `built_in_roles_included: optional boolean or null` + + Whether, after the change, managed authorization extends to members who hold one of the organization's built-in roles (such as User, Admin, or Owner) rather than a custom role, in addition to members whose custom role grants it. This describes whom managed authorization reaches and is reported on every change, independent of how built-in role access is configured. + - `created_at: optional string` When this activity occurred. format: date-time - - `current_value: optional boolean or null` + - `individual_auth_enabled: optional boolean or null` - Whether the analytics API capability is enabled immediately after this change + Whether members may authorize the server individually, through their own sign-in and consent, after the change. + + - `managed_auth_enabled: optional boolean or null` + + Whether managed authorization is enabled for the server after the change, so that members whose role permits it are authorized through the organization's identity provider. + + - `managed_auth_mode: optional string or null` + + The managed-authorization mode after the change ("claude" or "sso"): how the identity assertion presented on members' behalf is issued. Recorded whenever managed authorization settings exist, whether or not managed authorization is enabled; null when the server has no managed authorization settings after the change. + + - `mcp_server_url: optional string or null` + + Base URL (scheme, host, port, and path only) of the MCP server at the time of the change; null when not available. - `organization_id: optional string or null` @@ -52843,17 +52925,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` + - `previous_allowed_scopes: optional string or null` - Whether the analytics API capability was enabled immediately before this change + The OAuth scope restriction before the change, as a space-delimited list; null when no scope restriction was configured. - - `type: optional "org_analytics_api_capability_updated"` + - `previous_built_in_roles_included: optional boolean or null` - default: org_analytics_api_capability_updated + Whether managed authorization extended to members holding one of the organization's built-in roles before the change. - - `OrgBulkDeleteInitiated object` + - `previous_individual_auth_enabled: optional boolean or null` - Organization bulk deletion was initiated. + Whether members could authorize the server individually before the change. + + - `previous_managed_auth_enabled: optional boolean or null` + + Whether managed authorization was enabled for the server before the change. + + - `type: optional "mcp_server_managed_auth_updated"` + + default: mcp_server_managed_auth_updated + + - `McpServerUpdated object` + + An MCP server's configuration was updated. - `actor: object or object or object or 8 more` @@ -53066,6 +53160,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `mcp_server_id: string` + + Tagged ID of the MCP server + + - `mcp_server_name: string` + + Display name of the MCP server + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -53084,13 +53186,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_bulk_delete_initiated"` + - `type: optional "mcp_server_updated"` - default: org_bulk_delete_initiated + default: mcp_server_updated - - `OrgCapabilityGrantAdded object` + - `McpToolPolicyUpdated object` - A capability grant was added to a workspace or role. + The permission restriction for an MCP tool was set or cleared. - `actor: object or object or object or 8 more` @@ -53303,23 +53405,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `grant_type: string` - - The type of capability grant that was added. - - - `principal_id: string` - - Tagged ID of the principal the grant was added to. + - `mcp_server_id: string` - - `principal_type: "rbac_role" or "unspecified" or "workspace"` + Tagged ID of the MCP server - The kind of principal the grant was added to. + - `mcp_server_name: string` - - `"rbac_role"` + Display name of the MCP server - - `"unspecified"` + - `tool_name: string` - - `"workspace"` + Tool name (or '*' for the MCP-server-wide default) - `id: optional string` @@ -53331,6 +53427,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `max_permission: optional string or null` + + New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53339,13 +53439,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_capability_grant_added"` + - `type: optional "mcp_tool_policy_updated"` - default: org_capability_grant_added + default: mcp_tool_policy_updated - - `OrgCapabilityGrantRemoved object` + - `OrgAnalyticsAPICapabilityUpdated object` - A capability grant was removed from a workspace or role. + Organization analytics_api capability was enabled or disabled. - `actor: object or object or object or 8 more` @@ -53558,24 +53658,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `grant_type: string` - - The type of capability grant that was removed. - - - `principal_id: string` - - Tagged ID of the principal the grant was removed from. - - - `principal_type: "rbac_role" or "unspecified" or "workspace"` - - The kind of principal the grant was removed from. - - - `"rbac_role"` - - - `"unspecified"` - - - `"workspace"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -53586,6 +53668,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Whether the analytics API capability is enabled immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53594,13 +53680,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_capability_grant_removed"` + - `previous_value: optional boolean or null` - default: org_capability_grant_removed + Whether the analytics API capability was enabled immediately before this change - - `OrgClaudeCodeDataSharingDisabled object` + - `type: optional "org_analytics_api_capability_updated"` - Organization Claude Code data sharing was disabled. + default: org_analytics_api_capability_updated + + - `OrgBulkDeleteInitiated object` + + Organization bulk deletion was initiated. - `actor: object or object or object or 8 more` @@ -53823,10 +53913,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53835,17 +53921,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_data_sharing_disabled"` + - `type: optional "org_bulk_delete_initiated"` - default: org_claude_code_data_sharing_disabled + default: org_bulk_delete_initiated - - `OrgClaudeCodeDataSharingEnabled object` + - `OrgCapabilityGrantAdded object` - Organization Claude Code data sharing was enabled. + A capability grant was added to a workspace or role. - `actor: object or object or object or 8 more` @@ -54058,6 +54140,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `grant_type: string` + + The type of capability grant that was added. + + - `principal_id: string` + + Tagged ID of the principal the grant was added to. + + - `principal_type: "rbac_role" or "unspecified" or "workspace"` + + The kind of principal the grant was added to. + + - `"rbac_role"` + + - `"unspecified"` + + - `"workspace"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -54068,10 +54168,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54080,17 +54176,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_data_sharing_enabled"` + - `type: optional "org_capability_grant_added"` - default: org_claude_code_data_sharing_enabled + default: org_capability_grant_added - - `OrgClaudeCodeDesktopDisabled object` + - `OrgCapabilityGrantRemoved object` - Organization Claude Code Desktop was disabled. + A capability grant was removed from a workspace or role. - `actor: object or object or object or 8 more` @@ -54303,6 +54395,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `grant_type: string` + + The type of capability grant that was removed. + + - `principal_id: string` + + Tagged ID of the principal the grant was removed from. + + - `principal_type: "rbac_role" or "unspecified" or "workspace"` + + The kind of principal the grant was removed from. + + - `"rbac_role"` + + - `"unspecified"` + + - `"workspace"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -54313,10 +54423,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54325,17 +54431,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_desktop_disabled"` + - `type: optional "org_capability_grant_removed"` - default: org_claude_code_desktop_disabled + default: org_capability_grant_removed - - `OrgClaudeCodeDesktopEnabled object` + - `OrgClaudeCodeDataSharingDisabled object` - Organization Claude Code Desktop was enabled. + Organization Claude Code data sharing was disabled. - `actor: object or object or object or 8 more` @@ -54574,15 +54676,13 @@ compliance activities that can be filtered by various criteria. Setting value immediately before this change - - `type: optional "org_claude_code_desktop_enabled"` + - `type: optional "org_claude_code_data_sharing_disabled"` - default: org_claude_code_desktop_enabled + default: org_claude_code_data_sharing_disabled - - `OrgClaudeCodeZeroDataRetentionDisabled object` + - `OrgClaudeCodeDataSharingEnabled object` - A primary owner disabled zero data retention for Claude Code, so Claude - Code content is retained according to the organization's data retention - settings. + Organization Claude Code data sharing was enabled. - `actor: object or object or object or 8 more` @@ -54805,6 +54905,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54813,13 +54917,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_claude_code_zero_data_retention_disabled"` + - `previous_value: optional boolean or null` - default: org_claude_code_zero_data_retention_disabled + Setting value immediately before this change - - `OrgComplianceAPISettingsUpdated object` + - `type: optional "org_claude_code_data_sharing_enabled"` - Organization compliance API settings were updated. + default: org_claude_code_data_sharing_enabled + + - `OrgClaudeCodeDesktopDisabled object` + + Organization Claude Code Desktop was disabled. - `actor: object or object or object or 8 more` @@ -55036,20 +55144,16 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `compliance_api_enabled: optional boolean or null` - - Whether the compliance API is enabled for the organization after this change. - - - `compliance_api_logging_enabled: optional boolean or null` - - Whether compliance activity logging is enabled for the organization after this change. - - `created_at: optional string` When this activity occurred. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -55058,13 +55162,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_compliance_api_settings_updated"` + - `previous_value: optional boolean or null` - default: org_compliance_api_settings_updated + Setting value immediately before this change - - `OrgConnectorDomainGuardUpdated object` + - `type: optional "org_claude_code_desktop_disabled"` - Enterprise admin changed whether connectors are restricted to verified domains. + default: org_claude_code_desktop_disabled + + - `OrgClaudeCodeDesktopEnabled object` + + Organization Claude Code Desktop was enabled. - `actor: object or object or object or 8 more` @@ -55277,8 +55385,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enforced: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -55289,6 +55395,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -55297,13 +55407,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_connector_domain_guard_updated"` + - `previous_value: optional boolean or null` - default: org_connector_domain_guard_updated + Setting value immediately before this change - - `OrgCoworkActWithoutAskingModeDisabled object` + - `type: optional "org_claude_code_desktop_enabled"` - The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval. + default: org_claude_code_desktop_enabled + + - `OrgClaudeCodeZeroDataRetentionDisabled object` + + A primary owner disabled zero data retention for Claude Code, so Claude + Code content is retained according to the organization's data retention + settings. - `actor: object or object or object or 8 more` @@ -55534,13 +55650,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_act_without_asking_mode_disabled"` + - `type: optional "org_claude_code_zero_data_retention_disabled"` - default: org_cowork_act_without_asking_mode_disabled + default: org_claude_code_zero_data_retention_disabled - - `OrgCoworkActWithoutAskingModeEnabled object` + - `OrgComplianceAPISettingsUpdated object` - The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval. + Organization compliance API settings were updated. - `actor: object or object or object or 8 more` @@ -55757,6 +55873,14 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `compliance_api_enabled: optional boolean or null` + + Whether the compliance API is enabled for the organization after this change. + + - `compliance_api_logging_enabled: optional boolean or null` + + Whether compliance activity logging is enabled for the organization after this change. + - `created_at: optional string` When this activity occurred. @@ -55771,13 +55895,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_act_without_asking_mode_enabled"` + - `type: optional "org_compliance_api_settings_updated"` - default: org_cowork_act_without_asking_mode_enabled + default: org_compliance_api_settings_updated - - `OrgCoworkAgentDisabled object` + - `OrgConnectorDomainGuardUpdated object` - Organization Cowork Agent was disabled. + Enterprise admin changed whether connectors are restricted to verified domains. - `actor: object or object or object or 8 more` @@ -55990,6 +56114,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enforced: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -56000,10 +56126,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56012,17 +56134,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_agent_disabled"` + - `type: optional "org_connector_domain_guard_updated"` - default: org_cowork_agent_disabled + default: org_connector_domain_guard_updated - - `OrgCoworkAgentEnabled object` + - `OrgCoworkActWithoutAskingModeDisabled object` - Organization Cowork Agent was enabled. + The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval. - `actor: object or object or object or 8 more` @@ -56245,10 +56363,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56257,17 +56371,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_agent_enabled"` + - `type: optional "org_cowork_act_without_asking_mode_disabled"` - default: org_cowork_agent_enabled + default: org_cowork_act_without_asking_mode_disabled - - `OrgCoworkAutoModeDisabled object` + - `OrgCoworkActWithoutAskingModeEnabled object` - The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check. + The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval. - `actor: object or object or object or 8 more` @@ -56498,13 +56608,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_auto_mode_disabled"` + - `type: optional "org_cowork_act_without_asking_mode_enabled"` - default: org_cowork_auto_mode_disabled + default: org_cowork_act_without_asking_mode_enabled - - `OrgCoworkAutoModeEnabled object` + - `OrgCoworkAgentDisabled object` - The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check. + Organization Cowork Agent was disabled. - `actor: object or object or object or 8 more` @@ -56727,6 +56837,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56735,13 +56849,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_auto_mode_enabled"` + - `previous_value: optional boolean or null` - default: org_cowork_auto_mode_enabled + Setting value immediately before this change - - `OrgCoworkDisabled object` + - `type: optional "org_cowork_agent_disabled"` - Organization cowork was disabled. + default: org_cowork_agent_disabled + + - `OrgCoworkAgentEnabled object` + + Organization Cowork Agent was enabled. - `actor: object or object or object or 8 more` @@ -56980,13 +57098,13 @@ compliance activities that can be filtered by various criteria. Setting value immediately before this change - - `type: optional "org_cowork_disabled"` + - `type: optional "org_cowork_agent_enabled"` - default: org_cowork_disabled + default: org_cowork_agent_enabled - - `OrgCoworkEnabled object` + - `OrgCoworkAutoModeDisabled object` - Organization cowork was enabled. + The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check. - `actor: object or object or object or 8 more` @@ -57209,10 +57327,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -57221,17 +57335,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_enabled"` + - `type: optional "org_cowork_auto_mode_disabled"` - default: org_cowork_enabled + default: org_cowork_auto_mode_disabled - - `OrgCoworkMcpAlwaysAllowDisabled object` + - `OrgCoworkAutoModeEnabled object` - The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting. + The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check. - `actor: object or object or object or 8 more` @@ -57462,13 +57572,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_mcp_always_allow_disabled"` + - `type: optional "org_cowork_auto_mode_enabled"` - default: org_cowork_mcp_always_allow_disabled + default: org_cowork_auto_mode_enabled - - `OrgCoworkMcpAlwaysAllowEnabled object` + - `OrgCoworkDisabled object` - The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting. + Organization cowork was disabled. - `actor: object or object or object or 8 more` @@ -57691,6 +57801,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -57699,13 +57813,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_mcp_always_allow_enabled"` + - `previous_value: optional boolean or null` - default: org_cowork_mcp_always_allow_enabled + Setting value immediately before this change - - `OrgCoworkOtlpSettingsUpdated object` + - `type: optional "org_cowork_disabled"` - The organization's Cowork OpenTelemetry monitoring export settings were updated. + default: org_cowork_disabled + + - `OrgCoworkEnabled object` + + Organization cowork was enabled. - `actor: object or object or object or 8 more` @@ -57928,21 +58046,9 @@ compliance activities that can be filtered by various criteria. format: date-time - - `new_otlp_content_capture: optional array of string or null` - - The organization's content-capture settings after the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings are not set or were not modified by this update. - - - `new_otlp_endpoint: optional string or null` - - The OpenTelemetry export endpoint after the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint is unset or was not itself modified by this update. - - - `new_otlp_protocol: optional string or null` - - The OpenTelemetry export protocol after the change. Null if the protocol is unset or was not itself modified by this update. - - - `new_otlp_resource_attributes: optional string or null` + - `current_value: optional boolean or null` - The OpenTelemetry resource attributes after the change. Null if the attributes are unset or were not themselves modified by this update. + Setting value immediately after this change - `organization_id: optional string or null` @@ -57952,37 +58058,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `otlp_headers_change: optional "cleared" or "set" or null` - - Whether the OpenTelemetry export headers were set or cleared. 'set' is recorded for any non-empty submission, including resubmission of an unchanged value. Header values are never included. - - - `"cleared"` - - - `"set"` - - - `previous_otlp_content_capture: optional array of string or null` - - The organization's content-capture settings before the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings were not previously set or were not modified by this update. - - - `previous_otlp_endpoint: optional string or null` - - The OpenTelemetry export endpoint before the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint was previously unset or was not itself modified by this update. - - - `previous_otlp_protocol: optional string or null` - - The OpenTelemetry export protocol before the change. Null if the protocol was previously unset or was not itself modified by this update. - - - `previous_otlp_resource_attributes: optional string or null` + - `previous_value: optional boolean or null` - The OpenTelemetry resource attributes before the change. Null if the attributes were previously unset or were not themselves modified by this update. + Setting value immediately before this change - - `type: optional "org_cowork_otlp_settings_updated"` + - `type: optional "org_cowork_enabled"` - default: org_cowork_otlp_settings_updated + default: org_cowork_enabled - - `OrgCoworkRemoteDisabled object` + - `OrgCoworkMcpAlwaysAllowDisabled object` - Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments. + The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting. - `actor: object or object or object or 8 more` @@ -58213,13 +58299,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_remote_disabled"` + - `type: optional "org_cowork_mcp_always_allow_disabled"` - default: org_cowork_remote_disabled + default: org_cowork_mcp_always_allow_disabled - - `OrgCoworkRemoteEnabled object` + - `OrgCoworkMcpAlwaysAllowEnabled object` - Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments. + The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting. - `actor: object or object or object or 8 more` @@ -58450,13 +58536,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_remote_enabled"` + - `type: optional "org_cowork_mcp_always_allow_enabled"` - default: org_cowork_remote_enabled + default: org_cowork_mcp_always_allow_enabled - - `OrgCreationBlocked object` + - `OrgCoworkOtlpSettingsUpdated object` - Organization creation was blocked. + The organization's Cowork OpenTelemetry monitoring export settings were updated. - `actor: object or object or object or 8 more` @@ -58679,6 +58765,22 @@ compliance activities that can be filtered by various criteria. format: date-time + - `new_otlp_content_capture: optional array of string or null` + + The organization's content-capture settings after the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings are not set or were not modified by this update. + + - `new_otlp_endpoint: optional string or null` + + The OpenTelemetry export endpoint after the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint is unset or was not itself modified by this update. + + - `new_otlp_protocol: optional string or null` + + The OpenTelemetry export protocol after the change. Null if the protocol is unset or was not itself modified by this update. + + - `new_otlp_resource_attributes: optional string or null` + + The OpenTelemetry resource attributes after the change. Null if the attributes are unset or were not themselves modified by this update. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -58687,15 +58789,37 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reason: optional string or null` + - `otlp_headers_change: optional "cleared" or "set" or null` - - `type: optional "org_creation_blocked"` + Whether the OpenTelemetry export headers were set or cleared. 'set' is recorded for any non-empty submission, including resubmission of an unchanged value. Header values are never included. - default: org_creation_blocked + - `"cleared"` - - `OrgDataExportAccessed object` + - `"set"` - Organization data export file was accessed/downloaded via signed URL. + - `previous_otlp_content_capture: optional array of string or null` + + The organization's content-capture settings before the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings were not previously set or were not modified by this update. + + - `previous_otlp_endpoint: optional string or null` + + The OpenTelemetry export endpoint before the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint was previously unset or was not itself modified by this update. + + - `previous_otlp_protocol: optional string or null` + + The OpenTelemetry export protocol before the change. Null if the protocol was previously unset or was not itself modified by this update. + + - `previous_otlp_resource_attributes: optional string or null` + + The OpenTelemetry resource attributes before the change. Null if the attributes were previously unset or were not themselves modified by this update. + + - `type: optional "org_cowork_otlp_settings_updated"` + + default: org_cowork_otlp_settings_updated + + - `OrgCoworkRemoteDisabled object` + + Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments. - `actor: object or object or object or 8 more` @@ -58918,14 +59042,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was downloaded. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -58934,13 +59050,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_export_accessed"` + - `type: optional "org_cowork_remote_disabled"` - default: org_data_export_accessed + default: org_cowork_remote_disabled - - `OrgDataExportCompleted object` + - `OrgCoworkRemoteEnabled object` - Organization data export was completed. + Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments. - `actor: object or object or object or 8 more` @@ -59163,14 +59279,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was exported. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59179,13 +59287,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_export_completed"` + - `type: optional "org_cowork_remote_enabled"` - default: org_data_export_completed + default: org_cowork_remote_enabled - - `OrgDataExportStarted object` + - `OrgCreationBlocked object` - Organization data export was started. + Organization creation was blocked. - `actor: object or object or object or 8 more` @@ -59408,14 +59516,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was exported. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59424,21 +59524,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scope: optional "member_own_data" or "organization" or null` - - Breadth of the export — the whole organization, or only the requesting member's own data. Absent on records written before this field was introduced. - - - `"member_own_data"` - - - `"organization"` + - `reason: optional string or null` - - `type: optional "org_data_export_started"` + - `type: optional "org_creation_blocked"` - default: org_data_export_started + default: org_creation_blocked - - `OrgDataResidencyUpdated object` + - `OrgDataExportAccessed object` - The organization's inference data residency settings were updated. + Organization data export file was accessed/downloaded via signed URL. - `actor: object or object or object or 8 more` @@ -59651,22 +59745,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `updates: array of object` - - - `current_value: string or null` - - Setting value immediately after this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. - - - `previous_value: string or null` - - Setting value immediately before this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. - - - `type: "allowed_inference_geos" or "default_inference_geo"` - - - `"allowed_inference_geos"` - - - `"default_inference_geo"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -59677,6 +59755,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was downloaded. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59685,13 +59771,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_residency_updated"` + - `type: optional "org_data_export_accessed"` - default: org_data_residency_updated + default: org_data_export_accessed - - `OrgDeletedViaBulk object` + - `OrgDataExportCompleted object` - Organization was deleted via bulk operation. + Organization data export was completed. - `actor: object or object or object or 8 more` @@ -59914,6 +60000,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was exported. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59922,13 +60016,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_deleted_via_bulk"` + - `type: optional "org_data_export_completed"` - default: org_deleted_via_bulk + default: org_data_export_completed - - `OrgDeletionRequested object` + - `OrgDataExportStarted object` - Organization deletion was requested. + Organization data export was started. - `actor: object or object or object or 8 more` @@ -60151,6 +60245,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was exported. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -60159,13 +60261,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_deletion_requested"` + - `scope: optional "member_own_data" or "organization" or null` - default: org_deletion_requested + Breadth of the export — the whole organization, or only the requesting member's own data. Absent on records written before this field was introduced. - - `OrgDirectoryResyncCompleted object` + - `"member_own_data"` - Organization directory resync completed successfully. + - `"organization"` + + - `type: optional "org_data_export_started"` + + default: org_data_export_started + + - `OrgDataResidencyUpdated object` + + The organization's inference data residency settings were updated. - `actor: object or object or object or 8 more` @@ -60378,7 +60488,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` + - `updates: array of object` + + - `current_value: string or null` + + Setting value immediately after this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. + + - `previous_value: string or null` + + Setting value immediately before this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. + + - `type: "allowed_inference_geos" or "default_inference_geo"` + + - `"allowed_inference_geos"` + + - `"default_inference_geo"` - `id: optional string` @@ -60398,13 +60522,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_completed"` + - `type: optional "org_data_residency_updated"` - default: org_directory_resync_completed + default: org_data_residency_updated - - `OrgDirectoryResyncFailed object` + - `OrgDeletedViaBulk object` - Organization directory resync failed. + Organization was deleted via bulk operation. - `actor: object or object or object or 8 more` @@ -60617,8 +60741,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -60637,13 +60759,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_failed"` + - `type: optional "org_deleted_via_bulk"` - default: org_directory_resync_failed + default: org_deleted_via_bulk - - `OrgDirectoryResyncStarted object` + - `OrgDeletionRequested object` - Organization directory resync was started asynchronously. + Organization deletion was requested. - `actor: object or object or object or 8 more` @@ -60856,10 +60978,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` - - - `sync_destinations: array of string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -60878,13 +60996,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_started"` + - `type: optional "org_deletion_requested"` - default: org_directory_resync_started + default: org_deletion_requested - - `OrgDirectorySyncActivated object` + - `OrgDirectoryResyncCompleted object` - Organization directory sync was activated. + Organization directory resync completed successfully. - `actor: object or object or object or 8 more` @@ -61097,6 +61215,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61115,13 +61235,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_activated"` + - `type: optional "org_directory_resync_completed"` - default: org_directory_sync_activated + default: org_directory_resync_completed - - `OrgDirectorySyncAddInitiated object` + - `OrgDirectoryResyncFailed object` - Organization directory sync setup was initiated. + Organization directory resync failed. - `actor: object or object or object or 8 more` @@ -61334,6 +61454,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61352,13 +61474,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_add_initiated"` + - `type: optional "org_directory_resync_failed"` - default: org_directory_sync_add_initiated + default: org_directory_resync_failed - - `OrgDirectorySyncDeleted object` + - `OrgDirectoryResyncStarted object` - Organization directory sync was deleted. + Organization directory resync was started asynchronously. - `actor: object or object or object or 8 more` @@ -61571,6 +61693,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + + - `sync_destinations: array of string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61589,13 +61715,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_deleted"` + - `type: optional "org_directory_resync_started"` - default: org_directory_sync_deleted + default: org_directory_resync_started - - `OrgDiscoverabilityDisabled object` + - `OrgDirectorySyncActivated object` - Admin disabled organization discoverability. + Organization directory sync was activated. - `actor: object or object or object or 8 more` @@ -61826,13 +61952,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_disabled"` + - `type: optional "org_directory_sync_activated"` - default: org_discoverability_disabled + default: org_directory_sync_activated - - `OrgDiscoverabilityEnabled object` + - `OrgDirectorySyncAddInitiated object` - Admin enabled organization discoverability. + Organization directory sync setup was initiated. - `actor: object or object or object or 8 more` @@ -62063,13 +62189,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_enabled"` + - `type: optional "org_directory_sync_add_initiated"` - default: org_discoverability_enabled + default: org_directory_sync_add_initiated - - `OrgDiscoverabilitySettingsUpdated object` + - `OrgDirectorySyncDeleted object` - Admin updated organization discoverability settings. + Organization directory sync was deleted. - `actor: object or object or object or 8 more` @@ -62300,13 +62426,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_settings_updated"` + - `type: optional "org_directory_sync_deleted"` - default: org_discoverability_settings_updated + default: org_directory_sync_deleted - - `OrgDomainAddInitiated object` + - `OrgDiscoverabilityDisabled object` - Organization domain verification was initiated. + Admin disabled organization discoverability. - `actor: object or object or object or 8 more` @@ -62537,13 +62663,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_add_initiated"` + - `type: optional "org_discoverability_disabled"` - default: org_domain_add_initiated + default: org_discoverability_disabled - - `OrgDomainRemoved object` + - `OrgDiscoverabilityEnabled object` - Organization domain was removed. + Admin enabled organization discoverability. - `actor: object or object or object or 8 more` @@ -62766,8 +62892,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `domain: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -62776,13 +62900,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_removed"` + - `type: optional "org_discoverability_enabled"` - default: org_domain_removed + default: org_discoverability_enabled - - `OrgDomainVerified object` + - `OrgDiscoverabilitySettingsUpdated object` - Organization domain was verified. + Admin updated organization discoverability settings. - `actor: object or object or object or 8 more` @@ -63005,8 +63129,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `domain: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63015,13 +63137,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_verified"` + - `type: optional "org_discoverability_settings_updated"` - default: org_domain_verified + default: org_discoverability_settings_updated - - `OrgExternalKeyCreated object` + - `OrgDomainAddInitiated object` - A CMEK external key config was created. + Organization domain verification was initiated. - `actor: object or object or object or 8 more` @@ -63234,22 +63356,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the created external key config - - - `provider: "aws" or "azure" or "gcp" or "unspecified"` - - KMS provider backing the key - - - `"aws"` - - - `"azure"` - - - `"gcp"` - - - `"unspecified"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63268,13 +63374,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_created"` + - `type: optional "org_domain_add_initiated"` - default: org_external_key_created + default: org_domain_add_initiated - - `OrgExternalKeyDeleted object` + - `OrgDomainRemoved object` - A CMEK external key config was deleted. + Organization domain was removed. - `actor: object or object or object or 8 more` @@ -63487,10 +63593,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the deleted external key config - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63501,6 +63603,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `domain: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63509,13 +63613,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_deleted"` + - `type: optional "org_domain_removed"` - default: org_external_key_deleted + default: org_domain_removed - - `OrgExternalKeyUpdated object` + - `OrgDomainVerified object` - A CMEK external key config was updated. + Organization domain was verified. - `actor: object or object or object or 8 more` @@ -63728,10 +63832,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the updated external key config - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63742,6 +63842,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `domain: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63750,37 +63852,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_updated"` - - default: org_external_key_updated - - - `updates: optional array of object` - - The field-level changes applied in this update - - - `current_value: string` - - Field value immediately after this change - - - `previous_value: string` - - Field value immediately before this change - - - `type: "display_name" or "geo" or "provider_config" or "unspecified"` - - The external key config field that changed - - - `"display_name"` - - - `"geo"` - - - `"provider_config"` + - `type: optional "org_domain_verified"` - - `"unspecified"` + default: org_domain_verified - - `OrgExternalKeyValidated object` + - `OrgExternalKeyCreated object` - A CMEK external key config was validated against the customer's KMS. + A CMEK external key config was created. - `actor: object or object or object or 8 more` @@ -63995,15 +64073,17 @@ compliance activities that can be filtered by various criteria. - `external_key_id: string` - Tagged ID of the validated external key config + Tagged ID of the created external key config - - `validation_result: "failure" or "success" or "unspecified"` + - `provider: "aws" or "azure" or "gcp" or "unspecified"` - Outcome of the encrypt/decrypt roundtrip + KMS provider backing the key - - `"failure"` + - `"aws"` - - `"success"` + - `"azure"` + + - `"gcp"` - `"unspecified"` @@ -64025,14 +64105,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_validated"` + - `type: optional "org_external_key_created"` - default: org_external_key_validated + default: org_external_key_created - - `OrgHipaaSelfServeEnabled object` + - `OrgExternalKeyDeleted object` - A primary owner click-accepted the BAA and enabled HIPAA protections - for the organization via the self-serve flow. + A CMEK external key config was deleted. - `actor: object or object or object or 8 more` @@ -64245,11 +64324,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `baa_content_hash: string` - - - `baa_version_label: string` + - `external_key_id: string` - - `setup_guide_content_hash: string` + Tagged ID of the deleted external key config - `id: optional string` @@ -64269,13 +64346,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_hipaa_self_serve_enabled"` + - `type: optional "org_external_key_deleted"` - default: org_hipaa_self_serve_enabled + default: org_external_key_deleted - - `OrgIPRestrictionCreated object` + - `OrgExternalKeyUpdated object` - Organization IP restriction was created. + A CMEK external key config was updated. - `actor: object or object or object or 8 more` @@ -64488,6 +64565,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `external_key_id: string` + + Tagged ID of the updated external key config + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64506,13 +64587,37 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_created"` + - `type: optional "org_external_key_updated"` - default: org_ip_restriction_created + default: org_external_key_updated - - `OrgIPRestrictionDeleted object` + - `updates: optional array of object` - Organization IP restriction was deleted. + The field-level changes applied in this update + + - `current_value: string` + + Field value immediately after this change + + - `previous_value: string` + + Field value immediately before this change + + - `type: "display_name" or "geo" or "provider_config" or "unspecified"` + + The external key config field that changed + + - `"display_name"` + + - `"geo"` + + - `"provider_config"` + + - `"unspecified"` + + - `OrgExternalKeyValidated object` + + A CMEK external key config was validated against the customer's KMS. - `actor: object or object or object or 8 more` @@ -64725,6 +64830,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `external_key_id: string` + + Tagged ID of the validated external key config + + - `validation_result: "failure" or "success" or "unspecified"` + + Outcome of the encrypt/decrypt roundtrip + + - `"failure"` + + - `"success"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64743,13 +64862,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_deleted"` + - `type: optional "org_external_key_validated"` - default: org_ip_restriction_deleted + default: org_external_key_validated - - `OrgIPRestrictionUpdated object` + - `OrgHipaaSelfServeEnabled object` - Organization IP restriction was updated. + A primary owner click-accepted the BAA and enabled HIPAA protections + for the organization via the self-serve flow. - `actor: object or object or object or 8 more` @@ -64962,6 +65082,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `baa_content_hash: string` + + - `baa_version_label: string` + + - `setup_guide_content_hash: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64980,13 +65106,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_updated"` + - `type: optional "org_hipaa_self_serve_enabled"` - default: org_ip_restriction_updated + default: org_hipaa_self_serve_enabled - - `OrgInviteLinkDisabled object` + - `OrgIPRestrictionCreated object` - Organization invite link was disabled. + Organization IP restriction was created. - `actor: object or object or object or 8 more` @@ -65217,13 +65343,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_disabled"` + - `type: optional "org_ip_restriction_created"` - default: org_invite_link_disabled + default: org_ip_restriction_created - - `OrgInviteLinkGenerated object` + - `OrgIPRestrictionDeleted object` - Organization invite link was generated. + Organization IP restriction was deleted. - `actor: object or object or object or 8 more` @@ -65454,13 +65580,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_generated"` + - `type: optional "org_ip_restriction_deleted"` - default: org_invite_link_generated + default: org_ip_restriction_deleted - - `OrgInviteLinkRegenerated object` + - `OrgIPRestrictionUpdated object` - Organization invite link was regenerated (previous link invalidated). + Organization IP restriction was updated. - `actor: object or object or object or 8 more` @@ -65691,13 +65817,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_regenerated"` + - `type: optional "org_ip_restriction_updated"` - default: org_invite_link_regenerated + default: org_ip_restriction_updated - - `OrgInviteViewed object` + - `OrgInviteLinkDisabled object` - An organization invite was viewed. + Organization invite link was disabled. - `actor: object or object or object or 8 more` @@ -65910,10 +66036,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invite_id: string` - - Tagged ID of the viewed invite - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -65932,13 +66054,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_viewed"` + - `type: optional "org_invite_link_disabled"` - default: org_invite_viewed + default: org_invite_link_disabled - - `OrgInvitesListed object` + - `OrgInviteLinkGenerated object` - Organization invites were listed. + Organization invite link was generated. - `actor: object or object or object or 8 more` @@ -66169,13 +66291,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invites_listed"` + - `type: optional "org_invite_link_generated"` - default: org_invites_listed + default: org_invite_link_generated - - `OrgJoinProposalDecided object` + - `OrgInviteLinkRegenerated object` - Approve or reject decision on a parent-org join proposal. + Organization invite link was regenerated (previous link invalidated). - `actor: object or object or object or 8 more` @@ -66388,8 +66510,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `approved: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -66408,13 +66528,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_proposal_decided"` + - `type: optional "org_invite_link_regenerated"` - default: org_join_proposal_decided + default: org_invite_link_regenerated - - `OrgJoinRequestApproved object` + - `OrgInviteViewed object` - Admin approved a join request. + An organization invite was viewed. - `actor: object or object or object or 8 more` @@ -66627,6 +66747,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invite_id: string` + + Tagged ID of the viewed invite + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -66645,13 +66769,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_approved"` + - `type: optional "org_invite_viewed"` - default: org_join_request_approved + default: org_invite_viewed - - `OrgJoinRequestCreated object` + - `OrgInvitesListed object` - User requested to join an organization. + Organization invites were listed. - `actor: object or object or object or 8 more` @@ -66882,13 +67006,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_created"` + - `type: optional "org_invites_listed"` - default: org_join_request_created + default: org_invites_listed - - `OrgJoinRequestDismissed object` + - `OrgJoinProposalDecided object` - Admin dismissed a join request. + Approve or reject decision on a parent-org join proposal. - `actor: object or object or object or 8 more` @@ -67101,6 +67225,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `approved: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -67119,13 +67245,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_dismissed"` + - `type: optional "org_join_proposal_decided"` - default: org_join_request_dismissed + default: org_join_proposal_decided - - `OrgJoinRequestInstantApproved object` + - `OrgJoinRequestApproved object` - Join request was instantly approved. + Admin approved a join request. - `actor: object or object or object or 8 more` @@ -67356,13 +67482,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_instant_approved"` + - `type: optional "org_join_request_approved"` - default: org_join_request_instant_approved + default: org_join_request_approved - - `OrgJoinRequestsBulkDismissed object` + - `OrgJoinRequestCreated object` - Admin bulk-dismissed join requests. + User requested to join an organization. - `actor: object or object or object or 8 more` @@ -67593,13 +67719,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_requests_bulk_dismissed"` + - `type: optional "org_join_request_created"` - default: org_join_requests_bulk_dismissed + default: org_join_request_created - - `OrgMagicLinkSecondFactorToggled object` + - `OrgJoinRequestDismissed object` - Organization magic link second factor was toggled. + Admin dismissed a join request. - `actor: object or object or object or 8 more` @@ -67812,8 +67938,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -67832,13 +67956,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_magic_link_second_factor_toggled"` + - `type: optional "org_join_request_dismissed"` - default: org_magic_link_second_factor_toggled + default: org_join_request_dismissed - - `OrgMemberInvitesDisabled object` + - `OrgJoinRequestInstantApproved object` - Admin disabled member invites for the organization. + Join request was instantly approved. - `actor: object or object or object or 8 more` @@ -68069,13 +68193,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_member_invites_disabled"` + - `type: optional "org_join_request_instant_approved"` - default: org_member_invites_disabled + default: org_join_request_instant_approved - - `OrgMemberInvitesEnabled object` + - `OrgJoinRequestsBulkDismissed object` - Admin enabled member invites for the organization. + Admin bulk-dismissed join requests. - `actor: object or object or object or 8 more` @@ -68306,13 +68430,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_member_invites_enabled"` + - `type: optional "org_join_requests_bulk_dismissed"` - default: org_member_invites_enabled + default: org_join_requests_bulk_dismissed - - `OrgMembersExported object` + - `OrgMagicLinkSecondFactorToggled object` - Organization members list was exported as CSV. + Organization magic link second factor was toggled. - `actor: object or object or object or 8 more` @@ -68525,6 +68649,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -68543,23 +68669,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_members_exported"` - - default: org_members_exported - - - `OrgModelDefaultUpdated object` - - An organization or role default model setting was changed by an administrator. - - - `action: "cleared" or "set" or "unspecified"` - - Whether the default model was set or cleared + - `type: optional "org_magic_link_second_factor_toggled"` - - `"cleared"` + default: org_magic_link_second_factor_toggled - - `"set"` + - `OrgMemberInvitesDisabled object` - - `"unspecified"` + Admin disabled member invites for the organization. - `actor: object or object or object or 8 more` @@ -68772,24 +68888,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `override_user_selection: boolean` - - Whether the default is enforced as a fixed default, resetting members' own model selections at the start of each new conversation - - - `principal_id: string` - - Tagged ID of the organization or role the default applies to - - - `principal_type: "org" or "rbac_role" or "unspecified"` - - Whether the default applies to the whole organization or to a single role - - - `"org"` - - - `"rbac_role"` - - - `"unspecified"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -68800,26 +68898,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_model: optional string or null` - - The model set as the default, when the action is set - - - `model_access: optional array of object` - - The per-model access overrides set for this principal; absent when no overrides are configured - - - `api_name: string` - - The model the decision applies to - - - `enabled: boolean` - - Whether members with this principal may select the model - - - `max_effort_level: optional string or null` - - The highest effort level members may select for this model, when capped - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -68828,13 +68906,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_model_default_updated"` + - `type: optional "org_member_invites_disabled"` - default: org_model_default_updated + default: org_member_invites_disabled - - `OrgParentJoinProposalCreated object` + - `OrgMemberInvitesEnabled object` - Organization parent join proposal was created. + Admin enabled member invites for the organization. - `actor: object or object or object or 8 more` @@ -69065,13 +69143,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_parent_join_proposal_created"` + - `type: optional "org_member_invites_enabled"` - default: org_parent_join_proposal_created + default: org_member_invites_enabled - - `OrgParentSearchPerformed object` + - `OrgMembersExported object` - Organization parent search was performed. + Organization members list was exported as CSV. - `actor: object or object or object or 8 more` @@ -69302,13 +69380,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_parent_search_performed"` + - `type: optional "org_members_exported"` - default: org_parent_search_performed + default: org_members_exported - - `OrgSSOAddInitiated object` + - `OrgModelDefaultUpdated object` - Organization SSO setup was initiated. + An organization or role default model setting was changed by an administrator. + + - `action: "cleared" or "set" or "unspecified"` + + Whether the default model was set or cleared + + - `"cleared"` + + - `"set"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -69521,6 +69609,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `override_user_selection: boolean` + + Whether the default is enforced as a fixed default, resetting members' own model selections at the start of each new conversation + + - `principal_id: string` + + Tagged ID of the organization or role the default applies to + + - `principal_type: "org" or "rbac_role" or "unspecified"` + + Whether the default applies to the whole organization or to a single role + + - `"org"` + + - `"rbac_role"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -69531,6 +69637,26 @@ compliance activities that can be filtered by various criteria. format: date-time + - `default_model: optional string or null` + + The model set as the default, when the action is set + + - `model_access: optional array of object` + + The per-model access overrides set for this principal; absent when no overrides are configured + + - `api_name: string` + + The model the decision applies to + + - `enabled: boolean` + + Whether members with this principal may select the model + + - `max_effort_level: optional string or null` + + The highest effort level members may select for this model, when capped + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -69539,13 +69665,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_add_initiated"` + - `type: optional "org_model_default_updated"` - default: org_sso_add_initiated + default: org_model_default_updated - - `OrgSSOConnectionActivated object` + - `OrgParentJoinProposalCreated object` - Organization SSO connection was activated. + Organization parent join proposal was created. - `actor: object or object or object or 8 more` @@ -69762,10 +69888,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - - `connection_type: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -69780,13 +69902,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_activated"` + - `type: optional "org_parent_join_proposal_created"` - default: org_sso_connection_activated + default: org_parent_join_proposal_created - - `OrgSSOConnectionDeactivated object` + - `OrgParentSearchPerformed object` - Organization SSO connection was deactivated. + Organization parent search was performed. - `actor: object or object or object or 8 more` @@ -70003,8 +70125,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -70019,13 +70139,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_deactivated"` + - `type: optional "org_parent_search_performed"` - default: org_sso_connection_deactivated + default: org_parent_search_performed - - `OrgSSOConnectionDeleted object` + - `OrgSSOAddInitiated object` - Organization SSO connection was deleted. + Organization SSO setup was initiated. - `actor: object or object or object or 8 more` @@ -70242,8 +70362,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -70258,13 +70376,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_deleted"` + - `type: optional "org_sso_add_initiated"` - default: org_sso_connection_deleted + default: org_sso_add_initiated - - `OrgSSOGroupRoleMappingsUpdated object` + - `OrgSSOConnectionActivated object` - Organization SSO group role mappings were updated. + Organization SSO connection was activated. - `actor: object or object or object or 8 more` @@ -70481,6 +70599,10 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + + - `connection_type: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -70495,13 +70617,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_group_role_mappings_updated"` + - `type: optional "org_sso_connection_activated"` - default: org_sso_group_role_mappings_updated + default: org_sso_connection_activated - - `OrgSSOProvisioningModeChanged object` + - `OrgSSOConnectionDeactivated object` - Organization SSO provisioning mode was changed. + Organization SSO connection was deactivated. - `actor: object or object or object or 8 more` @@ -70718,14 +70840,14 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + - `created_at: optional string` When this activity occurred. format: date-time - - `new_mode: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -70734,15 +70856,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mode: optional string or null` - - - `type: optional "org_sso_provisioning_mode_changed"` + - `type: optional "org_sso_connection_deactivated"` - default: org_sso_provisioning_mode_changed + default: org_sso_connection_deactivated - - `OrgSSOScimWelcomeEmailToggled object` + - `OrgSSOConnectionDeleted object` - Organization SCIM-provisioned welcome email was toggled. + Organization SSO connection was deleted. - `actor: object or object or object or 8 more` @@ -70955,12 +71075,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -70975,17 +71095,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether the SCIM welcome email was enabled before this change. - - - `type: optional "org_sso_scim_welcome_email_toggled"` + - `type: optional "org_sso_connection_deleted"` - default: org_sso_scim_welcome_email_toggled + default: org_sso_connection_deleted - - `OrgSSOSeatTierAssignmentToggled object` + - `OrgSSOGroupRoleMappingsUpdated object` - Organization SSO seat tier assignment was toggled. + Organization SSO group role mappings were updated. - `actor: object or object or object or 8 more` @@ -71198,8 +71314,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -71218,17 +71332,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether SSO seat tier assignment was enabled before this change. - - - `type: optional "org_sso_seat_tier_assignment_toggled"` + - `type: optional "org_sso_group_role_mappings_updated"` - default: org_sso_seat_tier_assignment_toggled + default: org_sso_group_role_mappings_updated - - `OrgSSOSeatTierMappingsUpdated object` + - `OrgSSOProvisioningModeChanged object` - Organization SSO seat tier mappings were updated. + Organization SSO provisioning mode was changed. - `actor: object or object or object or 8 more` @@ -71451,17 +71561,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_mappings: optional array of object or null` - - Identity provider group to seat tier mappings after this change. - - - `idp_group_name: string` - - Name of the identity provider group. - - - `seat_tier: optional string or null` - - Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `new_mode: optional string or null` - `organization_id: optional string or null` @@ -71471,25 +71571,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mappings: optional array of object or null` - - Identity provider group to seat tier mappings before this change. - - - `idp_group_name: string` - - Name of the identity provider group. - - - `seat_tier: optional string or null` - - Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `previous_mode: optional string or null` - - `type: optional "org_sso_seat_tier_mappings_updated"` + - `type: optional "org_sso_provisioning_mode_changed"` - default: org_sso_seat_tier_mappings_updated + default: org_sso_provisioning_mode_changed - - `OrgSSOToggled object` + - `OrgSSOScimWelcomeEmailToggled object` - Organization SSO was toggled on or off. + Organization SCIM-provisioned welcome email was toggled. - `actor: object or object or object or 8 more` @@ -71722,13 +71812,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_toggled"` + - `previous_enabled: optional boolean or null` - default: org_sso_toggled + Whether the SCIM welcome email was enabled before this change. - - `OrgSyncDeletingSynchronizedFilesStarted object` + - `type: optional "org_sso_scim_welcome_email_toggled"` - Organization started deleting synchronized files. + default: org_sso_scim_welcome_email_toggled + + - `OrgSSOSeatTierAssignmentToggled object` + + Organization SSO seat tier assignment was toggled. - `actor: object or object or object or 8 more` @@ -71941,6 +72035,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -71959,13 +72055,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sync_deleting_synchronized_files_started"` + - `previous_enabled: optional boolean or null` - default: org_sync_deleting_synchronized_files_started + Whether SSO seat tier assignment was enabled before this change. - - `OrgSyncSynchronizedFilesDeleted object` + - `type: optional "org_sso_seat_tier_assignment_toggled"` - Organization synchronized files were deleted. + default: org_sso_seat_tier_assignment_toggled + + - `OrgSSOSeatTierMappingsUpdated object` + + Organization SSO seat tier mappings were updated. - `actor: object or object or object or 8 more` @@ -72188,6 +72288,18 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_mappings: optional array of object or null` + + Identity provider group to seat tier mappings after this change. + + - `idp_group_name: string` + + Name of the identity provider group. + + - `seat_tier: optional string or null` + + Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -72196,13 +72308,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sync_synchronized_files_deleted"` + - `previous_mappings: optional array of object or null` - default: org_sync_synchronized_files_deleted + Identity provider group to seat tier mappings before this change. - - `OrgTaintAdded object` + - `idp_group_name: string` - A taint was added to an organization. + Name of the identity provider group. + + - `seat_tier: optional string or null` + + Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + + - `type: optional "org_sso_seat_tier_mappings_updated"` + + default: org_sso_seat_tier_mappings_updated + + - `OrgSSOToggled object` + + Organization SSO was toggled on or off. - `actor: object or object or object or 8 more` @@ -72415,6 +72539,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -72433,19 +72559,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `taint: optional string or null` - - - `type: optional "org_taint_added"` - - default: org_taint_added - - - `workspace_id: optional string or null` + - `type: optional "org_sso_toggled"` - Tagged ID of the workspace the taint was applied to. Unset when applied at organization scope. + default: org_sso_toggled - - `OrgTaintRemoved object` + - `OrgSyncDeletingSynchronizedFilesStarted object` - A taint was removed from an organization. + Organization started deleting synchronized files. - `actor: object or object or object or 8 more` @@ -72676,15 +72796,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `taint: optional string or null` - - - `type: optional "org_taint_removed"` + - `type: optional "org_sync_deleting_synchronized_files_started"` - default: org_taint_removed + default: org_sync_deleting_synchronized_files_started - - `OrgUserDeleted object` + - `OrgSyncSynchronizedFilesDeleted object` - User was removed from organization. + Organization synchronized files were deleted. - `actor: object or object or object or 8 more` @@ -72907,10 +73025,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `deleted_user_email: optional string or null` - - - `deleted_user_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -72919,13 +73033,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_deleted"` + - `type: optional "org_sync_synchronized_files_deleted"` - default: org_user_deleted + default: org_sync_synchronized_files_deleted - - `OrgUserInviteAccepted object` + - `OrgTaintAdded object` - Organization user invite was accepted. + A taint was added to an organization. - `actor: object or object or object or 8 more` @@ -73148,8 +73262,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invite_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -73158,17 +73270,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `rbac_group_ids: optional array of string or null` + - `taint: optional string or null` - RBAC group IDs the user was added to on acceptance, as confirmed by the group service (absent on rows written before this was recorded, and when the invite carried no groups) + - `type: optional "org_taint_added"` - - `type: optional "org_user_invite_accepted"` + default: org_taint_added - default: org_user_invite_accepted + - `workspace_id: optional string or null` - - `OrgUserInviteDeleted object` + Tagged ID of the workspace the taint was applied to. Unset when applied at organization scope. - Organization user invite was deleted. + - `OrgTaintRemoved object` + + A taint was removed from an organization. - `actor: object or object or object or 8 more` @@ -73391,8 +73505,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invite_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -73401,13 +73513,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_deleted"` + - `taint: optional string or null` - default: org_user_invite_deleted + - `type: optional "org_taint_removed"` - - `OrgUserInviteReSent object` + default: org_taint_removed - Organization user invite was re-sent. + - `OrgUserDeleted object` + + User was removed from organization. - `actor: object or object or object or 8 more` @@ -73630,15 +73744,9 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invited_email: optional string or null` - - - `invited_role: optional string or null` - - Role the invited user will receive on joining - - - `invited_seat_tier: optional string or null` + - `deleted_user_email: optional string or null` - Seat tier the invited user will receive on joining + - `deleted_user_id: optional string or null` - `organization_id: optional string or null` @@ -73648,13 +73756,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_re_sent"` + - `type: optional "org_user_deleted"` - default: org_user_invite_re_sent + default: org_user_deleted - - `OrgUserInviteRejected object` + - `OrgUserInviteAccepted object` - Organization user invite was rejected. + Organization user invite was accepted. - `actor: object or object or object or 8 more` @@ -73887,13 +73995,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_rejected"` + - `rbac_group_ids: optional array of string or null` - default: org_user_invite_rejected + RBAC group IDs the user was added to on acceptance, as confirmed by the group service (absent on rows written before this was recorded, and when the invite carried no groups) - - `OrgUserInviteSent object` + - `type: optional "org_user_invite_accepted"` - Organization user invite was sent. + default: org_user_invite_accepted + + - `OrgUserInviteDeleted object` + + Organization user invite was deleted. - `actor: object or object or object or 8 more` @@ -74116,17 +74228,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invited_email: optional string or null` - - - `invited_rbac_group_ids: optional array of string or null` - - RBAC group IDs the invited user will be added to on joining - - - `invited_role: optional string or null` - - - `invited_seat_tier: optional string or null` - - Seat tier the invited user will receive on joining + - `invite_id: optional string or null` - `organization_id: optional string or null` @@ -74136,13 +74238,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_sent"` + - `type: optional "org_user_invite_deleted"` - default: org_user_invite_sent + default: org_user_invite_deleted - - `OrgUserLeft object` + - `OrgUserInviteReSent object` - User removed themselves from organization. + Organization user invite was re-sent. - `actor: object or object or object or 8 more` @@ -74365,6 +74467,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invited_email: optional string or null` + + - `invited_role: optional string or null` + + Role the invited user will receive on joining + + - `invited_seat_tier: optional string or null` + + Seat tier the invited user will receive on joining + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74373,15 +74485,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_role: optional string or null` - - - `type: optional "org_user_left"` + - `type: optional "org_user_invite_re_sent"` - default: org_user_left + default: org_user_invite_re_sent - - `OrgUserTrustedDevicesRevoked object` + - `OrgUserInviteRejected object` - An organization admin revoked a member's trusted devices and signed the member out of all active sessions. + Organization user invite was rejected. - `actor: object or object or object or 8 more` @@ -74594,22 +74704,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `completed: boolean` - - Whether the operation completed fully. False records an attempt that revoked the counted credentials but failed before finishing. - - - `devices_revoked_count: number` - - Number of trusted devices revoked - - - `sessions_revoked_count: number` - - Number of active sessions the member was signed out of - - - `user_id: string` - - Tagged ID of the member whose trusted devices were revoked - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -74620,6 +74714,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invite_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74628,13 +74724,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_trusted_devices_revoked"` + - `type: optional "org_user_invite_rejected"` - default: org_user_trusted_devices_revoked + default: org_user_invite_rejected - - `OrgUserViewed object` + - `OrgUserInviteSent object` - An organization user was viewed. + Organization user invite was sent. - `actor: object or object or object or 8 more` @@ -74847,10 +74943,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` - - Tagged ID of the viewed user - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -74861,6 +74953,18 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invited_email: optional string or null` + + - `invited_rbac_group_ids: optional array of string or null` + + RBAC group IDs the invited user will be added to on joining + + - `invited_role: optional string or null` + + - `invited_seat_tier: optional string or null` + + Seat tier the invited user will receive on joining + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74869,13 +74973,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_viewed"` + - `type: optional "org_user_invite_sent"` - default: org_user_viewed + default: org_user_invite_sent - - `OrgUsersListed object` + - `OrgUserLeft object` - Organization users were listed. + User removed themselves from organization. - `actor: object or object or object or 8 more` @@ -75106,13 +75210,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_users_listed"` + - `previous_role: optional string or null` - default: org_users_listed + - `type: optional "org_user_left"` - - `OrgWorkAcrossAppsDisabled object` + default: org_user_left - Organization Work Across Apps was disabled. + - `OrgUserTrustedDevicesRevoked object` + + An organization admin revoked a member's trusted devices and signed the member out of all active sessions. - `actor: object or object or object or 8 more` @@ -75325,6 +75431,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `completed: boolean` + + Whether the operation completed fully. False records an attempt that revoked the counted credentials but failed before finishing. + + - `devices_revoked_count: number` + + Number of trusted devices revoked + + - `sessions_revoked_count: number` + + Number of active sessions the member was signed out of + + - `user_id: string` + + Tagged ID of the member whose trusted devices were revoked + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -75335,10 +75457,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -75347,17 +75465,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_work_across_apps_disabled"` + - `type: optional "org_user_trusted_devices_revoked"` - default: org_work_across_apps_disabled + default: org_user_trusted_devices_revoked - - `OrgWorkAcrossAppsEnabled object` + - `OrgUserViewed object` - Organization Work Across Apps was enabled. + An organization user was viewed. - `actor: object or object or object or 8 more` @@ -75570,6 +75684,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + + Tagged ID of the viewed user + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -75580,10 +75698,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -75592,17 +75706,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_work_across_apps_enabled"` + - `type: optional "org_user_viewed"` - default: org_work_across_apps_enabled + default: org_user_viewed - - `OrganizationAddressUpdated object` + - `OrgUsersListed object` - The organization's billing or shipping address was updated. + Organization users were listed. - `actor: object or object or object or 8 more` @@ -75819,14 +75929,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `billing_address_updated: optional boolean` - - default: false - - - `billing_name_updated: optional boolean` - - default: false - - `created_at: optional string` When this activity occurred. @@ -75841,21 +75943,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `shipping_address_updated: optional boolean` - - default: false - - - `shipping_name_updated: optional boolean` - - default: false + - `type: optional "org_users_listed"` - - `type: optional "organization_address_updated"` + default: org_users_listed - default: organization_address_updated + - `OrgWorkAcrossAppsDisabled object` - - `OrganizationIconDeleted object` - - Organization's custom icon deleted. + The organization's "Let Claude work across apps" setting was turned off. - `actor: object or object or object or 8 more` @@ -76078,6 +76172,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -76086,13 +76184,752 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "organization_icon_deleted"` + - `previous_value: optional boolean or null` - default: organization_icon_deleted + Setting value immediately before this change - - `OrganizationIconUpdated object` + - `type: optional "org_work_across_apps_disabled"` - Organization's custom icon uploaded or replaced. + default: org_work_across_apps_disabled + + - `OrgWorkAcrossAppsEnabled object` + + The organization's "Let Claude work across apps" setting was turned on. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "org_work_across_apps_enabled"` + + default: org_work_across_apps_enabled + + - `OrganizationAddressUpdated object` + + The organization's billing or shipping address was updated. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `billing_address_updated: optional boolean` + + default: false + + - `billing_name_updated: optional boolean` + + default: false + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `shipping_address_updated: optional boolean` + + default: false + + - `shipping_name_updated: optional boolean` + + default: false + + - `type: optional "organization_address_updated"` + + default: organization_address_updated + + - `OrganizationIconDeleted object` + + Organization's custom icon deleted. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "organization_icon_deleted"` + + default: organization_icon_deleted + + - `OrganizationIconUpdated object` + + Organization's custom icon uploaded or replaced. - `actor: object or object or object or 8 more` @@ -76544,15 +77381,15 @@ compliance activities that can be filtered by various criteria. - `updates: array of object or object or object or 84 more` - - `OrganizationName object` + - `Name object` The organization name setting was changed. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change @@ -76560,15 +77397,15 @@ compliance activities that can be filtered by various criteria. default: name - - `OrganizationCapabilities object` + - `Capabilities object` The organization capabilities setting was changed. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -76576,15 +77413,15 @@ compliance activities that can be filtered by various criteria. default: capabilities - - `OrganizationRedactContent object` + - `RedactContent object` The organization content-redaction setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76596,11 +77433,11 @@ compliance activities that can be filtered by various criteria. The public projects setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76612,11 +77449,11 @@ compliance activities that can be filtered by various criteria. The web search setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76628,11 +77465,11 @@ compliance activities that can be filtered by various criteria. The geolocation setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76640,15 +77477,15 @@ compliance activities that can be filtered by various criteria. default: geolocation_enabled - - `OrgMemoryEnabledSetting object` + - `EnabledSaffron object` The memory setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76660,7 +77497,7 @@ compliance activities that can be filtered by various criteria. The data retention periods setting was changed for the organization. - - `current_value: array of object or null` + - `current_value: optional array of object or null` Setting value immediately after this change @@ -76688,7 +77525,7 @@ compliance activities that can be filtered by various criteria. - `"month"` - - `previous_value: array of object or null` + - `previous_value: optional array of object or null` Setting value immediately before this change @@ -76724,11 +77561,11 @@ compliance activities that can be filtered by various criteria. The members limit setting was changed for the organization. - - `current_value: number or null` + - `current_value: optional number or null` Setting value immediately after this change - - `previous_value: number or null` + - `previous_value: optional number or null` Setting value immediately before this change @@ -76740,11 +77577,11 @@ compliance activities that can be filtered by various criteria. The Claude API in Artifacts setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76756,7 +77593,7 @@ compliance activities that can be filtered by various criteria. The support contact routing mode setting was changed for the organization. - - `current_value: "ai_support_only" or "human_support_restricted" or null` + - `current_value: optional "ai_support_only" or "human_support_restricted" or "unspecified" or null` Setting value immediately after this change @@ -76764,7 +77601,9 @@ compliance activities that can be filtered by various criteria. - `"human_support_restricted"` - - `previous_value: "ai_support_only" or "human_support_restricted" or null` + - `"unspecified"` + + - `previous_value: optional "ai_support_only" or "human_support_restricted" or "unspecified" or null` Setting value immediately before this change @@ -76772,6 +77611,8 @@ compliance activities that can be filtered by various criteria. - `"human_support_restricted"` + - `"unspecified"` + - `type: optional "support_contact_mode"` default: support_contact_mode @@ -76780,11 +77621,11 @@ compliance activities that can be filtered by various criteria. The support contact always-include-admins-owners setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76796,11 +77637,11 @@ compliance activities that can be filtered by various criteria. The support contact designated groups setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -76812,11 +77653,11 @@ compliance activities that can be filtered by various criteria. The organization's subscription seat quotas were changed. - - `current_value: map[number] or null` + - `current_value: optional map[number] or null` Seat-type to quantity mapping immediately after this change. A null quantity means the item is unlimited/unmetered. - - `previous_value: map[number] or null` + - `previous_value: optional map[number] or null` Seat-type to quantity mapping immediately before this change. A null quantity means the item was unlimited/unmetered. @@ -76828,7 +77669,7 @@ compliance activities that can be filtered by various criteria. All organization members were assigned the specified seat tier. - - `current_value: string or null` + - `current_value: optional string or null` The seat tier every member was assigned to @@ -76848,11 +77689,11 @@ compliance activities that can be filtered by various criteria. The Claude Code on the web setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76864,11 +77705,11 @@ compliance activities that can be filtered by various criteria. The Claude Code Desktop bypass-permissions mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76880,11 +77721,11 @@ compliance activities that can be filtered by various criteria. The Claude Code Desktop auto-permissions mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76896,11 +77737,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai skills setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76912,11 +77753,11 @@ compliance activities that can be filtered by various criteria. The Workbench completion feedback setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76928,11 +77769,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai completion feedback setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76944,11 +77785,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai integration sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76960,11 +77801,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai chat sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76972,15 +77813,15 @@ compliance activities that can be filtered by various criteria. default: claude_ai_chat_sharing_enabled - - `ClaudeAiccrSharingEnabled object` + - `ClaudeAICcrSharingEnabled object` The Claude.ai remote Claude Code session sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76988,15 +77829,15 @@ compliance activities that can be filtered by various criteria. default: claude_ai_ccr_sharing_enabled - - `ClaudeAiccrSupportSharingEnabled object` + - `ClaudeAICcrSupportSharingEnabled object` The Anthropic support access setting for Claude Code sessions was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77008,7 +77849,7 @@ compliance activities that can be filtered by various criteria. The batches download UI visibility setting was changed for the organization. - - `current_value: "all" or "none" or "selected" or null` + - `current_value: optional "all" or "none" or "selected" or "unspecified" or null` Setting value immediately after this change @@ -77018,7 +77859,9 @@ compliance activities that can be filtered by various criteria. - `"selected"` - - `previous_value: "all" or "none" or "selected" or null` + - `"unspecified"` + + - `previous_value: optional "all" or "none" or "selected" or "unspecified" or null` Setting value immediately before this change @@ -77028,6 +77871,8 @@ compliance activities that can be filtered by various criteria. - `"selected"` + - `"unspecified"` + - `type: optional "batches_download_ui_visibility"` default: batches_download_ui_visibility @@ -77036,11 +77881,11 @@ compliance activities that can be filtered by various criteria. The allowed invite domains setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -77048,11 +77893,11 @@ compliance activities that can be filtered by various criteria. default: allowed_invite_domains - - `WebSearchAPISettingsChanged object` + - `WebSearchAPISettings object` The web search API setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -77066,7 +77911,7 @@ compliance activities that can be filtered by various criteria. - `is_enabled: boolean` - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -77084,11 +77929,11 @@ compliance activities that can be filtered by various criteria. default: web_search_api_settings - - `WebFetchAPISettingsChanged object` + - `WebFetchAPISettings object` The web fetch API setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -77102,7 +77947,7 @@ compliance activities that can be filtered by various criteria. - `is_enabled: boolean` - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -77124,7 +77969,7 @@ compliance activities that can be filtered by various criteria. The default workspace setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -77132,7 +77977,7 @@ compliance activities that can be filtered by various criteria. default: true - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -77148,11 +77993,11 @@ compliance activities that can be filtered by various criteria. The batches download UI enabled workspace IDs setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -77185,11 +78030,11 @@ compliance activities that can be filtered by various criteria. Tracks changes to the enterprise account session duration setting (in seconds). - - `current_value: number or null` + - `current_value: optional number or null` Setting value immediately after this change - - `previous_value: number or null` + - `previous_value: optional number or null` Setting value immediately before this change @@ -77201,7 +78046,7 @@ compliance activities that can be filtered by various criteria. Tracks changes to VCS (GitHub, etc.) organization connections. - - `current_value: array of object or null` + - `current_value: optional array of object or null` Setting value immediately after this change @@ -77215,7 +78060,7 @@ compliance activities that can be filtered by various criteria. - `org_id: optional string or null` - - `previous_value: array of object or null` + - `previous_value: optional array of object or null` Setting value immediately before this change @@ -77237,11 +78082,11 @@ compliance activities that can be filtered by various criteria. Tracks changes to which admin request types are disabled. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -77253,11 +78098,11 @@ compliance activities that can be filtered by various criteria. The member usage dashboard visibility setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77269,11 +78114,11 @@ compliance activities that can be filtered by various criteria. The code execution network egress setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77285,11 +78130,11 @@ compliance activities that can be filtered by various criteria. The code execution domain allowlist setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -77301,7 +78146,7 @@ compliance activities that can be filtered by various criteria. The code execution domain allowlist template setting was changed for the organization. - - `current_value: "custom" or "full_egress" or "package_managers" or null` + - `current_value: optional "custom" or "full_egress" or "package_managers" or "unspecified" or null` Setting value immediately after this change @@ -77311,7 +78156,9 @@ compliance activities that can be filtered by various criteria. - `"package_managers"` - - `previous_value: "custom" or "full_egress" or "package_managers" or null` + - `"unspecified"` + + - `previous_value: optional "custom" or "full_egress" or "package_managers" or "unspecified" or null` Setting value immediately before this change @@ -77321,6 +78168,8 @@ compliance activities that can be filtered by various criteria. - `"package_managers"` + - `"unspecified"` + - `type: optional "code_execution_domain_allowlist_template_changed"` default: code_execution_domain_allowlist_template_changed @@ -77329,11 +78178,11 @@ compliance activities that can be filtered by various criteria. The chat setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77345,11 +78194,11 @@ compliance activities that can be filtered by various criteria. The Claude Code quick web setup setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77361,7 +78210,7 @@ compliance activities that can be filtered by various criteria. The Claude Code team memory mode setting was changed for the organization. - - `current_value: "all_org_members" or "github_repo" or "off" or "specific_groups" or null` + - `current_value: optional "all_org_members" or "github_repo" or "off" or 2 more or null` Setting value immediately after this change @@ -77373,7 +78222,9 @@ compliance activities that can be filtered by various criteria. - `"specific_groups"` - - `previous_value: "all_org_members" or "github_repo" or "off" or "specific_groups" or null` + - `"unspecified"` + + - `previous_value: optional "all_org_members" or "github_repo" or "off" or 2 more or null` Setting value immediately before this change @@ -77385,19 +78236,21 @@ compliance activities that can be filtered by various criteria. - `"specific_groups"` + - `"unspecified"` + - `type: optional "claude_code_team_memory_mode"` default: claude_code_team_memory_mode - - `BrowserExtensionSettingsUpdated object` + - `BrowserExtensionSettings object` The browser extension setting was changed for the organization. - - `current_value: map[unknown] or null` + - `current_value: optional map[unknown] or null` Setting value immediately after this change - - `previous_value: map[unknown] or null` + - `previous_value: optional map[unknown] or null` Setting value immediately before this change @@ -77405,15 +78258,15 @@ compliance activities that can be filtered by various criteria. default: browser_extension_settings - - `DesktopExtensionAllowlistEnabled object` + - `IsDesktopExtensionAllowlistEnabled object` The desktop extension allowlist setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77425,11 +78278,11 @@ compliance activities that can be filtered by various criteria. The per-member self-serve data export setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77437,15 +78290,15 @@ compliance activities that can be filtered by various criteria. default: allow_member_data_export - - `ClaudeDesignEnabled object` + - `ClaudeAIDesignEnabled object` The Claude Design setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77457,11 +78310,11 @@ compliance activities that can be filtered by various criteria. The setting that turns Claude Science on or off for the organization was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77473,11 +78326,11 @@ compliance activities that can be filtered by various criteria. The Claude Science memory setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77489,11 +78342,11 @@ compliance activities that can be filtered by various criteria. The Claude Science custom connectors setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77505,11 +78358,11 @@ compliance activities that can be filtered by various criteria. The Claude Science custom skills setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77521,11 +78374,11 @@ compliance activities that can be filtered by various criteria. The Claude Science setting that puts the network allowlist under the organization's management, instead of each member managing their own, was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77537,11 +78390,11 @@ compliance activities that can be filtered by various criteria. The Claude Science SSH hosts setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77553,11 +78406,11 @@ compliance activities that can be filtered by various criteria. The Claude Science setting that lets members connect Modal cloud compute was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77569,11 +78422,11 @@ compliance activities that can be filtered by various criteria. The Claude Science scientific model endpoints setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77585,11 +78438,11 @@ compliance activities that can be filtered by various criteria. The hostnames on the organization's Claude Science network allowlist, which applies to members while the organization manages the allowlist, were changed. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list is saved (this change reset it), so Claude Science's built-in allowlist applies; an empty list means a list with no domains on it is saved. - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list was saved at that point (never saved, or since reset), so Claude Science's built-in allowlist applied; an empty list means a list with no domains on it had been saved. @@ -77601,11 +78454,11 @@ compliance activities that can be filtered by various criteria. The Claude Science Modal cloud compute workspace allowlist setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change: the Modal workspace names members can connect to. Null or an empty list means any workspace is allowed. - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change: the Modal workspace names members could connect to. Null or an empty list means any workspace was allowed. @@ -77617,11 +78470,11 @@ compliance activities that can be filtered by various criteria. The Claude Science package mirror setting for the conda channel was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. @@ -77633,11 +78486,11 @@ compliance activities that can be filtered by various criteria. The Claude Science package mirror setting for the Python package index was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. @@ -77645,481 +78498,961 @@ compliance activities that can be filtered by various criteria. default: claude_science_package_mirror_pip_index_changed - - `SkillPluginsScanningEnabled object` + - `ClaudeAISkillPluginsScanningEnabled object` + + The skill and plugin security scanning setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_plugins_scanning_enabled"` + + default: claude_ai_skill_plugins_scanning_enabled + + - `ArtifactPublishingEnabled object` + + The Artifact publishing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "artifact_publishing_enabled"` + + default: artifact_publishing_enabled + + - `ArtifactExternalSharingEnabled object` + + The Artifact external sharing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "artifact_external_sharing_enabled"` + + default: artifact_external_sharing_enabled + + - `ArtifactPresenceEnabled object` + + The Artifact presence setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "artifact_presence_enabled"` + + default: artifact_presence_enabled + + - `ClaudeAISkillSharingEnabled object` + + The Claude.ai skill sharing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_sharing_enabled"` + + default: claude_ai_skill_sharing_enabled + + - `ClaudeAISkillSharingOrgEnabled object` + + The Claude.ai organization-wide skill sharing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_sharing_org_enabled"` + + default: claude_ai_skill_sharing_org_enabled + + - `ClaudeAISkillSharingGroupEnabled object` + + The Claude.ai group-based skill sharing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_sharing_group_enabled"` + + default: claude_ai_skill_sharing_group_enabled + + - `ClaudeAISkillPublishPolicy object` + + The Claude.ai organization skill publish policy was changed for the organization. + + - `current_value: optional "off" or "open" or "review" or "unspecified" or null` + + Setting value immediately after this change + + - `"off"` + + - `"open"` + + - `"review"` + + - `"unspecified"` + + - `previous_value: optional "off" or "open" or "review" or "unspecified" or null` + + Setting value immediately before this change + + - `"off"` + + - `"open"` + + - `"review"` + + - `"unspecified"` + + - `type: optional "claude_ai_skill_publish_policy"` + + default: claude_ai_skill_publish_policy + + - `ClaudeCodeRemoteControlEnabled object` + + The Claude Code remote control setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_remote_control_enabled"` + + default: claude_code_remote_control_enabled + + - `ClaudeCodeRemoteControlDefaultEnabled object` + + The Claude Code remote control auto-enable default was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_remote_control_default_enabled"` + + default: claude_code_remote_control_default_enabled + + - `ClaudeCodeRoutinesEnabled object` + + The Claude Code routines setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_routines_enabled"` + + default: claude_code_routines_enabled + + - `ClaudeCodeWorkflowsEnabled object` + + The Claude Code Workflows setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_workflows_enabled"` + + default: claude_code_workflows_enabled + + - `FrontierServicesDataUseEnabled object` + + The frontier services data use setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "frontier_services_data_use_enabled"` + + default: frontier_services_data_use_enabled + + - `LtiCourseProjectsEnabled object` + + The LTI course projects setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "lti_course_projects_enabled"` + + default: lti_course_projects_enabled + + - `ClaudeAISkillCreationEnabled object` + + The Claude.ai skill creation setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_creation_enabled"` + + default: claude_ai_skill_creation_enabled + + - `ClaudeCodeGitHubAnalyticsEnabled object` + + The Claude Code GitHub analytics setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_github_analytics_enabled"` + + default: claude_code_github_analytics_enabled + + - `ClaudeCodeHideManagedEnvironments object` + + The Claude Code hide managed environments setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_hide_managed_environments"` + + default: claude_code_hide_managed_environments + + - `ClaudeCodeAllowSessionPoolMoves object` + + The Claude Code allow session pool moves setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_allow_session_pool_moves"` + + default: claude_code_allow_session_pool_moves + + - `ClaudeCodeDisableAnthropicCompute object` + + The Claude Code disable Anthropic compute setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_disable_anthropic_compute"` + + default: claude_code_disable_anthropic_compute + + - `ClaudeCodeMetricsLoggingEnabled object` + + The Claude Code metrics logging setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_metrics_logging_enabled"` + + default: claude_code_metrics_logging_enabled + + - `ClaudeCodeFastModeEnabled object` + + The Claude Code fast mode setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_fast_mode_enabled"` + + default: claude_code_fast_mode_enabled + + - `ClaudeCodeTrustedDevicesRequired object` + + The Claude Code trusted devices setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_trusted_devices_required"` + + default: claude_code_trusted_devices_required + + - `CoworkTrustedDevicesRequired object` + + The Cowork trusted devices enforcement setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "cowork_trusted_devices_required"` + + default: cowork_trusted_devices_required + + - `InlineVisualizationsEnabled object` + + The inline visualizations setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "inline_visualizations_enabled"` + + default: inline_visualizations_enabled + + - `OrganizationBannerSettings object` + + The organization banner setting was changed. + + - `current_value: optional map[unknown] or null` + + Setting value immediately after this change + + - `previous_value: optional map[unknown] or null` + + Setting value immediately before this change + + - `type: optional "organization_banner_settings"` + + default: organization_banner_settings + + - `ClaudeInSlackSettings object` + + The Claude in Slack setting was changed for the organization. + + - `current_value: optional map[unknown] or null` + + Setting value immediately after this change + + - `previous_value: optional map[unknown] or null` + + Setting value immediately before this change + + - `type: optional "claude_in_slack_settings"` + + default: claude_in_slack_settings + + - `ClaudeCodeDefaultWorkerEnvironmentID object` + + The Claude Code default worker environment setting was changed for the organization. + + - `current_value: optional string or null` + + Setting value immediately after this change + + - `previous_value: optional string or null` + + Setting value immediately before this change + + - `type: optional "claude_code_default_worker_environment_id"` + + default: claude_code_default_worker_environment_id + + - `ClaudeCodeDefaultWorkerPoolID object` + + The Claude Code default worker pool setting was changed for the organization. + + - `current_value: optional string or null` + + Setting value immediately after this change + + - `previous_value: optional string or null` + + Setting value immediately before this change + + - `type: optional "claude_code_default_worker_pool_id"` + + default: claude_code_default_worker_pool_id + + - `ManagedAgentsEnabled object` - The skill and plugin security scanning setting was changed for the organization. + The managed agents setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "claude_ai_skill_plugins_scanning_enabled"` + - `type: optional "managed_agents_enabled"` - default: claude_ai_skill_plugins_scanning_enabled + default: managed_agents_enabled - - `ArtifactPublishingEnabled object` + - `id: optional string` - The Artifact publishing setting was changed for the organization. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `current_value: boolean or null` + - `created_at: optional string` - Setting value immediately after this change + When this activity occurred. - - `previous_value: boolean or null` + format: date-time - Setting value immediately before this change + - `organization_id: optional string or null` - - `type: optional "artifact_publishing_enabled"` + Organization ID this activity is associated with - default: artifact_publishing_enabled + - `organization_uuid: optional string or null` - - `ArtifactExternalSharingEnabled object` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - The Artifact external sharing setting was changed for the organization. + - `type: optional "claude_organization_settings_updated"` - - `current_value: boolean or null` + default: claude_organization_settings_updated - Setting value immediately after this change + - `OwnedProjectsAccessRestored object` - - `previous_value: boolean or null` + Access to owned projects was restored. - Setting value immediately before this change + - `actor: object or object or object or 8 more` - - `type: optional "artifact_external_sharing_enabled"` + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - default: artifact_external_sharing_enabled + - `APIActor object` - - `ArtifactPresenceEnabled object` + - `api_key_id: string` - The Artifact presence setting was changed for the organization. + - `ip_address: string` - - `current_value: boolean or null` + - `user_agent: string` - Setting value immediately after this change + - `type: optional "api_actor"` - - `previous_value: boolean or null` + default: api_actor - Setting value immediately before this change + - `UserActor object` - - `type: optional "artifact_presence_enabled"` + - `email_address: string` - default: artifact_presence_enabled + format: email - - `ClaudeAISkillSharingEnabled object` + - `ip_address: string` - The Claude.ai skill sharing setting was changed for the organization. + - `user_agent: string` - - `current_value: boolean or null` + - `user_id: string` - Setting value immediately after this change + - `type: optional "user_actor"` - - `previous_value: boolean or null` + default: user_actor - Setting value immediately before this change + - `UnauthenticatedUserActor object` - - `type: optional "claude_ai_skill_sharing_enabled"` + - `ip_address: string` - default: claude_ai_skill_sharing_enabled + - `user_agent: string` - - `ClaudeAISkillSharingOrgEnabled object` + - `type: optional "unauthenticated_user_actor"` - The Claude.ai organization-wide skill sharing setting was changed for the organization. + default: unauthenticated_user_actor - - `current_value: boolean or null` + - `unauthenticated_email_address: optional string or null` - Setting value immediately after this change + format: email - - `previous_value: boolean or null` + - `AnthropicActor object` - Setting value immediately before this change + - `email_address: optional string or null` - - `type: optional "claude_ai_skill_sharing_org_enabled"` + format: email - default: claude_ai_skill_sharing_org_enabled + - `type: optional "anthropic_actor"` - - `ClaudeAISkillSharingGroupEnabled object` + default: anthropic_actor - The Claude.ai group-based skill sharing setting was changed for the organization. + - `SystemActor object` - - `current_value: boolean or null` + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - Setting value immediately after this change + - `service: optional string or null` - - `previous_value: boolean or null` + Name of the automated process that performed the action, when known. - Setting value immediately before this change + - `type: optional "system_actor"` - - `type: optional "claude_ai_skill_sharing_group_enabled"` + default: system_actor - default: claude_ai_skill_sharing_group_enabled + - `AdminAPIKeyActor object` - - `ClaudeAISkillPublishPolicy object` + - `admin_api_key_id: string` - The Claude.ai organization skill publish policy was changed for the organization. + - `ip_address: string` - - `current_value: "off" or "open" or "review" or null` + - `user_agent: string` - Setting value immediately after this change + - `type: optional "admin_api_key_actor"` - - `"off"` + default: admin_api_key_actor - - `"open"` + - `ServiceAccountActor object` - - `"review"` + - `ip_address: string` - - `previous_value: "off" or "open" or "review" or null` + - `service_account_id: string` - Setting value immediately before this change + - `user_agent: string` - - `"off"` + - `type: optional "service_account_actor"` - - `"open"` + default: service_account_actor - - `"review"` + - `ScimDirectorySyncActor object` - - `type: optional "claude_ai_skill_publish_policy"` + - `directory_id: string` - default: claude_ai_skill_publish_policy + - `workos_event_id: string` - - `ClaudeCodeRemoteControlEnabled object` + - `idp_connection_type: optional string or null` - The Claude Code remote control setting was changed for the organization. + - `type: optional "scim_directory_sync_actor"` - - `current_value: boolean or null` + default: scim_directory_sync_actor - Setting value immediately after this change + - `FederatedIdentityActor object` - - `previous_value: boolean or null` + A federated external workload authenticated via a verified OIDC token. - Setting value immediately before this change + Carries the verified issuer, subject, and audience claims from the + presented JWT. - - `type: optional "claude_code_remote_control_enabled"` + - `issuer: string` - default: claude_code_remote_control_enabled + - `subject: string` - - `ClaudeCodeRemoteControlDefaultEnabled object` + - `audience: optional array of string` - The Claude Code remote control auto-enable default was changed for the organization. + - `ip_address: optional string or null` - - `current_value: boolean or null` + - `type: optional "federated_identity_actor"` - Setting value immediately after this change + default: federated_identity_actor - - `previous_value: boolean or null` + - `user_agent: optional string or null` - Setting value immediately before this change + - `FederatedActor object` - - `type: optional "claude_code_remote_control_default_enabled"` + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. - default: claude_code_remote_control_default_enabled + - `provider: object or object or object or object` - - `ClaudeCodeRoutinesEnabled object` + Asserting party: the AWS account the organization is bound to. - The Claude Code routines setting was changed for the organization. + - `FederatedActorAwsProvider object` - - `current_value: boolean or null` + Asserting party: the AWS account the organization is bound to. - Setting value immediately after this change + - `account_id: string` - - `previous_value: boolean or null` + - `signed_principal: string` - Setting value immediately before this change + The AWS-signed ARN of the IAM principal that requested the token. - - `type: optional "claude_code_routines_enabled"` + - `type: optional "aws"` - default: claude_code_routines_enabled + default: aws - - `ClaudeCodeWorkflowsEnabled object` + - `FederatedActorAzureProvider object` - The Claude Code Workflows setting was changed for the organization. + Asserting party: the Azure subscription the organization is bound to. - - `current_value: boolean or null` + - `subscription_id: string` - Setting value immediately after this change + - `type: optional "azure"` - - `previous_value: boolean or null` + default: azure - Setting value immediately before this change + - `FederatedActorGcpProvider object` - - `type: optional "claude_code_workflows_enabled"` + Asserting party: the GCP project the organization is bound to. - default: claude_code_workflows_enabled + - `project_number: string` - - `FrontierServicesDataUseEnabled object` + - `type: optional "gcp"` - The frontier services data use setting was changed for the organization. + default: gcp - - `current_value: boolean or null` + - `FederatedActorOidcProvider object` - Setting value immediately after this change + Asserting party: a customer-registered OIDC federation issuer. - - `previous_value: boolean or null` + - `issuer: optional string or null` - Setting value immediately before this change + The federation issuer's URL. Null when the presented credential failed verification. - - `type: optional "frontier_services_data_use_enabled"` + - `type: optional "oidc"` - default: frontier_services_data_use_enabled + default: oidc - - `LtiCourseProjectsEnabled object` + - `ip_address: optional string or null` - The LTI course projects setting was changed for the organization. + - `subject: optional string or null` - - `current_value: boolean or null` + The provider's verified identifier for the caller; its form depends on the provider. - Setting value immediately after this change + - `type: optional "federated_actor"` - - `previous_value: boolean or null` + default: federated_actor - Setting value immediately before this change + - `user_agent: optional string or null` - - `type: optional "lti_course_projects_enabled"` + - `AttestedDeviceActor object` - default: lti_course_projects_enabled + An attested mobile device authenticated via Apple App Attest. - - `ClaudeAISkillCreationEnabled object` + - `external_client_id: string` - The Claude.ai skill creation setting was changed for the organization. + - `kid_hash: string` - - `current_value: boolean or null` + - `ip_address: optional string or null` - Setting value immediately after this change + - `type: optional "attested_device_actor"` - - `previous_value: boolean or null` + default: attested_device_actor - Setting value immediately before this change + - `user_agent: optional string or null` - - `type: optional "claude_ai_skill_creation_enabled"` + - `id: optional string` - default: claude_ai_skill_creation_enabled + Unique identifier for the activity e.g. 'activity_abcd1234' - - `ClaudeCodeGitHubAnalyticsEnabled object` + - `created_at: optional string` - The Claude Code GitHub analytics setting was changed for the organization. + When this activity occurred. - - `current_value: boolean or null` + format: date-time - Setting value immediately after this change + - `organization_id: optional string or null` - - `previous_value: boolean or null` + Organization ID this activity is associated with - Setting value immediately before this change + - `organization_uuid: optional string or null` - - `type: optional "claude_code_github_analytics_enabled"` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - default: claude_code_github_analytics_enabled + - `type: optional "owned_projects_access_restored"` - - `ClaudeCodeHideManagedEnvironments object` + default: owned_projects_access_restored - The Claude Code hide managed environments setting was changed for the organization. + - `user_id: optional string or null` - - `current_value: boolean or null` + - `PaymentMethodUpdated object` - Setting value immediately after this change + The organization's default payment method was updated. - - `previous_value: boolean or null` + - `actor: object or object or object or 8 more` - Setting value immediately before this change + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `type: optional "claude_code_hide_managed_environments"` + - `APIActor object` - default: claude_code_hide_managed_environments + - `api_key_id: string` - - `ClaudeCodeAllowSessionPoolMoves object` + - `ip_address: string` - The Claude Code allow session pool moves setting was changed for the organization. + - `user_agent: string` - - `current_value: boolean or null` + - `type: optional "api_actor"` - Setting value immediately after this change + default: api_actor - - `previous_value: boolean or null` + - `UserActor object` - Setting value immediately before this change + - `email_address: string` - - `type: optional "claude_code_allow_session_pool_moves"` + format: email - default: claude_code_allow_session_pool_moves + - `ip_address: string` - - `ClaudeCodeDisableAnthropicCompute object` + - `user_agent: string` - The Claude Code disable Anthropic compute setting was changed for the organization. + - `user_id: string` - - `current_value: boolean or null` + - `type: optional "user_actor"` - Setting value immediately after this change + default: user_actor - - `previous_value: boolean or null` + - `UnauthenticatedUserActor object` - Setting value immediately before this change + - `ip_address: string` - - `type: optional "claude_code_disable_anthropic_compute"` + - `user_agent: string` - default: claude_code_disable_anthropic_compute + - `type: optional "unauthenticated_user_actor"` - - `ClaudeCodeMetricsLoggingEnabled object` + default: unauthenticated_user_actor - The Claude Code metrics logging setting was changed for the organization. + - `unauthenticated_email_address: optional string or null` - - `current_value: boolean or null` + format: email - Setting value immediately after this change + - `AnthropicActor object` - - `previous_value: boolean or null` + - `email_address: optional string or null` - Setting value immediately before this change + format: email - - `type: optional "claude_code_metrics_logging_enabled"` + - `type: optional "anthropic_actor"` - default: claude_code_metrics_logging_enabled + default: anthropic_actor - - `ClaudeCodeFastModeEnabled object` + - `SystemActor object` - The Claude Code fast mode setting was changed for the organization. + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `current_value: boolean or null` + - `service: optional string or null` - Setting value immediately after this change + Name of the automated process that performed the action, when known. - - `previous_value: boolean or null` + - `type: optional "system_actor"` - Setting value immediately before this change + default: system_actor - - `type: optional "claude_code_fast_mode_enabled"` + - `AdminAPIKeyActor object` - default: claude_code_fast_mode_enabled + - `admin_api_key_id: string` - - `ClaudeCodeTrustedDevicesRequired object` + - `ip_address: string` - The Claude Code trusted devices setting was changed for the organization. + - `user_agent: string` - - `current_value: boolean or null` + - `type: optional "admin_api_key_actor"` - Setting value immediately after this change + default: admin_api_key_actor - - `previous_value: boolean or null` + - `ServiceAccountActor object` - Setting value immediately before this change + - `ip_address: string` - - `type: optional "claude_code_trusted_devices_required"` + - `service_account_id: string` - default: claude_code_trusted_devices_required + - `user_agent: string` - - `CoworkTrustedDevicesRequired object` + - `type: optional "service_account_actor"` - The Cowork trusted devices enforcement setting was changed for the organization. + default: service_account_actor - - `current_value: boolean or null` + - `ScimDirectorySyncActor object` - Setting value immediately after this change + - `directory_id: string` - - `previous_value: boolean or null` + - `workos_event_id: string` - Setting value immediately before this change + - `idp_connection_type: optional string or null` - - `type: optional "cowork_trusted_devices_required"` + - `type: optional "scim_directory_sync_actor"` - default: cowork_trusted_devices_required + default: scim_directory_sync_actor - - `InlineVisualizationsEnabled object` + - `FederatedIdentityActor object` - The inline visualizations setting was changed for the organization. + A federated external workload authenticated via a verified OIDC token. - - `current_value: boolean or null` + Carries the verified issuer, subject, and audience claims from the + presented JWT. - Setting value immediately after this change + - `issuer: string` - - `previous_value: boolean or null` + - `subject: string` - Setting value immediately before this change + - `audience: optional array of string` - - `type: optional "inline_visualizations_enabled"` + - `ip_address: optional string or null` - default: inline_visualizations_enabled + - `type: optional "federated_identity_actor"` - - `OrganizationBannerSettingsUpdated object` + default: federated_identity_actor - The organization banner setting was changed. + - `user_agent: optional string or null` - - `current_value: map[unknown] or null` + - `FederatedActor object` - Setting value immediately after this change + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. - - `previous_value: map[unknown] or null` + - `provider: object or object or object or object` - Setting value immediately before this change + Asserting party: the AWS account the organization is bound to. - - `type: optional "organization_banner_settings"` + - `FederatedActorAwsProvider object` - default: organization_banner_settings + Asserting party: the AWS account the organization is bound to. - - `ClaudeInSlackSettingsUpdated object` + - `account_id: string` - The Claude in Slack setting was changed for the organization. + - `signed_principal: string` - - `current_value: map[unknown] or null` + The AWS-signed ARN of the IAM principal that requested the token. - Setting value immediately after this change + - `type: optional "aws"` - - `previous_value: map[unknown] or null` + default: aws - Setting value immediately before this change + - `FederatedActorAzureProvider object` - - `type: optional "claude_in_slack_settings"` + Asserting party: the Azure subscription the organization is bound to. - default: claude_in_slack_settings + - `subscription_id: string` - - `ClaudeCodeDefaultWorkerEnvironmentID object` + - `type: optional "azure"` - The Claude Code default worker environment setting was changed for the organization. + default: azure - - `current_value: string or null` + - `FederatedActorGcpProvider object` - Setting value immediately after this change + Asserting party: the GCP project the organization is bound to. - - `previous_value: string or null` + - `project_number: string` - Setting value immediately before this change + - `type: optional "gcp"` - - `type: optional "claude_code_default_worker_environment_id"` + default: gcp - default: claude_code_default_worker_environment_id + - `FederatedActorOidcProvider object` - - `ClaudeCodeDefaultWorkerPoolID object` + Asserting party: a customer-registered OIDC federation issuer. - The Claude Code default worker pool setting was changed for the organization. + - `issuer: optional string or null` - - `current_value: string or null` + The federation issuer's URL. Null when the presented credential failed verification. - Setting value immediately after this change + - `type: optional "oidc"` - - `previous_value: string or null` + default: oidc - Setting value immediately before this change + - `ip_address: optional string or null` - - `type: optional "claude_code_default_worker_pool_id"` + - `subject: optional string or null` - default: claude_code_default_worker_pool_id + The provider's verified identifier for the caller; its form depends on the provider. - - `ManagedAgentsEnabled object` + - `type: optional "federated_actor"` - The managed agents setting was changed for the organization. + default: federated_actor - - `current_value: boolean or null` + - `user_agent: optional string or null` - Setting value immediately after this change + - `AttestedDeviceActor object` - - `previous_value: boolean or null` + An attested mobile device authenticated via Apple App Attest. - Setting value immediately before this change + - `external_client_id: string` - - `type: optional "managed_agents_enabled"` + - `kid_hash: string` - default: managed_agents_enabled + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` - `id: optional string` @@ -78139,13 +79472,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_organization_settings_updated"` + - `type: optional "payment_method_updated"` - default: claude_organization_settings_updated + default: payment_method_updated - - `OwnedProjectsAccessRestored object` + - `PendingShareCreated object` - Access to owned projects was restored. + A pending share of a project or skill was created for an email address that is not yet an organization member. - `actor: object or object or object or 8 more` @@ -78358,6 +79691,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invitee_email: string` + + Email address the share was created for. + + - `resource_id: string` + + Tagged ID of the resource being shared. + + - `resource_type: string` + + The type of resource being shared. + + - `role: string` + + The role that will be granted when the invitee joins the organization. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -78376,15 +79725,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "owned_projects_access_restored"` - - default: owned_projects_access_restored + - `type: optional "pending_share_created"` - - `user_id: optional string or null` + default: pending_share_created - - `PaymentMethodUpdated object` + - `PendingShareRevoked object` - The organization's default payment method was updated. + A pending share of a project or skill was revoked before the invitee joined the organization. - `actor: object or object or object or 8 more` @@ -78597,6 +79944,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invitee_email: string` + + Email address the share had been created for. + + - `resource_id: string` + + Tagged ID of the resource that was shared. + + - `resource_type: string` + + The type of resource that was shared. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -78615,13 +79974,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "payment_method_updated"` + - `type: optional "pending_share_revoked"` - default: payment_method_updated + default: pending_share_revoked - - `PendingShareCreated object` + - `PhoneCodeSent object` - A pending share of a project or skill was created for an email address that is not yet an organization member. + User requested a phone verification code. - `actor: object or object or object or 8 more` @@ -78834,21 +80193,242 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` + - `id: optional string` - Email address the share was created for. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `resource_id: string` + - `created_at: optional string` - Tagged ID of the resource being shared. + When this activity occurred. - - `resource_type: string` + format: date-time - The type of resource being shared. + - `organization_id: optional string or null` - - `role: string` + Organization ID this activity is associated with - The role that will be granted when the invitee joins the organization. + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "phone_code_sent"` + + default: phone_code_sent + + - `PhoneCodeVerified object` + + User successfully verified their phone code. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` - `id: optional string` @@ -78868,13 +80448,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "pending_share_created"` + - `type: optional "phone_code_verified"` - default: pending_share_created + default: phone_code_verified - - `PendingShareRevoked object` + - `PlatformAgentArchived object` - A pending share of a project or skill was revoked before the invitee joined the organization. + An agent was archived on the API platform. - `actor: object or object or object or 8 more` @@ -79087,17 +80667,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` - - Email address the share had been created for. - - - `resource_id: string` - - Tagged ID of the resource that was shared. - - - `resource_type: string` + - `agent_id: string` - The type of resource that was shared. + The agent that was archived, e.g. "agent_01HX...". - `id: optional string` @@ -79117,13 +80689,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "pending_share_revoked"` + - `type: optional "platform_agent_archived"` - default: pending_share_revoked + default: platform_agent_archived - - `PhoneCodeSent object` + - `workspace_id: optional string or null` - User requested a phone verification code. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentCreated object` + + An agent was created on the API platform. - `actor: object or object or object or 8 more` @@ -79336,242 +80912,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `organization_id: optional string or null` - - Organization ID this activity is associated with - - - `organization_uuid: optional string or null` - - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - - `type: optional "phone_code_sent"` - - default: phone_code_sent - - - `PhoneCodeVerified object` - - User successfully verified their phone code. - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp - - - `FederatedActorOidcProvider object` - - Asserting party: a customer-registered OIDC federation issuer. - - - `issuer: optional string or null` - - The federation issuer's URL. Null when the presented credential failed verification. - - - `type: optional "oidc"` - - default: oidc - - - `ip_address: optional string or null` - - - `subject: optional string or null` - - The provider's verified identifier for the caller; its form depends on the provider. - - - `type: optional "federated_actor"` - - default: federated_actor - - - `user_agent: optional string or null` - - - `AttestedDeviceActor object` - - An attested mobile device authenticated via Apple App Attest. - - - `external_client_id: string` - - - `kid_hash: string` - - - `ip_address: optional string or null` - - - `type: optional "attested_device_actor"` - - default: attested_device_actor + - `agent_id: string` - - `user_agent: optional string or null` + The agent that was created, e.g. "agent_01HX...". - `id: optional string` @@ -79591,13 +80934,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "phone_code_verified"` + - `type: optional "platform_agent_created"` - default: phone_code_verified + default: platform_agent_created - - `PlatformAgentArchived object` + - `workspace_id: optional string or null` - An agent was archived on the API platform. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeleted object` + + An agent was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -79812,7 +81159,7 @@ compliance activities that can be filtered by various criteria. - `agent_id: string` - The agent that was archived, e.g. "agent_01HX...". + The agent that was deleted, e.g. "agent_01HX...". - `id: optional string` @@ -79832,17 +81179,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_archived"` + - `type: optional "platform_agent_deleted"` - default: platform_agent_archived + default: platform_agent_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentCreated object` + - `PlatformAgentDeploymentArchived object` - An agent was created on the API platform. + An agent deployment was archived on the API platform. - `actor: object or object or object or 8 more` @@ -80055,9 +81402,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was created, e.g. "agent_01HX...". + The agent deployment that was archived, e.g. "depl_01HX...". - `id: optional string` @@ -80077,17 +81424,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_created"` + - `type: optional "platform_agent_deployment_archived"` - default: platform_agent_created + default: platform_agent_deployment_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeleted object` + - `PlatformAgentDeploymentCreated object` - An agent was deleted from the API platform. + An agent deployment was created on the API platform. - `actor: object or object or object or 8 more` @@ -80300,9 +81647,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was deleted, e.g. "agent_01HX...". + The agent deployment that was created, e.g. "depl_01HX...". - `id: optional string` @@ -80322,17 +81669,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deleted"` + - `type: optional "platform_agent_deployment_created"` - default: platform_agent_deleted + default: platform_agent_deployment_created - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentArchived object` + - `PlatformAgentDeploymentDeleted object` - An agent deployment was archived on the API platform. + An agent deployment was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -80547,7 +81894,7 @@ compliance activities that can be filtered by various criteria. - `deployment_id: string` - The agent deployment that was archived, e.g. "depl_01HX...". + The agent deployment that was deleted, e.g. "depl_01HX...". - `id: optional string` @@ -80567,17 +81914,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_archived"` + - `type: optional "platform_agent_deployment_deleted"` - default: platform_agent_deployment_archived + default: platform_agent_deployment_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentCreated object` + - `PlatformAgentDeploymentPaused object` - An agent deployment was created on the API platform. + An agent deployment was paused on the API platform. - `actor: object or object or object or 8 more` @@ -80792,7 +82139,7 @@ compliance activities that can be filtered by various criteria. - `deployment_id: string` - The agent deployment that was created, e.g. "depl_01HX...". + The agent deployment that was paused, e.g. "depl_01HX...". - `id: optional string` @@ -80812,17 +82159,262 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_created"` + - `type: optional "platform_agent_deployment_paused"` - default: platform_agent_deployment_created + default: platform_agent_deployment_paused - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentDeleted object` + - `PlatformAgentDeploymentRunTriggered object` - An agent deployment was deleted from the API platform. + An agent deployment was run on demand on the API platform. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `deployment_id: string` + + The agent deployment that was run, e.g. "depl_01HX...". + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "platform_agent_deployment_run_triggered"` + + default: platform_agent_deployment_run_triggered + + - `workspace_id: optional string or null` + + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeploymentUnpaused object` + + An agent deployment was resumed on the API platform. - `actor: object or object or object or 8 more` @@ -81037,7 +82629,7 @@ compliance activities that can be filtered by various criteria. - `deployment_id: string` - The agent deployment that was deleted, e.g. "depl_01HX...". + The agent deployment that was resumed, e.g. "depl_01HX...". - `id: optional string` @@ -81057,17 +82649,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_deleted"` + - `type: optional "platform_agent_deployment_unpaused"` - default: platform_agent_deployment_deleted + default: platform_agent_deployment_unpaused - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentPaused object` + - `PlatformAgentDeploymentUpdated object` - An agent deployment was paused on the API platform. + An agent deployment was updated on the API platform. - `actor: object or object or object or 8 more` @@ -81282,7 +82874,7 @@ compliance activities that can be filtered by various criteria. - `deployment_id: string` - The agent deployment that was paused, e.g. "depl_01HX...". + The agent deployment that was updated, e.g. "depl_01HX...". - `id: optional string` @@ -81302,17 +82894,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_paused"` + - `type: optional "platform_agent_deployment_updated"` - default: platform_agent_deployment_paused + default: platform_agent_deployment_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentRunTriggered object` + - `PlatformAgentSessionArchived object` - An agent deployment was run on demand on the API platform. + An agent session was archived on the API platform. - `actor: object or object or object or 8 more` @@ -81525,9 +83117,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was run, e.g. "depl_01HX...". + The agent session that was archived, e.g. "session_01HX...". - `id: optional string` @@ -81547,17 +83139,262 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_run_triggered"` + - `type: optional "platform_agent_session_archived"` - default: platform_agent_deployment_run_triggered + default: platform_agent_session_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentUnpaused object` + - `PlatformAgentSessionCreated object` - An agent deployment was resumed on the API platform. + An agent session was created on the API platform. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `session_id: string` + + The agent session that was created, e.g. "session_01HX...". + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "platform_agent_session_created"` + + default: platform_agent_session_created + + - `workspace_id: optional string or null` + + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentSessionDeleted object` + + An agent session was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -81770,9 +83607,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was resumed, e.g. "depl_01HX...". + The agent session that was deleted, e.g. "session_01HX...". - `id: optional string` @@ -81792,17 +83629,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_unpaused"` + - `type: optional "platform_agent_session_deleted"` - default: platform_agent_deployment_unpaused + default: platform_agent_session_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentUpdated object` + - `PlatformAgentSessionResourceAdded object` - An agent deployment was updated on the API platform. + A resource was attached to an agent session. - `actor: object or object or object or 8 more` @@ -82015,254 +83852,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` - - The agent deployment that was updated, e.g. "depl_01HX...". - - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `organization_id: optional string or null` - - Organization ID this activity is associated with - - - `organization_uuid: optional string or null` - - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - - `type: optional "platform_agent_deployment_updated"` - - default: platform_agent_deployment_updated - - - `workspace_id: optional string or null` - - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - - `PlatformAgentSessionArchived object` - - An agent session was archived on the API platform. - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp - - - `FederatedActorOidcProvider object` - - Asserting party: a customer-registered OIDC federation issuer. - - - `issuer: optional string or null` - - The federation issuer's URL. Null when the presented credential failed verification. - - - `type: optional "oidc"` - - default: oidc - - - `ip_address: optional string or null` - - - `subject: optional string or null` - - The provider's verified identifier for the caller; its form depends on the provider. - - - `type: optional "federated_actor"` - - default: federated_actor - - - `user_agent: optional string or null` - - - `AttestedDeviceActor object` - - An attested mobile device authenticated via Apple App Attest. - - - `external_client_id: string` - - - `kid_hash: string` - - - `ip_address: optional string or null` - - - `type: optional "attested_device_actor"` - - default: attested_device_actor + - `resource_id: string` - - `user_agent: optional string or null` + The resource that was attached, e.g. "resource_01HX...". - `session_id: string` - The agent session that was archived, e.g. "session_01HX...". + The agent session the resource was attached to, e.g. "session_01HX...". - `id: optional string` @@ -82282,17 +83878,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_archived"` + - `type: optional "platform_agent_session_resource_added"` - default: platform_agent_session_archived + default: platform_agent_session_resource_added - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionCreated object` + - `PlatformAgentSessionResourceDeleted object` - An agent session was created on the API platform. + A resource attached to an agent session was removed. - `actor: object or object or object or 8 more` @@ -82505,9 +84101,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resource_id: string` + + The resource that was removed, e.g. "resource_01HX...". + - `session_id: string` - The agent session that was created, e.g. "session_01HX...". + The agent session the resource belonged to, e.g. "session_01HX...". - `id: optional string` @@ -82527,17 +84127,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_created"` + - `type: optional "platform_agent_session_resource_deleted"` - default: platform_agent_session_created + default: platform_agent_session_resource_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionDeleted object` + - `PlatformAgentSessionResourceUpdated object` - An agent session was deleted from the API platform. + A resource attached to an agent session was updated. - `actor: object or object or object or 8 more` @@ -82750,9 +84350,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resource_id: string` + + The resource that was updated, e.g. "resource_01HX...". + - `session_id: string` - The agent session that was deleted, e.g. "session_01HX...". + The agent session the resource belongs to, e.g. "session_01HX...". - `id: optional string` @@ -82772,17 +84376,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_deleted"` + - `type: optional "platform_agent_session_resource_updated"` - default: platform_agent_session_deleted + default: platform_agent_session_resource_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceAdded object` + - `PlatformAgentSessionThreadArchived object` - A resource was attached to an agent session. + A thread within an agent session was archived. - `actor: object or object or object or 8 more` @@ -82995,13 +84599,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` + - `session_id: string` - The resource that was attached, e.g. "resource_01HX...". + The agent session the thread belongs to, e.g. "session_01HX...". - - `session_id: string` + - `thread_id: string` - The agent session the resource was attached to, e.g. "session_01HX...". + The thread that was archived, e.g. "thread_01HX...". - `id: optional string` @@ -83021,17 +84625,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_added"` + - `type: optional "platform_agent_session_thread_archived"` - default: platform_agent_session_resource_added + default: platform_agent_session_thread_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceDeleted object` + - `PlatformAgentSessionUpdated object` - A resource attached to an agent session was removed. + An agent session was updated on the API platform. - `actor: object or object or object or 8 more` @@ -83244,13 +84848,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` - - The resource that was removed, e.g. "resource_01HX...". - - `session_id: string` - The agent session the resource belonged to, e.g. "session_01HX...". + The agent session that was updated, e.g. "session_01HX...". - `id: optional string` @@ -83270,17 +84870,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_deleted"` + - `type: optional "platform_agent_session_updated"` - default: platform_agent_session_resource_deleted + default: platform_agent_session_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceUpdated object` + - `PlatformAgentUpdated object` - A resource attached to an agent session was updated. + An agent was updated on the API platform. - `actor: object or object or object or 8 more` @@ -83493,13 +85093,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` - - The resource that was updated, e.g. "resource_01HX...". - - - `session_id: string` + - `agent_id: string` - The agent session the resource belongs to, e.g. "session_01HX...". + The agent that was updated, e.g. "agent_01HX...". - `id: optional string` @@ -83519,17 +85115,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_updated"` + - `type: optional "platform_agent_updated"` - default: platform_agent_session_resource_updated + default: platform_agent_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionThreadArchived object` + - `PlatformAPIKeyCreated object` - A thread within an agent session was archived. + An API key was created. - `actor: object or object or object or 8 more` @@ -83742,13 +85338,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` - - The agent session the thread belongs to, e.g. "session_01HX...". - - - `thread_id: string` + - `api_key_id: string` - The thread that was archived, e.g. "thread_01HX...". + Tagged ID of the created API key - `id: optional string` @@ -83768,17 +85360,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_thread_archived"` - - default: platform_agent_session_thread_archived - - - `workspace_id: optional string or null` + - `type: optional "platform_api_key_created"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_api_key_created - - `PlatformAgentSessionUpdated object` + - `PlatformAPIKeyUpdated object` - An agent session was updated on the API platform. + An API key was updated. - `actor: object or object or object or 8 more` @@ -83991,9 +85579,23 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `api_key_id: string` - The agent session that was updated, e.g. "session_01HX...". + Tagged ID of the updated API key + + - `updates: array of object` + + - `current_value: string` + + - `previous_value: string` + + - `type: "name" or "status" or "workspace"` + + - `"name"` + + - `"status"` + + - `"workspace"` - `id: optional string` @@ -84013,17 +85615,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_updated"` - - default: platform_agent_session_updated - - - `workspace_id: optional string or null` + - `type: optional "platform_api_key_updated"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_api_key_updated - - `PlatformAgentUpdated object` + - `PlatformAppAttestAuthentication object` - An agent was updated on the API platform. + An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials. - `actor: object or object or object or 8 more` @@ -84236,10 +85834,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was updated, e.g. "agent_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -84250,6 +85844,22 @@ compliance activities that can be filtered by various criteria. format: date-time + - `event_data: optional object or null` + + A nested object within a compliance activity payload. + + - `external_client_id: optional string or null` + + The registered external client the device presented, e.g. "clid_01HXZ4J2N8K5P7R9T3V6W1Y4M0". + + - `kid_hash: optional string or null` + + A truncated hash of the device's attested key identifier. + + - `workspace_id: optional string or null` + + The tagged ID of the workspace the minted token is bound to. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -84258,17 +85868,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_updated"` + - `request_id: optional string or null` - default: platform_agent_updated + The Anthropic API request identifier for correlation. - - `workspace_id: optional string or null` + - `status: optional object or null` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + A nested object within a compliance activity payload. - - `PlatformAPIKeyCreated object` + - `outcome: string` - An API key was created. + Whether the token exchange succeeded or was denied. + + - `reason: optional string or null` + + A short reason code when the exchange did not succeed. + + - `type: optional "platform_app_attest_authentication"` + + default: platform_app_attest_authentication + + - `PlatformBillingUpgradedToPrepaid object` + + The organization's API billing was upgraded to the prepaid plan. - `actor: object or object or object or 8 more` @@ -84481,9 +86103,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `api_key_id: string` + - `previous_billing_type: string` - Tagged ID of the created API key + The organization's billing type before this upgrade, for example "api_evaluation". - `id: optional string` @@ -84503,13 +86125,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_api_key_created"` + - `type: optional "platform_billing_upgraded_to_prepaid"` - default: platform_api_key_created + default: platform_billing_upgraded_to_prepaid - - `PlatformAPIKeyUpdated object` + - `PlatformClearanceWorkspaceProgramRequestCleared object` - An API key was updated. + A workspace's clearance program assignment was removed. - `actor: object or object or object or 8 more` @@ -84722,23 +86344,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `api_key_id: string` - - Tagged ID of the updated API key - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "name" or "status" or "workspace"` + - `program_slug: string` - - `"name"` + The clearance program's identifier - - `"status"` + - `workspace_id: string` - - `"workspace"` + Tagged ID of the workspace - `id: optional string` @@ -84758,13 +86370,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_api_key_updated"` + - `type: optional "platform_clearance_workspace_program_request_cleared"` - default: platform_api_key_updated + default: platform_clearance_workspace_program_request_cleared - - `PlatformAppAttestAuthentication object` + - `PlatformClearanceWorkspaceProgramRequestSet object` - An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials. + A workspace's clearance program assignment was created or updated. - `actor: object or object or object or 8 more` @@ -84977,31 +86589,33 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `opt_decision: "opt_in" or "opt_out" or "unspecified"` - Unique identifier for the activity e.g. 'activity_abcd1234' + Whether the workspace is opted in or out of the program - - `created_at: optional string` + - `"opt_in"` - When this activity occurred. + - `"opt_out"` - format: date-time + - `"unspecified"` - - `event_data: optional object or null` + - `program_slug: string` - A nested object within a compliance activity payload. + The clearance program's identifier - - `external_client_id: optional string or null` + - `workspace_id: string` - The registered external client the device presented, e.g. "clid_01HXZ4J2N8K5P7R9T3V6W1Y4M0". + Tagged ID of the workspace - - `kid_hash: optional string or null` + - `id: optional string` - A truncated hash of the device's attested key identifier. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `workspace_id: optional string or null` + - `created_at: optional string` - The tagged ID of the workspace the minted token is bound to. + When this activity occurred. + + format: date-time - `organization_id: optional string or null` @@ -85011,29 +86625,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `request_id: optional string or null` - - The Anthropic API request identifier for correlation. - - - `status: optional object or null` - - A nested object within a compliance activity payload. - - - `outcome: string` - - Whether the token exchange succeeded or was denied. - - - `reason: optional string or null` - - A short reason code when the exchange did not succeed. - - - `type: optional "platform_app_attest_authentication"` + - `type: optional "platform_clearance_workspace_program_request_set"` - default: platform_app_attest_authentication + default: platform_clearance_workspace_program_request_set - - `PlatformBillingUpgradedToPrepaid object` + - `PlatformCostReportViewed object` - The organization's API billing was upgraded to the prepaid plan. + The cost report was viewed. - `actor: object or object or object or 8 more` @@ -85246,10 +86844,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `previous_billing_type: string` - - The organization's billing type before this upgrade, for example "api_evaluation". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -85268,13 +86862,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_billing_upgraded_to_prepaid"` + - `type: optional "platform_cost_report_viewed"` - default: platform_billing_upgraded_to_prepaid + default: platform_cost_report_viewed - - `PlatformClearanceWorkspaceProgramRequestCleared object` + - `PlatformDreamArchived object` - A workspace's clearance program assignment was removed. + A Dream (asynchronous memory-consolidation job) was archived. - `actor: object or object or object or 8 more` @@ -85487,13 +87081,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `program_slug: string` - - The clearance program's identifier - - - `workspace_id: string` + - `dream_id: string` - Tagged ID of the workspace + Tagged dream ID, e.g. "drm_01HX...". - `id: optional string` @@ -85513,13 +87103,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_clearance_workspace_program_request_cleared"` + - `type: optional "platform_dream_archived"` - default: platform_clearance_workspace_program_request_cleared + default: platform_dream_archived - - `PlatformClearanceWorkspaceProgramRequestSet object` + - `workspace_id: optional string or null` - A workspace's clearance program assignment was created or updated. + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. + + - `PlatformDreamCancelled object` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. - `actor: object or object or object or 8 more` @@ -85732,23 +87326,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `opt_decision: "opt_in" or "opt_out" or "unspecified"` + - `dream_id: string` - Whether the workspace is opted in or out of the program - - - `"opt_in"` - - - `"opt_out"` - - - `"unspecified"` - - - `program_slug: string` - - The clearance program's identifier - - - `workspace_id: string` - - Tagged ID of the workspace + Tagged dream ID, e.g. "drm_01HX...". - `id: optional string` @@ -85768,13 +87348,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_clearance_workspace_program_request_set"` + - `type: optional "platform_dream_cancelled"` - default: platform_clearance_workspace_program_request_set + default: platform_dream_cancelled - - `PlatformCostReportViewed object` + - `workspace_id: optional string or null` - The cost report was viewed. + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. + + - `PlatformDreamCreated object` + + A Dream (asynchronous memory-consolidation job) was created. - `actor: object or object or object or 8 more` @@ -85987,6 +87571,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `dream_id: string` + + Tagged dream ID, e.g. "drm_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -86005,9 +87593,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_cost_report_viewed"` + - `type: optional "platform_dream_created"` - default: platform_cost_report_viewed + default: platform_dream_created + + - `workspace_id: optional string or null` + + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. - `PlatformFederatedAuthentication object` @@ -105450,10 +107042,253 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string or null` + - `claude_file_id: string or null` + + - `claude_project_id: string` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "claude_project_file_deletion_failed"` + + default: claude_project_file_deletion_failed + + - `ClaudeProjectFileUploaded object` + + A file was uploaded to a Claude project. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `claude_file_id: string` - `claude_project_id: string` + - `filename: string or null` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -105472,13 +107307,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_file_deletion_failed"` + - `type: optional "claude_project_file_uploaded"` - default: claude_project_file_deletion_failed + default: claude_project_file_uploaded - - `ClaudeProjectFileUploaded object` + - `ClaudeProjectReported object` - A file was uploaded to a Claude project. + A Claude project was reported. - `actor: object or object or object or 8 more` @@ -105691,12 +107526,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` - - `claude_project_id: string` - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -105715,13 +107546,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_file_uploaded"` + - `type: optional "claude_project_reported"` - default: claude_project_file_uploaded + default: claude_project_reported - - `ClaudeProjectReported object` + - `ClaudeProjectSharingUpdated object` - A Claude project was reported. + A Claude project's sharing settings were updated. - `actor: object or object or object or 8 more` @@ -105934,8 +107765,30 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `audience: array of object or object` + + Sharing audience for the project. If empty, it's only visible to the creating user. + + - `Public object` + + Sharing audience: the project is visible to anyone with the link. + + - `type: optional "public"` + + default: public + + - `Organization object` + + Sharing audience: the project is visible to members of the owning organization. + + - `type: optional "organization"` + + default: organization + - `claude_project_id: string` + The project's identifier, e.g. "claude_proj_01Ab...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -105954,13 +107807,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_reported"` + - `type: optional "claude_project_sharing_updated"` - default: claude_project_reported + default: claude_project_sharing_updated - - `ClaudeProjectSharingUpdated object` + - `ClaudeProjectViewed object` - A Claude project's sharing settings were updated. + A Claude project was viewed. - `actor: object or object or object or 8 more` @@ -106173,22 +108026,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `audience: array of object or object` - - Sharing audience for the project. If empty, this it's only visible to the creating user. - - - `ProjectSharingAudiencePublic object` - - - `type: optional "public"` - - default: public - - - `ProjectSharingAudienceOrganization object` - - - `type: optional "organization"` - - default: organization - - `claude_project_id: string` - `id: optional string` @@ -106209,13 +108046,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_sharing_updated"` + - `preview_only: optional boolean` - default: claude_project_sharing_updated + default: false - - `ClaudeProjectViewed object` + - `type: optional "claude_project_viewed"` - A Claude project was viewed. + default: claude_project_viewed + + - `ClaudePubsecIdentityConfigured object` + + SAML IdP configuration updated for a public sector organization. - `actor: object or object or object or 8 more` @@ -106428,7 +108269,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `idp_saml_config_updated: boolean` + + - `magic_link_toggled: boolean` - `id: optional string` @@ -106440,6 +108283,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `magic_link_enabled: optional boolean or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -106448,17 +108293,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `preview_only: optional boolean` - - default: false - - - `type: optional "claude_project_viewed"` + - `type: optional "claude_pubsec_identity_configured"` - default: claude_project_viewed + default: claude_pubsec_identity_configured - - `ClaudePubsecIdentityConfigured object` + - `RbacRoleAssigned object` - SAML IdP configuration updated for a public sector organization. + Admin assigned an RBAC custom role to a principal. - `actor: object or object or object or 8 more` @@ -106671,9 +108512,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `idp_saml_config_updated: boolean` + - `principal_id: string` - - `magic_link_toggled: boolean` + Tagged ID of the principal + + - `principal_type: string` + + Type of principal: account, group, or service_account + + - `role_id: string` + + Tagged ID of the role - `id: optional string` @@ -106685,8 +108534,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `magic_link_enabled: optional boolean or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -106695,13 +108542,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_pubsec_identity_configured"` + - `type: optional "rbac_role_assigned"` - default: claude_pubsec_identity_configured + default: rbac_role_assigned - - `RbacRoleAssigned object` + - `RbacRoleCreated object` - Admin assigned an RBAC custom role to a principal. + Admin created an RBAC custom role. - `actor: object or object or object or 8 more` @@ -106914,17 +108761,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `principal_id: string` - - Tagged ID of the principal - - - `principal_type: string` + - `role_id: string` - Type of principal: account, group, or service_account + Tagged ID of the created role - - `role_id: string` + - `role_name: string` - Tagged ID of the role + Name of the created role - `id: optional string` @@ -106944,13 +108787,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_assigned"` + - `type: optional "rbac_role_created"` - default: rbac_role_assigned + default: rbac_role_created - - `RbacRoleCreated object` + - `RbacRoleDeleted object` - Admin created an RBAC custom role. + Admin deleted an RBAC custom role. - `actor: object or object or object or 8 more` @@ -107165,11 +109008,7 @@ compliance activities that can be filtered by various criteria. - `role_id: string` - Tagged ID of the created role - - - `role_name: string` - - Name of the created role + Tagged ID of the deleted role - `id: optional string` @@ -107189,13 +109028,20 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_created"` + - `type: optional "rbac_role_deleted"` - default: rbac_role_created + default: rbac_role_deleted - - `RbacRoleDeleted object` + - `RbacRolePermissionAdded object` - Admin deleted an RBAC custom role. + Admin added a permission to an RBAC custom role. + + Emitted once per requested permission, including permissions the role + already had, so a retried request still produces a complete audit record. + + - `action: string` + + Action permitted on the resource - `actor: object or object or object or 8 more` @@ -107408,9 +109254,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resource_id: string` + + ID of the resource + + - `resource_type: string` + + Type of resource the permission applies to + - `role_id: string` - Tagged ID of the deleted role + Tagged ID of the role - `id: optional string` @@ -107430,20 +109284,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_deleted"` + - `type: optional "rbac_role_permission_added"` - default: rbac_role_deleted + default: rbac_role_permission_added - - `RbacRolePermissionAdded object` + - `RbacRolePermissionRemoved object` - Admin added a permission to an RBAC custom role. + Admin removed a permission from an RBAC custom role. Emitted once per requested permission, including permissions the role - already had, so a retried request still produces a complete audit record. + already lacked, so a retried request still produces a complete audit + record. - `action: string` - Action permitted on the resource + Action that was permitted on the resource - `actor: object or object or object or 8 more` @@ -107662,7 +109517,7 @@ compliance activities that can be filtered by various criteria. - `resource_type: string` - Type of resource the permission applies to + Type of resource the permission applied to - `role_id: string` @@ -107686,21 +109541,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_permission_added"` - - default: rbac_role_permission_added - - - `RbacRolePermissionRemoved object` - - Admin removed a permission from an RBAC custom role. + - `type: optional "rbac_role_permission_removed"` - Emitted once per requested permission, including permissions the role - already lacked, so a retried request still produces a complete audit - record. + default: rbac_role_permission_removed - - `action: string` + - `RbacRoleUnassigned object` - Action that was permitted on the resource + Admin unassigned an RBAC custom role from a principal. - `actor: object or object or object or 8 more` @@ -107913,13 +109760,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` + - `principal_id: string` - ID of the resource + Tagged ID of the principal - - `resource_type: string` + - `principal_type: string` - Type of resource the permission applied to + Type of principal: account, group, or service_account - `role_id: string` @@ -107943,13 +109790,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_permission_removed"` + - `type: optional "rbac_role_unassigned"` - default: rbac_role_permission_removed + default: rbac_role_unassigned - - `RbacRoleUnassigned object` + - `RbacRoleUpdated object` - Admin unassigned an RBAC custom role from a principal. + Admin updated an RBAC custom role. - `actor: object or object or object or 8 more` @@ -108162,17 +110009,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `principal_id: string` - - Tagged ID of the principal - - - `principal_type: string` - - Type of principal: account, group, or service_account - - `role_id: string` - Tagged ID of the role + Tagged ID of the updated role - `id: optional string` @@ -108192,13 +110031,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_unassigned"` + - `type: optional "rbac_role_updated"` - default: rbac_role_unassigned + default: rbac_role_updated - - `RbacRoleUpdated object` + - `RoleAssignmentGranted object` - Admin updated an RBAC custom role. + Role assignment was granted. - `actor: object or object or object or 8 more` @@ -108411,10 +110250,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `role_id: string` - - Tagged ID of the updated role - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -108433,13 +110268,33 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_updated"` + - `resource_id: optional string or null` - default: rbac_role_updated + ID of the resource the role is on. - - `RoleAssignmentGranted object` + - `resource_type: optional string or null` - Role assignment was granted. + What kind of resource the role is on, for example "chat_project", "skill", or "plugin". + + - `role: optional string or null` + + The role that was granted, for example "skill:viewer" or "plugin:viewer". + + - `target_id: optional string or null` + + ID of the grantee: a user ID for a member, a group ID for a group, the organization ID for an organization-wide grant. + + - `target_type: optional string or null` + + What kind of grantee received the role, for example "organization_member", "group", or "organization". + + - `type: optional "role_assignment_granted"` + + default: role_assignment_granted + + - `RoleAssignmentRevoked object` + + Role assignment was revoked. - `actor: object or object or object or 8 more` @@ -108672,261 +110527,24 @@ compliance activities that can be filtered by various criteria. - `resource_id: optional string or null` - - `resource_type: optional string or null` - - - `role: optional string or null` - - - `target_id: optional string or null` - - - `target_type: optional string or null` - - - `type: optional "role_assignment_granted"` - - default: role_assignment_granted - - - `RoleAssignmentRevoked object` - - Role assignment was revoked. - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp - - - `FederatedActorOidcProvider object` - - Asserting party: a customer-registered OIDC federation issuer. - - - `issuer: optional string or null` - - The federation issuer's URL. Null when the presented credential failed verification. - - - `type: optional "oidc"` - - default: oidc - - - `ip_address: optional string or null` - - - `subject: optional string or null` - - The provider's verified identifier for the caller; its form depends on the provider. - - - `type: optional "federated_actor"` - - default: federated_actor - - - `user_agent: optional string or null` - - - `AttestedDeviceActor object` - - An attested mobile device authenticated via Apple App Attest. - - - `external_client_id: string` - - - `kid_hash: string` - - - `ip_address: optional string or null` - - - `type: optional "attested_device_actor"` - - default: attested_device_actor - - - `user_agent: optional string or null` - - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `organization_id: optional string or null` - - Organization ID this activity is associated with - - - `organization_uuid: optional string or null` - - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - - `resource_id: optional string or null` + ID of the resource the role was on. - `resource_type: optional string or null` + What kind of resource the role was on, for example "chat_project", "skill", or "plugin". + - `role: optional string or null` + The role that was revoked, for example "skill:viewer" or "plugin:viewer". + - `target_id: optional string or null` + ID of the grantee that held the role: a user ID for a member, a group ID for a group, the organization ID for an organization-wide grant. + - `target_type: optional string or null` + What kind of grantee held the role, for example "organization_member", "group", or "organization". + - `type: optional "role_assignment_revoked"` default: role_assignment_revoked @@ -121447,11 +123065,11 @@ compliance activities that can be filtered by various criteria. The web search setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -121463,11 +123081,11 @@ compliance activities that can be filtered by various criteria. The geolocation setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -121581,11 +123199,11 @@ compliance activities that can be filtered by various criteria. The Claude API in Artifacts setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -124149,7 +125767,7 @@ unknown organizations and organizations outside the hierarchy return 404. A setting whose enforced value is a single true/false flag. - - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 44 more` + - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more` - `"ai_powered_artifacts_enabled"` @@ -124193,6 +125811,22 @@ unknown organizations and organizations outside the hierarchy return 404. - `"claude_in_slack_enabled"` + - `"claude_science_custom_connectors_enabled"` + + - `"claude_science_custom_skills_enabled"` + + - `"claude_science_enabled"` + + - `"claude_science_managed_network_allowlist_enabled"` + + - `"claude_science_memory_enabled"` + + - `"claude_science_modal_enabled"` + + - `"claude_science_scientific_model_endpoints_enabled"` + + - `"claude_science_ssh_hosts_enabled"` + - `"code_execution_enabled"` - `"code_execution_network_egress_enabled"` @@ -126760,7 +128394,7 @@ forward-only via `next_page`; there is no reverse cursor. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -126858,7 +128492,7 @@ inference call has aged out returns 404. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -127155,7 +128789,7 @@ explicit 400; restart the walk to read under the current boundary. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` diff --git a/content/en/api/compliance/activities.md b/content/en/api/compliance/activities.md index fbd1a3239..2bfe94ce4 100644 --- a/content/en/api/compliance/activities.md +++ b/content/en/api/compliance/activities.md @@ -12,7 +12,7 @@ compliance activities that can be filtered by various criteria. ### Query parameters -- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 474 more` +- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 480 more` Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`. @@ -188,6 +188,14 @@ compliance activities that can be filtered by various criteria. An attempt to access an artifact failed. + - `"claude_artifact_commented"` + + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. + + - `"claude_artifact_comments_viewed"` + + An artifact's comments were viewed. + - `"claude_artifact_created"` An artifact was created. @@ -330,7 +338,7 @@ compliance activities that can be filtered by various criteria. - `"claude_code_security_scan_run_updated"` - A single Claude Code Security scan run was archived or unarchived. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. - `"claude_code_security_scan_schedule_deleted"` @@ -404,6 +412,10 @@ compliance activities that can be filtered by various criteria. Command was replaced. + - `"claude_enterprise_upgrade_credit_updated"` + + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. + - `"claude_file_access_failed"` A user was denied access to a file in Claude.ai. @@ -1304,11 +1316,11 @@ compliance activities that can be filtered by various criteria. - `"org_work_across_apps_disabled"` - Organization Work Across Apps was disabled. + The organization's "Let Claude work across apps" setting was turned off. - `"org_work_across_apps_enabled"` - Organization Work Across Apps was enabled. + The organization's "Let Claude work across apps" setting was turned on. - `"organization_address_updated"` @@ -1450,6 +1462,18 @@ compliance activities that can be filtered by various criteria. The cost report was viewed. + - `"platform_dream_archived"` + + A Dream (asynchronous memory-consolidation job) was archived. + + - `"platform_dream_cancelled"` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. + + - `"platform_dream_created"` + + A Dream (asynchronous memory-consolidation job) was created. + - `"platform_federated_authentication"` A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials. @@ -1984,7 +2008,7 @@ compliance activities that can be filtered by various criteria. format: date-time -- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 474 more` +- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 480 more` Exclude activities of these types. Cannot be combined with `activity_types[]`. @@ -2160,6 +2184,14 @@ compliance activities that can be filtered by various criteria. An attempt to access an artifact failed. + - `"claude_artifact_commented"` + + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. + + - `"claude_artifact_comments_viewed"` + + An artifact's comments were viewed. + - `"claude_artifact_created"` An artifact was created. @@ -2302,7 +2334,7 @@ compliance activities that can be filtered by various criteria. - `"claude_code_security_scan_run_updated"` - A single Claude Code Security scan run was archived or unarchived. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. - `"claude_code_security_scan_schedule_deleted"` @@ -2376,6 +2408,10 @@ compliance activities that can be filtered by various criteria. Command was replaced. + - `"claude_enterprise_upgrade_credit_updated"` + + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. + - `"claude_file_access_failed"` A user was denied access to a file in Claude.ai. @@ -3276,11 +3312,11 @@ compliance activities that can be filtered by various criteria. - `"org_work_across_apps_disabled"` - Organization Work Across Apps was disabled. + The organization's "Let Claude work across apps" setting was turned off. - `"org_work_across_apps_enabled"` - Organization Work Across Apps was enabled. + The organization's "Let Claude work across apps" setting was turned on. - `"organization_address_updated"` @@ -3422,6 +3458,18 @@ compliance activities that can be filtered by various criteria. The cost report was viewed. + - `"platform_dream_archived"` + + A Dream (asynchronous memory-consolidation job) was archived. + + - `"platform_dream_cancelled"` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. + + - `"platform_dream_created"` + + A Dream (asynchronous memory-consolidation job) was created. + - `"platform_federated_authentication"` A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials. @@ -3948,7 +3996,7 @@ compliance activities that can be filtered by various criteria. ### Returns -- `data: optional array of object or object or object or 474 more` +- `data: optional array of object or object or object or 480 more` List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present. @@ -6639,9 +6687,9 @@ compliance activities that can be filtered by various criteria. default: claude_artifact_access_failed - - `ClaudeArtifactCreated object` + - `ClaudeArtifactCommented object` - An artifact was created. + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. - `actor: object or object or object or 8 more` @@ -6856,250 +6904,45 @@ compliance activities that can be filtered by various criteria. - `claude_artifact_id: string` - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `organization_id: optional string or null` - - Organization ID this activity is associated with - - - `organization_uuid: optional string or null` - - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - - `type: optional "claude_artifact_created"` - - default: claude_artifact_created - - - `ClaudePublishedArtifactDeleted object` - - A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation). - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp - - - `FederatedActorOidcProvider object` - - Asserting party: a customer-registered OIDC federation issuer. - - - `issuer: optional string or null` - - The federation issuer's URL. Null when the presented credential failed verification. - - - `type: optional "oidc"` + The artifact's identifier. - default: oidc + - `comment_action: "activate_thread" or "create_thread" or "deactivate_thread" or 6 more` - - `ip_address: optional string or null` + The action recorded: for example a new comment thread, a reply to an existing thread, a thread resolved, reopened, or deleted, a thread's Claude activation granted or revoked, or a comment's text rewritten by its author. - - `subject: optional string or null` + - `"activate_thread"` - The provider's verified identifier for the caller; its form depends on the provider. + - `"create_thread"` - - `type: optional "federated_actor"` + - `"deactivate_thread"` - default: federated_actor + - `"delete_thread"` - - `user_agent: optional string or null` + - `"edit_comment"` - - `AttestedDeviceActor object` + - `"reopen"` - An attested mobile device authenticated via Apple App Attest. + - `"reply"` - - `external_client_id: string` + - `"resolve"` - - `kid_hash: string` + - `"unspecified"` - - `ip_address: optional string or null` + - `id: optional string` - - `type: optional "attested_device_actor"` + Unique identifier for the activity e.g. 'activity_abcd1234' - default: attested_device_actor + - `claude_artifact_comment_id: optional string or null` - - `user_agent: optional string or null` + The comment's identifier. Present when the activity relates to a specific comment, for example a new comment or an author's edit of one; absent for thread-level actions performed without a comment, such as resolve, reopen, deletion, or an activation change. - - `claude_published_artifact_id: string` + - `claude_artifact_comment_thread_id: optional string or null` - The published artifact's identifier. + The comment thread's identifier. - - `id: optional string` + - `claude_artifact_version_id: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The artifact version the comment activity applied to, when known. - `created_at: optional string` @@ -7115,13 +6958,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_published_artifact_deleted"` + - `type: optional "claude_artifact_commented"` - default: claude_published_artifact_deleted + default: claude_artifact_commented - - `ClaudeArtifactPublished object` + - `ClaudeArtifactCommentsViewed object` - A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded on every save, including saves of private artifacts, and changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated. + An artifact's comments were viewed. - `actor: object or object or object or 8 more` @@ -7334,17 +7177,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `artifact_type: string` - - Artifact type (code, html, react, etc.) - - - `claude_published_artifact_id: string` - - The published artifact's identifier. - - - `title: string` + - `claude_artifact_id: string` - Title of the published artifact + The artifact's identifier. - `id: optional string` @@ -7352,7 +7187,7 @@ compliance activities that can be filtered by various criteria. - `claude_artifact_version_id: optional string or null` - The version identifier recorded as live by this publish. + The version of the artifact whose comments were served, when known. - `created_at: optional string` @@ -7360,14 +7195,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `description: optional string or null` - - Optional gallery-card description supplied at publish time. Same provenance as title (caller-authored, reader-visible). - - - `is_redeploy: optional boolean or null` - - True when the publish updated an existing artifact; false when the publish created the artifact. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -7376,13 +7203,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_artifact_published"` + - `type: optional "claude_artifact_comments_viewed"` - default: claude_artifact_published + default: claude_artifact_comments_viewed - - `ClaudeArtifactSharingUpdated object` + - `ClaudeArtifactCreated object` - An artifact's sharing settings were updated. + An artifact was created. - `actor: object or object or object or 8 more` @@ -7595,43 +7422,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `audience: array of object or object or object` - - Sharing audience for the project. If empty, this it's only visible to the creating user. - - - `ArtifactSharingAudienceOrganization object` - - Sharing audience: visible to the owning organization. - - - `type: optional "organization"` - - default: organization - - - `ArtifactSharingAudienceUsers object` - - Sharing audience: visible to an explicit allowlist of users. - - - `type: optional "users"` - - default: users - - - `ArtifactSharingAudienceAnyoneWithLink object` - - Sharing audience: anyone with the link, including anonymous viewers - (an artifact shared to the open internet). - - - `type: optional "anyone_with_link"` - - default: anyone_with_link - - `claude_artifact_id: string` - The artifact's identifier. - - - `claude_artifact_version_id: string` - - The artifact version's identifier. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -7642,22 +7434,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `new_mode: optional string or null` - - The read-axis sharing mode after the change: `owner`, `users`, or `org`. - - - `new_user_count: optional number or null` - - The number of accounts on the explicit read allowlist after the change. Only meaningful when `new_mode` is `users`. - - - `new_write_mode: optional string or null` - - The write-axis sharing mode after the change: `owner`, `users`, or `org`. - - - `new_write_user_count: optional number or null` - - The number of accounts on the explicit write allowlist after the change. Only meaningful when `new_write_mode` is `users`. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -7666,29 +7442,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mode: optional string or null` - - The read-axis sharing mode before the change: `owner`, `users`, or `org`. - - - `previous_user_count: optional number or null` - - The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`. - - - `previous_write_mode: optional string or null` - - The write-axis sharing mode before the change: `owner`, `users`, or `org`. - - - `previous_write_user_count: optional number or null` - - The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`. - - - `type: optional "claude_artifact_sharing_updated"` + - `type: optional "claude_artifact_created"` - default: claude_artifact_sharing_updated + default: claude_artifact_created - - `ClaudeArtifactViewed object` + - `ClaudePublishedArtifactDeleted object` - An artifact was viewed. + A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation). - `actor: object or object or object or 8 more` @@ -7901,18 +7661,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_artifact_id: string` + - `claude_published_artifact_id: string` - The artifact's identifier. + The published artifact's identifier. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_version_id: optional string or null` - - The version of the artifact the user was served, when known. - - `created_at: optional string` When this activity occurred. @@ -7927,13 +7683,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_artifact_viewed"` + - `type: optional "claude_published_artifact_deleted"` - default: claude_artifact_viewed + default: claude_published_artifact_deleted - - `AuditLogExportAccessed object` + - `ClaudeArtifactPublished object` - Audit log export file was accessed/downloaded via signed URL. + A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded on every save, including saves of private artifacts, and changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated. - `actor: object or object or object or 8 more` @@ -8146,16 +7902,40 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `artifact_type: string` + + Artifact type (code, html, react, etc.) + + - `claude_published_artifact_id: string` + + The published artifact's identifier. + + - `title: string` + + Title of the published artifact + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_artifact_version_id: optional string or null` + + The version identifier recorded as live by this publish. + - `created_at: optional string` When this activity occurred. format: date-time + - `description: optional string or null` + + Optional gallery-card description supplied at publish time. Same provenance as title (caller-authored, reader-visible). + + - `is_redeploy: optional boolean or null` + + True when the publish updated an existing artifact; false when the publish created the artifact. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -8164,13 +7944,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "audit_log_export_accessed"` + - `type: optional "claude_artifact_published"` - default: audit_log_export_accessed + default: claude_artifact_published - - `AuditLogExportStarted object` + - `ClaudeArtifactSharingUpdated object` - Audit log export was initiated. + An artifact's sharing settings were updated. - `actor: object or object or object or 8 more` @@ -8383,6 +8163,43 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `audience: array of object or object or object` + + Sharing audience for the project. If empty, this it's only visible to the creating user. + + - `ArtifactSharingAudienceOrganization object` + + Sharing audience: visible to the owning organization. + + - `type: optional "organization"` + + default: organization + + - `ArtifactSharingAudienceUsers object` + + Sharing audience: visible to an explicit allowlist of users. + + - `type: optional "users"` + + default: users + + - `ArtifactSharingAudienceAnyoneWithLink object` + + Sharing audience: anyone with the link, including anonymous viewers + (an artifact shared to the open internet). + + - `type: optional "anyone_with_link"` + + default: anyone_with_link + + - `claude_artifact_id: string` + + The artifact's identifier. + + - `claude_artifact_version_id: string` + + The artifact version's identifier. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -8393,9 +8210,21 @@ compliance activities that can be filtered by various criteria. format: date-time - - `from_date: optional string or null` + - `new_mode: optional string or null` - Start date of the export range + The read-axis sharing mode after the change: `owner`, `users`, or `org`. + + - `new_user_count: optional number or null` + + The number of accounts on the explicit read allowlist after the change. Only meaningful when `new_mode` is `users`. + + - `new_write_mode: optional string or null` + + The write-axis sharing mode after the change: `owner`, `users`, or `org`. + + - `new_write_user_count: optional number or null` + + The number of accounts on the explicit write allowlist after the change. Only meaningful when `new_write_mode` is `users`. - `organization_id: optional string or null` @@ -8405,17 +8234,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `to_date: optional string or null` + - `previous_mode: optional string or null` - End date of the export range + The read-axis sharing mode before the change: `owner`, `users`, or `org`. - - `type: optional "audit_log_export_started"` + - `previous_user_count: optional number or null` - default: audit_log_export_started + The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`. - - `BillingEmailsUpdated object` + - `previous_write_mode: optional string or null` - The organization's billing email recipients were updated. + The write-axis sharing mode before the change: `owner`, `users`, or `org`. + + - `previous_write_user_count: optional number or null` + + The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`. + + - `type: optional "claude_artifact_sharing_updated"` + + default: claude_artifact_sharing_updated + + - `ClaudeArtifactViewed object` + + An artifact was viewed. - `actor: object or object or object or 8 more` @@ -8628,13 +8469,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_artifact_id: string` + + The artifact's identifier. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cc_email_count: optional number or null` + - `claude_artifact_version_id: optional string or null` - Number of 'cc' email recipients. + The version of the artifact the user was served, when known. - `created_at: optional string` @@ -8650,21 +8495,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `primary_email_set: optional boolean or null` - - Whether a primary billing email is configured. - - - `to_email_count: optional number or null` - - Number of 'to' email recipients. - - - `type: optional "billing_emails_updated"` + - `type: optional "claude_artifact_viewed"` - default: billing_emails_updated + default: claude_artifact_viewed - - `CcrAgentCreated object` + - `AuditLogExportAccessed object` - A Claude Code agent was created. + Audit log export file was accessed/downloaded via signed URL. - `actor: object or object or object or 8 more` @@ -8877,26 +8714,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was created, e.g. "cagt_01HX...". - - - `default_source_urls_truncated: boolean` - - Whether default_source_urls was capped and omits some of the granted repositories. - - - `display_name: string` - - The agent's display name at creation time. - - - `omitted_source_url_count: number` - - Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. - - - `slug: string` - - The agent's URL-safe identifier, unique within the organization. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -8907,14 +8724,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_source_urls: optional array of string` - - The repository URLs the agent works on by default, reduced to scheme, host, and path — credentials and query parameters are never included. Empty with a zero omitted_source_url_count means the agent was created without any default repositories; empty with a non-zero count means repositories were granted but could not be safely rendered. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - - - `guest_policy: optional string or null` - - Whether the agent responds in Slack channels that include guest users: "allow", "restrict", or "channel" (the agent responds, using only that channel's own content and configuration). Omitted when the agent inherits the default policy. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -8923,17 +8732,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `slack_alias: optional string or null` - - The Slack trigger word that routes mentions to this agent. An empty value means the agent responds to bare "@Claude" mentions. Omitted when the agent is not addressable from Slack. - - - `type: optional "ccr_agent_created"` + - `type: optional "audit_log_export_accessed"` - default: ccr_agent_created + default: audit_log_export_accessed - - `CcrAgentDeleted object` + - `AuditLogExportStarted object` - A Claude Code agent was deleted. + Audit log export was initiated. - `actor: object or object or object or 8 more` @@ -9146,32 +8951,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was deleted, e.g. "cagt_01HX...". - - - `cascaded_agent_ids_truncated: boolean` - - True when more agents were deleted in this cascade than are individually recorded. On a cascade parent event (cascaded_from_agent_id unset), cascaded_agent_ids is capped at 100. On a cascade child event (cascaded_from_agent_id set, emitted when the parent deletion failed after committing child deletions), one event is emitted per deleted child up to 100, and this field indicates additional children were deleted in the same cascade. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascaded_agent_ids: optional array of string` - - Agents assigned to individual Slack channels that were also deleted because agent_id was the agent assigned to their entire Slack workspace. Empty when no such agents were deleted, and always empty on a cascade child event (cascaded_from_agent_id set) — the child's siblings are recorded as their own events, not listed here. Capped at 100 entries; cascaded_agent_ids_truncated is set when the actual count exceeded the cap. - - - `cascaded_from_agent_id: optional string or null` - - When set, the Slack workspace's dedicated agent whose deletion attempt caused this agent to be deleted. The parent's own deletion may have failed after the cascade committed — check for a separate event with agent_id = cascaded_from_agent_id to confirm. Unset on a direct deletion. - - `created_at: optional string` When this activity occurred. format: date-time + - `from_date: optional string or null` + + Start date of the export range + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -9180,13 +8973,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_deleted"` + - `to_date: optional string or null` - default: ccr_agent_deleted + End date of the export range - - `CcrAgentProxyCredentialCreated object` + - `type: optional "audit_log_export_started"` - A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself. + default: audit_log_export_started + + - `BillingEmailsUpdated object` + + The organization's billing email recipients were updated. - `actor: object or object or object or 8 more` @@ -9399,57 +9196,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential that was created, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - - - `display_name: string` - - The credential's display name. - - - `host_constraint_truncated: boolean` - - Whether host_constraint was capped and omits some of the configured host name patterns. - - - `profile_id: string` - - The agent proxy profile the credential belongs to, e.g. "capp_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `authorization_basis: optional object or null` - - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - - - `slack_channel_id: string` - - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - - - `slack_enterprise_id: string` - - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. - - - `slack_team_id: string` - - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". - - - `via_entitlement_leg: boolean` - - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. - - - `via_full_manage: boolean` - - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. - - - `granting_role_ids: optional array of string` + - `cc_email_count: optional number or null` - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + Number of 'cc' email recipients. - `created_at: optional string` @@ -9457,10 +9210,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `host_constraint: optional array of string` - - The host name patterns the credential may be sent to, e.g. "api.example.com" or "*.example.com". At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -9469,13 +9218,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_created"` + - `primary_email_set: optional boolean or null` - default: ccr_agent_proxy_credential_created + Whether a primary billing email is configured. - - `CcrAgentProxyCredentialDeleted object` + - `to_email_count: optional number or null` - A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host. + Number of 'to' email recipients. + + - `type: optional "billing_emails_updated"` + + default: billing_emails_updated + + - `CcrAgentCreated object` + + A Claude Code agent was created. - `actor: object or object or object or 8 more` @@ -9688,51 +9445,43 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential that was deleted, e.g. "apc_01HX...". - - - `profile_id: string` - - The agent proxy profile the credential belonged to, e.g. "capp_01HX...". Carried so the deletion can be correlated with the profile's other audit events after the credential row no longer exists. - - - `id: optional string` + - `agent_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The agent that was created, e.g. "cagt_01HX...". - - `authorization_basis: optional object or null` + - `default_source_urls_truncated: boolean` - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + Whether default_source_urls was capped and omits some of the granted repositories. - - `slack_channel_id: string` + - `display_name: string` - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + The agent's display name at creation time. - - `slack_enterprise_id: string` + - `omitted_source_url_count: number` - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. - - `slack_team_id: string` + - `slug: string` - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + The agent's URL-safe identifier, unique within the organization. - - `via_entitlement_leg: boolean` + - `id: optional string` - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `via_full_manage: boolean` + - `created_at: optional string` - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + When this activity occurred. - - `granting_role_ids: optional array of string` + format: date-time - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + - `default_source_urls: optional array of string` - - `created_at: optional string` + The repository URLs the agent works on by default, reduced to scheme, host, and path — credentials and query parameters are never included. Empty with a zero omitted_source_url_count means the agent was created without any default repositories; empty with a non-zero count means repositories were granted but could not be safely rendered. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - When this activity occurred. + - `guest_policy: optional string or null` - format: date-time + Whether the agent responds in Slack channels that include guest users, and in Slack Connect channels shared with other organizations: "allow", "restrict", or "channel" (the agent responds, using only that channel's own content and configuration). In Slack Connect channels "allow" gives at most "channel" access. Omitted when the agent inherits the default policy. - `organization_id: optional string or null` @@ -9742,13 +9491,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_deleted"` + - `slack_alias: optional string or null` - default: ccr_agent_proxy_credential_deleted + The Slack trigger word that routes mentions to this agent. An empty value means the agent responds to bare "@Claude" mentions. Omitted when the agent is not addressable from Slack. - - `CcrAgentProxyCredentialRotated object` + - `type: optional "ccr_agent_created"` - A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement. + default: ccr_agent_created + + - `CcrAgentDeleted object` + + A Claude Code agent was deleted. - `actor: object or object or object or 8 more` @@ -9961,65 +9714,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The replacement credential, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - - - `destinations_repointed: number` - - The number of agent proxy destinations that referenced the old credential and now reference the replacement. - - - `display_name: string` - - The credential's display name. - - - `previous_credential_id: string` - - The credential that was replaced, e.g. "apc_01HX...". - - - `profile_id: string` + - `agent_id: string` - The agent proxy profile the credential belongs to, e.g. "capp_01HX...". + The agent that was deleted, e.g. "cagt_01HX...". - - `rules_repointed: number` + - `cascaded_agent_ids_truncated: boolean` - The number of agent proxy rules that referenced the old credential and now reference the replacement. + True when more agents were deleted in this cascade than are individually recorded. On a cascade parent event (cascaded_from_agent_id unset), cascaded_agent_ids is capped at 100. On a cascade child event (cascaded_from_agent_id set, emitted when the parent deletion failed after committing child deletions), one event is emitted per deleted child up to 100, and this field indicates additional children were deleted in the same cascade. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `authorization_basis: optional object or null` - - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - - - `slack_channel_id: string` - - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - - - `slack_enterprise_id: string` - - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. - - - `slack_team_id: string` - - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". - - - `via_entitlement_leg: boolean` - - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. - - - `via_full_manage: boolean` + - `cascaded_agent_ids: optional array of string` - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + Agents assigned to individual Slack channels that were also deleted because agent_id was the agent assigned to their entire Slack workspace. Empty when no such agents were deleted, and always empty on a cascade child event (cascaded_from_agent_id set) — the child's siblings are recorded as their own events, not listed here. Capped at 100 entries; cascaded_agent_ids_truncated is set when the actual count exceeded the cap. - - `granting_role_ids: optional array of string` + - `cascaded_from_agent_id: optional string or null` - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + When set, the Slack workspace's dedicated agent whose deletion attempt caused this agent to be deleted. The parent's own deletion may have failed after the cascade committed — check for a separate event with agent_id = cascaded_from_agent_id to confirm. Unset on a direct deletion. - `created_at: optional string` @@ -10035,13 +9748,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_rotated"` + - `type: optional "ccr_agent_deleted"` - default: ccr_agent_proxy_credential_rotated + default: ccr_agent_deleted - - `CcrAgentProxyCredentialUpdated object` + - `CcrAgentProxyCredentialCreated object` - A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation. + A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself. - `actor: object or object or object or 8 more` @@ -10256,11 +9969,15 @@ compliance activities that can be filtered by various criteria. - `credential_id: string` - The credential that was updated, e.g. "apc_01HX...". + The credential that was created, e.g. "apc_01HX...". + + - `credential_type: string` + + The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - `display_name: string` - The credential's display name after the update. + The credential's display name. - `host_constraint_truncated: boolean` @@ -10310,7 +10027,7 @@ compliance activities that can be filtered by various criteria. - `host_constraint: optional array of string` - The host name patterns the credential may be sent to after the update, e.g. "api.example.com" or "*.example.com". Populated only when the update changed them. At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. + The host name patterns the credential may be sent to, e.g. "api.example.com" or "*.example.com". At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. - `organization_id: optional string or null` @@ -10320,17 +10037,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_updated"` - - default: ccr_agent_proxy_credential_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_proxy_credential_created"` - Names of the settings included in the update: "display_name", "host_constraint". + default: ccr_agent_proxy_credential_created - - `CcrAgentProxyDestinationDeleted object` + - `CcrAgentProxyCredentialDeleted object` - An agent proxy destination was deleted. + A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host. - `actor: object or object or object or 8 more` @@ -10543,25 +10256,45 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_with_profile: boolean` - - True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyDestination call. - - - `destination_id: string` + - `credential_id: string` - The destination that was deleted, e.g. "apd_01HX...". + The credential that was deleted, e.g. "apc_01HX...". - `profile_id: string` - The agent proxy profile the destination belonged to, e.g. "capp_01HX...". + The agent proxy profile the credential belonged to, e.g. "capp_01HX...". Carried so the deletion can be correlated with the profile's other audit events after the credential row no longer exists. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascade_trigger_credential_id: optional string or null` + - `authorization_basis: optional object or null` - Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the destination's client_tls_credential was the deleted credential). Unset for a direct DeleteAgentProxyDestination call and for the profile-delete cascade (see deleted_with_profile). + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + + - `slack_channel_id: string` + + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). - `created_at: optional string` @@ -10577,13 +10310,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_destination_deleted"` + - `type: optional "ccr_agent_proxy_credential_deleted"` - default: ccr_agent_proxy_destination_deleted + default: ccr_agent_proxy_credential_deleted - - `CcrAgentProxyNetworkEventsListed object` + - `CcrAgentProxyCredentialRotated object` - A Claude Code network activity export was accessed for the given hour. + A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement. - `actor: object or object or object or 8 more` @@ -10796,23 +10529,69 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `failed: boolean` + - `credential_id: string` - True when the export request did not complete successfully. + The replacement credential, e.g. "apc_01HX...". + + - `credential_type: string` + + The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". + + - `destinations_repointed: number` + + The number of agent proxy destinations that referenced the old credential and now reference the replacement. + + - `display_name: string` + + The credential's display name. + + - `previous_credential_id: string` + + The credential that was replaced, e.g. "apc_01HX...". + + - `profile_id: string` + + The agent proxy profile the credential belongs to, e.g. "capp_01HX...". + + - `rules_repointed: number` + + The number of agent proxy rules that referenced the old credential and now reference the replacement. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `created_at: optional string` + - `authorization_basis: optional object or null` - When this activity occurred. + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - format: date-time + - `slack_channel_id: string` - - `hour: optional string or null` + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - The UTC hour that was exported. + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + + - `created_at: optional string` + + When this activity occurred. format: date-time @@ -10824,13 +10603,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_network_events_listed"` + - `type: optional "ccr_agent_proxy_credential_rotated"` - default: ccr_agent_proxy_network_events_listed + default: ccr_agent_proxy_credential_rotated - - `CcrAgentProxyProfileBound object` + - `CcrAgentProxyCredentialUpdated object` - A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope. + A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation. - `actor: object or object or object or 8 more` @@ -11043,28 +10822,64 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `profile_id: string` + - `credential_id: string` - The profile that was bound, e.g. "capp_01HX...". + The credential that was updated, e.g. "apc_01HX...". - - `scope_id: string` + - `display_name: string` - The identifier of the scope the profile was bound to. + The credential's display name after the update. - - `scope_kind: string` + - `host_constraint_truncated: boolean` - The kind of scope the profile was bound to: "organization", "environment", "account", or "agent". + Whether host_constraint was capped and omits some of the configured host name patterns. + + - `profile_id: string` + + The agent proxy profile the credential belongs to, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `authorization_basis: optional object or null` + + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + + - `slack_channel_id: string` + + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + - `created_at: optional string` When this activity occurred. format: date-time + - `host_constraint: optional array of string` + + The host name patterns the credential may be sent to after the update, e.g. "api.example.com" or "*.example.com". Populated only when the update changed them. At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11073,13 +10888,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_bound"` + - `type: optional "ccr_agent_proxy_credential_updated"` - default: ccr_agent_proxy_profile_bound + default: ccr_agent_proxy_credential_updated - - `CcrAgentProxyProfileCreated object` + - `updated_fields: optional array of string` - A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization. + Names of the settings included in the update: "display_name", "host_constraint". + + - `CcrAgentProxyDestinationDeleted object` + + An agent proxy destination was deleted. - `actor: object or object or object or 8 more` @@ -11292,60 +11111,32 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` + - `deleted_with_profile: boolean` - The profile's display name at creation time. + True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyDestination call. - - `profile_id: string` + - `destination_id: string` - The profile that was created, e.g. "capp_01HX...". + The destination that was deleted, e.g. "apd_01HX...". - - `slug: string` + - `profile_id: string` - The profile's URL-safe identifier, unique within the organization. + The agent proxy profile the destination belonged to, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `cascade_trigger_credential_id: optional string or null` + + Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the destination's client_tls_credential was the deleted credential). Unset for a direct DeleteAgentProxyDestination call and for the profile-delete cascade (see deleted_with_profile). + - `created_at: optional string` When this activity occurred. format: date-time - - `github_access: optional array of object` - - The GitHub repository access the profile grants, one entry per GitHub App installation. Empty when the profile grants no GitHub access. - - - `access_mode: string` - - How repository access is granted: "none" (no access), "list" (exactly the repositories in repos), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. - - - `github_installation_id: number` - - The GitHub App installation the access applies to. - - - `repo_count: number` - - The total number of repositories granted, including any omitted from repos. - - - `repos_truncated: boolean` - - Whether repos was capped and omits some of the granted repositories. - - - `ghe_configuration_id: optional number or null` - - The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. - - - `repo_ids: optional array of number` - - The numeric GitHub repository IDs the profile grants access to, in the same order as repos (and subject to the same 100-entry cap). These IDs are the authoritative identity of the granted repositories — access is enforced against them, not against the display names in repos. - - - `repos: optional array of string` - - Repository names (owner/name) the profile grants access to, populated when access_mode is "list". Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids are the authoritative identity of the granted repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when the granted set is larger. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11354,13 +11145,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_created"` + - `type: optional "ccr_agent_proxy_destination_deleted"` - default: ccr_agent_proxy_profile_created + default: ccr_agent_proxy_destination_deleted - - `CcrAgentProxyProfileDeleted object` + - `CcrAgentProxyNetworkEventsListed object` - A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to. + A Claude Code network activity export was accessed for the given hour. - `actor: object or object or object or 8 more` @@ -11573,33 +11364,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_credential_count: number` - - Number of credentials deleted together with the profile — deleting a profile also deletes the credentials attached to it. Each deleted credential additionally emits its own ccr_agent_proxy_credential_deleted activity, at most 100 per profile deletion. Best-effort: when deleted_credentials_unknown is true the count could not be determined and 0 here does not mean the profile had no credentials. - - - `deleted_credentials_unknown: boolean` - - Whether the number of credentials deleted with the profile could not be determined. When true, deleted_credential_count is 0 and no per-credential deletion activities were emitted, even though the deletion may have destroyed credentials. - - - `deleted_destination_count: number` - - Number of destinations deleted together with the profile. Each deleted destination additionally emits its own ccr_agent_proxy_destination_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_destinations_unknown is true the count could not be determined and 0 here does not mean the profile had no destinations. - - - `deleted_destinations_unknown: boolean` - - Whether the number of destinations deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - - `deleted_rule_count: number` - - Number of rules deleted together with the profile. Each deleted rule additionally emits its own ccr_agent_proxy_rule_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_rules_unknown is true the count could not be determined and 0 here does not mean the profile had no rules. - - - `deleted_rules_unknown: boolean` - - Whether the number of rules deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - - `profile_id: string` + - `failed: boolean` - The profile that was deleted, e.g. "capp_01HX...". + True when the export request did not complete successfully. - `id: optional string` @@ -11611,6 +11378,12 @@ compliance activities that can be filtered by various criteria. format: date-time + - `hour: optional string or null` + + The UTC hour that was exported. + + format: date-time + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11619,13 +11392,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_deleted"` + - `type: optional "ccr_agent_proxy_network_events_listed"` - default: ccr_agent_proxy_profile_deleted + default: ccr_agent_proxy_network_events_listed - - `CcrAgentProxyProfileUnbound object` + - `CcrAgentProxyProfileBound object` - A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope. + A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope. - `actor: object or object or object or 8 more` @@ -11840,15 +11613,15 @@ compliance activities that can be filtered by various criteria. - `profile_id: string` - The profile that was unbound, e.g. "capp_01HX...". + The profile that was bound, e.g. "capp_01HX...". - `scope_id: string` - The identifier of the scope the profile was unbound from. + The identifier of the scope the profile was bound to. - `scope_kind: string` - The kind of scope the profile was unbound from: "organization", "environment", "account", or "agent". + The kind of scope the profile was bound to: "organization", "environment", "account", or "agent". - `id: optional string` @@ -11868,13 +11641,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_unbound"` + - `type: optional "ccr_agent_proxy_profile_bound"` - default: ccr_agent_proxy_profile_unbound + default: ccr_agent_proxy_profile_bound - - `CcrAgentProxyProfileUpdated object` + - `CcrAgentProxyProfileCreated object` - A Claude Code agent proxy profile's configuration was updated. + A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization. - `actor: object or object or object or 8 more` @@ -12087,9 +11860,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `display_name: string` + + The profile's display name at creation time. + - `profile_id: string` - The profile that was updated, e.g. "capp_01HX...". + The profile that was created, e.g. "capp_01HX...". + + - `slug: string` + + The profile's URL-safe identifier, unique within the organization. - `id: optional string` @@ -12101,49 +11882,37 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_access_changes: optional array of object` + - `github_access: optional array of object` - How the profile's GitHub repository access changed, one entry per GitHub App installation whose access changed. Empty when the update did not change GitHub access. + The GitHub repository access the profile grants, one entry per GitHub App installation. Empty when the profile grants no GitHub access. - `access_mode: string` - How repository access is granted after the change: "none" (no access), "list" (access is restricted to an explicit repository list — repos_added/repos_removed carry this change's delta and repo_count the post-change total), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. + How repository access is granted: "none" (no access), "list" (exactly the repositories in repos), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. - `github_installation_id: number` - The GitHub App installation the change applies to. + The GitHub App installation the access applies to. - `repo_count: number` - The total number of repositories granted after the change. + The total number of repositories granted, including any omitted from repos. - `repos_truncated: boolean` - Whether repos_added or repos_removed was capped and omits some of the changed repositories. + Whether repos was capped and omits some of the granted repositories. - `ghe_configuration_id: optional number or null` The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. - - `previous_access_mode: optional string or null` - - How repository access was granted before the change. Present only when the access mode changed. - - - `repo_ids_added: optional array of number` - - The numeric GitHub repository IDs added to the granted set, in the same order as repos_added (and subject to the same 100-entry cap). These IDs are the authoritative identity of the added repositories — access is enforced against them, not against the display names in repos_added. - - - `repo_ids_removed: optional array of number` - - The numeric GitHub repository IDs removed from the granted set, in the same order as repos_removed (and subject to the same 100-entry cap). These IDs are the authoritative identity of the removed repositories. - - - `repos_added: optional array of string` + - `repo_ids: optional array of number` - Repository names (owner/name) added to the granted set. Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids_added are the authoritative identity of the added repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when more were added. Empty when the change involves "all" access, which grants every repository regardless of any explicit list. + The numeric GitHub repository IDs the profile grants access to, in the same order as repos (and subject to the same 100-entry cap). These IDs are the authoritative identity of the granted repositories — access is enforced against them, not against the display names in repos. - - `repos_removed: optional array of string` + - `repos: optional array of string` - Repository names (owner/name) removed from the granted set. Same rendering, cap, and "all" handling as repos_added; repo_ids_removed carries the authoritative identity of the removed repositories. + Repository names (owner/name) the profile grants access to, populated when access_mode is "list". Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids are the authoritative identity of the granted repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when the granted set is larger. - `organization_id: optional string or null` @@ -12153,17 +11922,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_updated"` - - default: ccr_agent_proxy_profile_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_proxy_profile_created"` - Names of the configuration fields included in the update, e.g. "display_name", "github_installation_permissions". + default: ccr_agent_proxy_profile_created - - `CcrAgentProxyProvisioningCredentialRejected object` + - `CcrAgentProxyProfileDeleted object` - An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution. + A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to. - `actor: object or object or object or 8 more` @@ -12376,25 +12141,33 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` + - `deleted_credential_count: number` - The credential the member submitted, e.g. "apc_01HX...". + Number of credentials deleted together with the profile — deleting a profile also deletes the credentials attached to it. Each deleted credential additionally emits its own ccr_agent_proxy_credential_deleted activity, at most 100 per profile deletion. Best-effort: when deleted_credentials_unknown is true the count could not be determined and 0 here does not mean the profile had no credentials. - - `link_id: string` + - `deleted_credentials_unknown: boolean` - The provisioning link's identifier. + Whether the number of credentials deleted with the profile could not be determined. When true, deleted_credential_count is 0 and no per-credential deletion activities were emitted, even though the deletion may have destroyed credentials. - - `profile_id: string` + - `deleted_destination_count: number` - The agent proxy profile the credential lived in, e.g. "capp_01HX...". + Number of destinations deleted together with the profile. Each deleted destination additionally emits its own ccr_agent_proxy_destination_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_destinations_unknown is true the count could not be determined and 0 here does not mean the profile had no destinations. - - `rule_id: string` + - `deleted_destinations_unknown: boolean` - The disabled rule that was deleted alongside the credential, e.g. "apr_01HX...". + Whether the number of destinations deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - `submitted_by_user_id: string` + - `deleted_rule_count: number` - The tagged account ID of the user who originally submitted the credential, e.g. "user_01HX...". + Number of rules deleted together with the profile. Each deleted rule additionally emits its own ccr_agent_proxy_rule_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_rules_unknown is true the count could not be determined and 0 here does not mean the profile had no rules. + + - `deleted_rules_unknown: boolean` + + Whether the number of rules deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. + + - `profile_id: string` + + The profile that was deleted, e.g. "capp_01HX...". - `id: optional string` @@ -12414,13 +12187,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_credential_rejected"` + - `type: optional "ccr_agent_proxy_profile_deleted"` - default: ccr_agent_proxy_provisioning_credential_rejected + default: ccr_agent_proxy_profile_deleted - - `CcrAgentProxyProvisioningLinkEnabled object` + - `CcrAgentProxyProfileUnbound object` - An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event. + A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope. - `actor: object or object or object or 8 more` @@ -12633,21 +12406,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential the member submitted, e.g. "apc_01HX...". - - - `link_id: string` + - `profile_id: string` - The provisioning link's identifier. + The profile that was unbound, e.g. "capp_01HX...". - - `profile_id: string` + - `scope_id: string` - The agent proxy profile the credential lives in, e.g. "capp_01HX...". + The identifier of the scope the profile was unbound from. - - `rule_id: string` + - `scope_kind: string` - The rule that was flipped to enforce, e.g. "apr_01HX...". + The kind of scope the profile was unbound from: "organization", "environment", "account", or "agent". - `id: optional string` @@ -12667,13 +12436,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_enabled"` + - `type: optional "ccr_agent_proxy_profile_unbound"` - default: ccr_agent_proxy_provisioning_link_enabled + default: ccr_agent_proxy_profile_unbound - - `CcrAgentProxyProvisioningLinkGenerated object` + - `CcrAgentProxyProfileUpdated object` - An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role. + A Claude Code agent proxy profile's configuration was updated. - `actor: object or object or object or 8 more` @@ -12886,13 +12655,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `link_id: string` - - The provisioning link's identifier. Correlation only; redemption requires an org-member session, so this is not a bearer credential. - - `profile_id: string` - The agent proxy profile the submitted credential will be created in, e.g. "capp_01HX...". + The profile that was updated, e.g. "capp_01HX...". - `id: optional string` @@ -12904,6 +12669,50 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_access_changes: optional array of object` + + How the profile's GitHub repository access changed, one entry per GitHub App installation whose access changed. Empty when the update did not change GitHub access. + + - `access_mode: string` + + How repository access is granted after the change: "none" (no access), "list" (access is restricted to an explicit repository list — repos_added/repos_removed carry this change's delta and repo_count the post-change total), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. + + - `github_installation_id: number` + + The GitHub App installation the change applies to. + + - `repo_count: number` + + The total number of repositories granted after the change. + + - `repos_truncated: boolean` + + Whether repos_added or repos_removed was capped and omits some of the changed repositories. + + - `ghe_configuration_id: optional number or null` + + The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. + + - `previous_access_mode: optional string or null` + + How repository access was granted before the change. Present only when the access mode changed. + + - `repo_ids_added: optional array of number` + + The numeric GitHub repository IDs added to the granted set, in the same order as repos_added (and subject to the same 100-entry cap). These IDs are the authoritative identity of the added repositories — access is enforced against them, not against the display names in repos_added. + + - `repo_ids_removed: optional array of number` + + The numeric GitHub repository IDs removed from the granted set, in the same order as repos_removed (and subject to the same 100-entry cap). These IDs are the authoritative identity of the removed repositories. + + - `repos_added: optional array of string` + + Repository names (owner/name) added to the granted set. Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids_added are the authoritative identity of the added repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when more were added. Empty when the change involves "all" access, which grants every repository regardless of any explicit list. + + - `repos_removed: optional array of string` + + Repository names (owner/name) removed from the granted set. Same rendering, cap, and "all" handling as repos_added; repo_ids_removed carries the authoritative identity of the removed repositories. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -12912,13 +12721,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_generated"` + - `type: optional "ccr_agent_proxy_profile_updated"` - default: ccr_agent_proxy_provisioning_link_generated + default: ccr_agent_proxy_profile_updated - - `CcrAgentProxyProvisioningLinkRevoked object` + - `updated_fields: optional array of string` - An organization owner revoked an unfilled agent proxy provisioning link. + Names of the configuration fields included in the update, e.g. "display_name", "github_installation_permissions". + + - `CcrAgentProxyProvisioningCredentialRejected object` + + An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution. - `actor: object or object or object or 8 more` @@ -13131,13 +12944,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `credential_id: string` + + The credential the member submitted, e.g. "apc_01HX...". + - `link_id: string` The provisioning link's identifier. - `profile_id: string` - The agent proxy profile the link targeted, e.g. "capp_01HX...". + The agent proxy profile the credential lived in, e.g. "capp_01HX...". + + - `rule_id: string` + + The disabled rule that was deleted alongside the credential, e.g. "apr_01HX...". + + - `submitted_by_user_id: string` + + The tagged account ID of the user who originally submitted the credential, e.g. "user_01HX...". - `id: optional string` @@ -13157,13 +12982,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_revoked"` + - `type: optional "ccr_agent_proxy_provisioning_credential_rejected"` - default: ccr_agent_proxy_provisioning_link_revoked + default: ccr_agent_proxy_provisioning_credential_rejected - - `CcrAgentProxyProvisioningLinkSubmitted object` + - `CcrAgentProxyProvisioningLinkEnabled object` - A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created. + An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event. - `actor: object or object or object or 8 more` @@ -13378,11 +13203,7 @@ compliance activities that can be filtered by various criteria. - `credential_id: string` - The credential that was created, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer" or "basic". + The credential the member submitted, e.g. "apc_01HX...". - `link_id: string` @@ -13390,7 +13211,11 @@ compliance activities that can be filtered by various criteria. - `profile_id: string` - The agent proxy profile the credential was created in, e.g. "capp_01HX...". + The agent proxy profile the credential lives in, e.g. "capp_01HX...". + + - `rule_id: string` + + The rule that was flipped to enforce, e.g. "apr_01HX...". - `id: optional string` @@ -13402,10 +13227,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `host_constraint: optional array of string` - - The host name patterns the credential may be sent to. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -13414,13 +13235,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_submitted"` + - `type: optional "ccr_agent_proxy_provisioning_link_enabled"` - default: ccr_agent_proxy_provisioning_link_submitted + default: ccr_agent_proxy_provisioning_link_enabled - - `CcrAgentProxyRuleDeleted object` + - `CcrAgentProxyProvisioningLinkGenerated object` - An agent proxy rule was deleted. + An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role. - `actor: object or object or object or 8 more` @@ -13633,26 +13454,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_with_profile: boolean` + - `link_id: string` - True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyRule call or a provisioning-link reject (RejectAgentProxyProvisionedCredential) — the reject case also emits CcrAgentProxyProvisioningCredentialRejected with the same rule_id in the same batch. + The provisioning link's identifier. Correlation only; redemption requires an org-member session, so this is not a bearer credential. - `profile_id: string` - The agent proxy profile the rule belonged to, e.g. "capp_01HX...". - - - `rule_id: string` - - The rule that was deleted, e.g. "apr_01HX...". + The agent proxy profile the submitted credential will be created in, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascade_trigger_credential_id: optional string or null` - - Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the rule inject_credential-referenced the deleted credential). Unset for a direct DeleteAgentProxyRule call, for the profile-delete cascade (see deleted_with_profile), and for a provisioning-link reject that removed the provisioned rule. - - `created_at: optional string` When this activity occurred. @@ -13667,13 +13480,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_rule_deleted"` + - `type: optional "ccr_agent_proxy_provisioning_link_generated"` - default: ccr_agent_proxy_rule_deleted + default: ccr_agent_proxy_provisioning_link_generated - - `CcrAgentSlackAccessScopeCreated object` + - `CcrAgentProxyProvisioningLinkRevoked object` - A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to. + An organization owner revoked an unfilled agent proxy provisioning link. - `actor: object or object or object or 8 more` @@ -13886,21 +13699,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was granted access, e.g. "cagt_01HX...". - - - `can_write: boolean` - - Whether the grant includes permission to post messages in the channel, in addition to reading it. - - - `slack_channel_id: string` + - `link_id: string` - The Slack channel the agent was granted access to, e.g. "C01ABC...". Empty when the grant covers the entire workspace. + The provisioning link's identifier. - - `slack_team_id: string` + - `profile_id: string` - The Slack workspace containing the channel, e.g. "T01ABC...". + The agent proxy profile the link targeted, e.g. "capp_01HX...". - `id: optional string` @@ -13920,13 +13725,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_access_scope_created"` + - `type: optional "ccr_agent_proxy_provisioning_link_revoked"` - default: ccr_agent_slack_access_scope_created + default: ccr_agent_proxy_provisioning_link_revoked - - `CcrAgentSlackAccessScopeDeleted object` + - `CcrAgentProxyProvisioningLinkSubmitted object` - A Claude Code agent's access to an additional Slack channel was revoked. + A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created. - `actor: object or object or object or 8 more` @@ -14139,17 +13944,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `credential_id: string` - The agent whose access was revoked, e.g. "cagt_01HX...". + The credential that was created, e.g. "apc_01HX...". - - `slack_channel_id: string` + - `credential_type: string` - The Slack channel the agent's access was revoked from, e.g. "C01ABC...". Empty when the revoked grant covered the entire workspace. + The kind of credential, e.g. "bearer" or "basic". - - `slack_team_id: string` + - `link_id: string` - The Slack workspace containing the channel, e.g. "T01ABC...". + The provisioning link's identifier. + + - `profile_id: string` + + The agent proxy profile the credential was created in, e.g. "capp_01HX...". - `id: optional string` @@ -14161,6 +13970,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `host_constraint: optional array of string` + + The host name patterns the credential may be sent to. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -14169,13 +13982,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_access_scope_deleted"` + - `type: optional "ccr_agent_proxy_provisioning_link_submitted"` - default: ccr_agent_slack_access_scope_deleted + default: ccr_agent_proxy_provisioning_link_submitted - - `CcrAgentSlackBindingCreated object` + - `CcrAgentProxyRuleDeleted object` - A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent. + An agent proxy rule was deleted. - `actor: object or object or object or 8 more` @@ -14388,22 +14201,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deleted_with_profile: boolean` - The agent the binding was created for, e.g. "cagt_01HX...". + True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyRule call or a provisioning-link reject (RejectAgentProxyProvisionedCredential) — the reject case also emits CcrAgentProxyProvisioningCredentialRejected with the same rule_id in the same batch. - - `slack_channel_id: string` + - `profile_id: string` - The Slack channel the agent was assigned to, e.g. "C01ABC...". Empty when the agent was assigned to the entire workspace. + The agent proxy profile the rule belonged to, e.g. "capp_01HX...". - - `slack_team_id: string` + - `rule_id: string` - The Slack workspace the agent was assigned to, e.g. "T01ABC...". + The rule that was deleted, e.g. "apr_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `cascade_trigger_credential_id: optional string or null` + + Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the rule inject_credential-referenced the deleted credential). Unset for a direct DeleteAgentProxyRule call, for the profile-delete cascade (see deleted_with_profile), and for a provisioning-link reject that removed the provisioned rule. + - `created_at: optional string` When this activity occurred. @@ -14418,13 +14235,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_binding_created"` + - `type: optional "ccr_agent_proxy_rule_deleted"` - default: ccr_agent_slack_binding_created + default: ccr_agent_proxy_rule_deleted - - `CcrAgentSlackBindingDeleted object` + - `CcrAgentSlackAccessScopeCreated object` - A Claude Code agent's assignment to a Slack channel or workspace was removed. + A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to. - `actor: object or object or object or 8 more` @@ -14639,15 +14456,19 @@ compliance activities that can be filtered by various criteria. - `agent_id: string` - The agent the binding was removed from, e.g. "cagt_01HX...". + The agent that was granted access, e.g. "cagt_01HX...". + + - `can_write: boolean` + + Whether the grant includes permission to post messages in the channel, in addition to reading it. - `slack_channel_id: string` - The Slack channel the agent was unassigned from, e.g. "C01ABC...". Empty when the assignment covered the entire workspace. + The Slack channel the agent was granted access to, e.g. "C01ABC...". Empty when the grant covers the entire workspace. - `slack_team_id: string` - The Slack workspace the agent was unassigned from, e.g. "T01ABC...". + The Slack workspace containing the channel, e.g. "T01ABC...". - `id: optional string` @@ -14667,13 +14488,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_binding_deleted"` + - `type: optional "ccr_agent_slack_access_scope_created"` - default: ccr_agent_slack_binding_deleted + default: ccr_agent_slack_access_scope_created - - `CcrAgentUpdated object` + - `CcrAgentSlackAccessScopeDeleted object` - A Claude Code agent's configuration was updated. Also emitted with updated_fields ["is_virtual"] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it. + A Claude Code agent's access to an additional Slack channel was revoked. - `actor: object or object or object or 8 more` @@ -14888,15 +14709,15 @@ compliance activities that can be filtered by various criteria. - `agent_id: string` - The agent that was updated, e.g. "cagt_01HX...". + The agent whose access was revoked, e.g. "cagt_01HX...". - - `default_source_urls_truncated: boolean` + - `slack_channel_id: string` - Whether default_source_urls was capped and omits some of the granted repositories. + The Slack channel the agent's access was revoked from, e.g. "C01ABC...". Empty when the revoked grant covered the entire workspace. - - `omitted_source_url_count: number` + - `slack_team_id: string` - Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. + The Slack workspace containing the channel, e.g. "T01ABC...". - `id: optional string` @@ -14908,14 +14729,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_source_urls: optional array of string` - - The agent's default repository URLs after the update, reduced to scheme, host, and path — credentials and query parameters are never included. Populated only when the update changed them — "default_source_urls" appears in updated_fields. Empty while listed in updated_fields AND omitted_source_url_count is 0 means all default repositories were removed. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - - - `guest_policy: optional string or null` - - The agent's guest-user response policy after the update: "allow", "restrict", "channel" (the agent responds, using only that channel's own content and configuration), or "default" when the update removed the agent-specific policy so the agent inherits the surrounding default. Present only when the update changed it. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -14924,21 +14737,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `slack_alias: optional string or null` - - The agent's Slack trigger word after the update. Present only when the update changed it. An empty value means the agent responds to bare "@Claude" mentions. - - - `type: optional "ccr_agent_updated"` - - default: ccr_agent_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_slack_access_scope_deleted"` - Names of the configuration fields included in the update, e.g. "display_name", "system_prompt_addendum", "guest_policy". Includes "is_virtual" when this update was the first administrator action on an auto-provisioned agent — a durable state change even when no other field was supplied. + default: ccr_agent_slack_access_scope_deleted - - `CcrRoleChannelAssignmentDeleted object` + - `CcrAgentSlackBindingCreated object` - CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels). + A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent. - `actor: object or object or object or 8 more` @@ -15151,13 +14956,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `previous_channel_count: number` + - `agent_id: string` - Number of (team, channel) pairs the role was assigned before deletion. + The agent the binding was created for, e.g. "cagt_01HX...". - - `role_id: string` + - `slack_channel_id: string` - Tagged ID of the role whose channel assignment was removed. + The Slack channel the agent was assigned to, e.g. "C01ABC...". Empty when the agent was assigned to the entire workspace. + + - `slack_team_id: string` + + The Slack workspace the agent was assigned to, e.g. "T01ABC...". - `id: optional string` @@ -15177,13 +14986,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_role_channel_assignment_deleted"` + - `type: optional "ccr_agent_slack_binding_created"` - default: ccr_role_channel_assignment_deleted + default: ccr_agent_slack_binding_created - - `CcrRoleChannelAssignmentUpdated object` + - `CcrAgentSlackBindingDeleted object` - CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface. + A Claude Code agent's assignment to a Slack channel or workspace was removed. - `actor: object or object or object or 8 more` @@ -15396,26 +15205,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `channel_count: number` + - `agent_id: string` - Number of channels assigned after the write. + The agent the binding was removed from, e.g. "cagt_01HX...". - - `previous_channel_count: number` + - `slack_channel_id: string` - Number of channels assigned before the write. + The Slack channel the agent was unassigned from, e.g. "C01ABC...". Empty when the assignment covered the entire workspace. - - `role_id: string` + - `slack_team_id: string` - Tagged ID of the role whose channel assignment was written. + The Slack workspace the agent was unassigned from, e.g. "T01ABC...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `agent_ids: optional array of string` - - The channel-silo agents (cagt_...) assigned after the write. Capped at 100 entries; channel_count carries the uncapped total. - - `created_at: optional string` When this activity occurred. @@ -15430,13 +15235,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_role_channel_assignment_updated"` + - `type: optional "ccr_agent_slack_binding_deleted"` - default: ccr_role_channel_assignment_updated + default: ccr_agent_slack_binding_deleted - - `CcrSessionCreated object` + - `CcrAgentUpdated object` - A Claude Code session was created. A session is one coding interaction with Claude. + A Claude Code agent's configuration was updated. Also emitted with updated_fields ["is_virtual"] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it. - `actor: object or object or object or 8 more` @@ -15649,17 +15454,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `agent_id: string` - The session that was created, e.g. "cse_01HX...". + The agent that was updated, e.g. "cagt_01HX...". - - `id: optional string` + - `default_source_urls_truncated: boolean` - Unique identifier for the activity e.g. 'activity_abcd1234' + Whether default_source_urls was capped and omits some of the granted repositories. - - `agent_id: optional string or null` + - `omitted_source_url_count: number` - The Claude Code agent attached to the session, e.g. "cagt_01HX...". Omitted when the session was created without an agent. + Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -15667,6 +15476,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `default_source_urls: optional array of string` + + The agent's default repository URLs after the update, reduced to scheme, host, and path — credentials and query parameters are never included. Populated only when the update changed them — "default_source_urls" appears in updated_fields. Empty while listed in updated_fields AND omitted_source_url_count is 0 means all default repositories were removed. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. + + - `guest_policy: optional string or null` + + The agent's response policy for Slack channels that include guest users and Slack Connect channels shared with other organizations, after the update: "allow", "restrict", "channel" (the agent responds, using only that channel's own content and configuration), or "default" when the update removed the agent-specific policy so the agent inherits the surrounding default. In Slack Connect channels "allow" gives at most "channel" access. Present only when the update changed it. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -15675,13 +15492,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_created"` + - `slack_alias: optional string or null` - default: ccr_session_created + The agent's Slack trigger word after the update. Present only when the update changed it. An empty value means the agent responds to bare "@Claude" mentions. - - `CcrSessionDeleted object` + - `type: optional "ccr_agent_updated"` - A Claude Code session was deleted. + default: ccr_agent_updated + + - `updated_fields: optional array of string` + + Names of the configuration fields included in the update, e.g. "display_name", "system_prompt_addendum", "guest_policy". Includes "is_virtual" when this update was the first administrator action on an auto-provisioned agent — a durable state change even when no other field was supplied. + + - `CcrRoleChannelAssignmentDeleted object` + + CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels). - `actor: object or object or object or 8 more` @@ -15894,9 +15719,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `previous_channel_count: number` - The session that was deleted, e.g. "cse_01HX...". + Number of (team, channel) pairs the role was assigned before deletion. + + - `role_id: string` + + Tagged ID of the role whose channel assignment was removed. - `id: optional string` @@ -15916,13 +15745,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_deleted"` + - `type: optional "ccr_role_channel_assignment_deleted"` - default: ccr_session_deleted + default: ccr_role_channel_assignment_deleted - - `CcrSessionUpdated object` + - `CcrRoleChannelAssignmentUpdated object` - A Claude Code session's settings were updated. + CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface. - `actor: object or object or object or 8 more` @@ -16135,14 +15964,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `channel_count: number` - The session that was updated, e.g. "cse_01HX...". + Number of channels assigned after the write. + + - `previous_channel_count: number` + + Number of channels assigned before the write. + + - `role_id: string` + + Tagged ID of the role whose channel assignment was written. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `agent_ids: optional array of string` + + The channel-silo agents (cagt_...) assigned after the write. Capped at 100 entries; channel_count carries the uncapped total. + - `created_at: optional string` When this activity occurred. @@ -16157,17 +15998,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_updated"` - - default: ccr_session_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_role_channel_assignment_updated"` - Names of the fields included in the update, e.g. "add_tags", "remove_tags". + default: ccr_role_channel_assignment_updated - - `ClaudeChatSettingsUpdated object` + - `CcrSessionCreated object` - User updated the settings for a conversation. + A Claude Code session was created. A session is one coding interaction with Claude. - `actor: object or object or object or 8 more` @@ -16380,15 +16217,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `session_id: string` + + The session that was created, e.g. "cse_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` + - `agent_id: optional string or null` - Project ID this chat belongs to, if any + The Claude Code agent attached to the session, e.g. "cagt_01HX...". Omitted when the session was created without an agent. - `created_at: optional string` @@ -16404,13 +16243,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_settings_updated"` + - `type: optional "ccr_session_created"` - default: claude_chat_settings_updated + default: ccr_session_created - - `ClaudeChatSnapshotCreated object` + - `CcrSessionDeleted object` - User created/shared a chat snapshot. + A Claude Code session was deleted. - `actor: object or object or object or 8 more` @@ -16623,9 +16462,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `session_id: string` - - `claude_chat_snapshot_id: string` + The session that was deleted, e.g. "cse_01HX...". - `id: optional string` @@ -16645,13 +16484,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_created"` + - `type: optional "ccr_session_deleted"` - default: claude_chat_snapshot_created + default: ccr_session_deleted - - `ClaudeChatSnapshotDeleted object` + - `CcrSessionUpdated object` - User deleted/unshared a chat snapshot. + A Claude Code session's settings were updated. - `actor: object or object or object or 8 more` @@ -16864,14 +16703,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_snapshot_id: string` + - `session_id: string` + + The session that was updated, e.g. "cse_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -16886,13 +16725,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_deleted"` + - `type: optional "ccr_session_updated"` - default: claude_chat_snapshot_deleted + default: ccr_session_updated - - `ClaudeChatSnapshotViewed object` + - `updated_fields: optional array of string` - User viewed a chat snapshot (authenticated or public/unauthenticated). + Names of the fields included in the update, e.g. "add_tags", "remove_tags". + + - `ClaudeChatSettingsUpdated object` + + User updated the settings for a conversation. - `actor: object or object or object or 8 more` @@ -17105,13 +16948,15 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_snapshot_id: string` + - `claude_chat_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` + - `claude_project_id: optional string or null` + + Project ID this chat belongs to, if any - `created_at: optional string` @@ -17127,13 +16972,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_viewed"` + - `type: optional "claude_chat_settings_updated"` - default: claude_chat_snapshot_viewed + default: claude_chat_settings_updated - - `ClaudeArtifactDuplicated object` + - `ClaudeChatSnapshotCreated object` - A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified. + User created/shared a chat snapshot. - `actor: object or object or object or 8 more` @@ -17346,13 +17191,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_artifact_id: string` - - Tagged ID of the new artifact created by the duplication. It is owned by the actor and is independent of the source artifact. - - - `source_claude_artifact_id: string` + - `claude_chat_id: string` - Tagged ID of the artifact that was copied. + - `claude_chat_snapshot_id: string` - `id: optional string` @@ -17372,17 +17213,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `source_claude_artifact_version_id: optional string or null` - - The version of the source artifact that was copied into the new artifact. - - - `type: optional "claude_artifact_duplicated"` + - `type: optional "claude_chat_snapshot_created"` - default: claude_artifact_duplicated + default: claude_chat_snapshot_created - - `ClaudeChatAccessFailed object` + - `ClaudeChatSnapshotDeleted object` - A user was denied access to a Claude.ai chat conversation. + User deleted/unshared a chat snapshot. - `actor: object or object or object or 8 more` @@ -17595,14 +17432,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` - - The chat conversation the user was denied access to, e.g. "claude_chat_01Ab...". + - `claude_chat_snapshot_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_chat_id: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -17617,13 +17454,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_access_failed"` + - `type: optional "claude_chat_snapshot_deleted"` - default: claude_chat_access_failed + default: claude_chat_snapshot_deleted - - `ClaudeChatCreated object` + - `ClaudeChatSnapshotViewed object` - User created a chat. + User viewed a chat snapshot (authenticated or public/unauthenticated). - `actor: object or object or object or 8 more` @@ -17836,17 +17673,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` - - Tagged ID of the created conversation, e.g. "claude_chat_01HX...". + - `claude_chat_snapshot_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` - - Tagged ID of the project the chat was created in, if any, e.g. "claude_proj_01HX...". + - `claude_chat_id: optional string or null` - `created_at: optional string` @@ -17862,13 +17695,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_created"` + - `type: optional "claude_chat_snapshot_viewed"` - default: claude_chat_created + default: claude_chat_snapshot_viewed - - `ClaudeChatDeleted object` + - `ClaudeArtifactDuplicated object` - A user deleted a Claude.ai chat conversation. + A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified. - `actor: object or object or object or 8 more` @@ -18081,17 +17914,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_artifact_id: string` - The chat conversation that was deleted, e.g. "claude_chat_01HX...". + Tagged ID of the new artifact created by the duplication. It is owned by the actor and is independent of the source artifact. - - `id: optional string` + - `source_claude_artifact_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the artifact that was copied. - - `claude_project_id: optional string or null` + - `id: optional string` - The project the chat belonged to, if any, e.g. "claude_proj_01HX...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -18107,13 +17940,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_deleted"` + - `source_claude_artifact_version_id: optional string or null` - default: claude_chat_deleted + The version of the source artifact that was copied into the new artifact. - - `ClaudeChatDeletionFailed object` + - `type: optional "claude_artifact_duplicated"` - A request to delete a Claude.ai chat conversation failed. + default: claude_artifact_duplicated + + - `ClaudeChatAccessFailed object` + + A user was denied access to a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -18328,7 +18165,7 @@ compliance activities that can be filtered by various criteria. - `claude_chat_id: string` - The chat conversation the user attempted to delete, e.g. "claude_chat_01HX...". + The chat conversation the user was denied access to, e.g. "claude_chat_01Ab...". - `id: optional string` @@ -18348,13 +18185,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_deletion_failed"` + - `type: optional "claude_chat_access_failed"` - default: claude_chat_deletion_failed + default: claude_chat_access_failed - - `ClaudeChatSyncSourceCreated object` + - `ClaudeChatCreated object` - A sync source was connected for syncing external content into Claude chats. + User created a chat. - `actor: object or object or object or 8 more` @@ -18567,18 +18404,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was created. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + Tagged ID of the created conversation, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the chat was created in, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. @@ -18593,17 +18430,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_chat_sync_source_created"` + - `type: optional "claude_chat_created"` - default: claude_chat_sync_source_created + default: claude_chat_created - - `ClaudeChatSyncSourceDeleted object` + - `ClaudeChatDeleted object` - A sync source was disconnected from Claude chats. + A user deleted a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -18816,18 +18649,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was deleted. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source. Always `unspecified` for deletion events. + The chat conversation that was deleted, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + The project the chat belonged to, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. @@ -18842,13 +18675,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_sync_source_deleted"` + - `type: optional "claude_chat_deleted"` - default: claude_chat_sync_source_deleted + default: claude_chat_deleted - - `ClaudeChatSyncSourceUpdated object` + - `ClaudeChatDeletionFailed object` - A Claude chat sync source's configuration was updated. + A request to delete a Claude.ai chat conversation failed. - `actor: object or object or object or 8 more` @@ -19061,22 +18894,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was updated. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + The chat conversation the user attempted to delete, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `config_changed: optional boolean or null` - - Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - - `created_at: optional string` When this activity occurred. @@ -19091,17 +18916,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_chat_sync_source_updated"` + - `type: optional "claude_chat_deletion_failed"` - default: claude_chat_sync_source_updated + default: claude_chat_deletion_failed - - `ClaudeChatUpdated object` + - `ClaudeChatSyncSourceCreated object` - User updated the chat metadata (e.g name, model). + A sync source was connected for syncing external content into Claude chats. - `actor: object or object or object or 8 more` @@ -19314,17 +19135,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_chat_sync_source_id: string` - Tagged ID of the updated conversation, e.g. "claude_chat_01HX...". + Tagged ID of the chat-scoped sync source that was created. - - `id: optional string` + - `provider: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - - `claude_project_id: optional string or null` + - `id: optional string` - Tagged ID of the project the chat belongs to, if any, e.g. "claude_proj_01HX...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -19340,13 +19161,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_updated"` + - `resource_descriptor: optional string or null` - default: claude_chat_updated + A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `ClaudeChatViewed object` + - `type: optional "claude_chat_sync_source_created"` - A user viewed a Claude.ai chat conversation. + default: claude_chat_sync_source_created + + - `ClaudeChatSyncSourceDeleted object` + + A sync source was disconnected from Claude chats. - `actor: object or object or object or 8 more` @@ -19559,17 +19384,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_chat_sync_source_id: string` - The chat conversation that was viewed, e.g. "claude_chat_01Ab...". + Tagged ID of the chat-scoped sync source that was deleted. - - `id: optional string` + - `provider: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The external provider backing the sync source. Always `unspecified` for deletion events. - - `claude_project_id: optional string or null` + - `id: optional string` - The project the chat belongs to, if any, e.g. "claude_proj_01Ab...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -19585,13 +19410,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_viewed"` + - `type: optional "claude_chat_sync_source_deleted"` - default: claude_chat_viewed + default: claude_chat_sync_source_deleted - - `ClaudeCodeCredentialRevoked object` + - `ClaudeChatSyncSourceUpdated object` - A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded. + A Claude chat sync source's configuration was updated. - `actor: object or object or object or 8 more` @@ -19804,25 +19629,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_type: "runner_pool_key" or "runner_token" or "session_token" or "unspecified"` - - The kind of credential the revoked target identifies, when known. Subject-targeted revocations cascade to every credential delegated from the target regardless of kind; this field describes the target itself, not the full set of credentials the cascade reached. For a revocation submitted as a pasted credential the kind is best-effort and may be inaccurate; the recorded jti and the revocation itself are unaffected. - - - `"runner_pool_key"` + - `claude_chat_sync_source_id: string` - - `"runner_token"` + Tagged ID of the chat-scoped sync source that was updated. - - `"session_token"` + - `provider: string` - - `"unspecified"` + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `agent_id: optional string or null` + - `config_changed: optional boolean or null` - The agent identity whose Claude Code credentials were revoked, when revocation targeted every session created by an agent identity, e.g. "cagt_01HX...". + Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - `created_at: optional string` @@ -19830,14 +19651,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `delegating_jti: optional string or null` - - The credential identifier whose delegated credentials were revoked (a chain revoke): every credential delegated from this one was revoked, but the credential itself was not. Distinct from `jti`, which records a revocation of the credential itself and its delegates. - - - `jti: optional string or null` - - The unique identifier of the revoked credential, recorded in its canonical form. Revoking a runner pool key also revokes every runner and session token delegated from it. A revocation submitted as a pasted credential is recorded by that credential's identifier. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -19846,29 +19659,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_id: optional string or null` - - The runner whose credentials were revoked, when revocation targeted every credential delegated from the runner, e.g. "ccrunner_01HX...". - - - `runner_pool_id: optional string or null` - - The runner pool whose credentials were revoked, when revocation targeted every credential delegated from the pool, e.g. "ccpool_01HX...". - - - `session_id: optional string or null` - - The session whose credentials were revoked, when revocation targeted every credential delegated from the session, e.g. "cse_01HX...". - - - `type: optional "claude_code_credential_revoked"` + - `resource_descriptor: optional string or null` - default: claude_code_credential_revoked + A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `user_id: optional string or null` + - `type: optional "claude_chat_sync_source_updated"` - The user whose Claude Code credentials were revoked, when revocation targeted every credential minted for a user. Carries the user's tagged account ID, e.g. "user_01HX..." — the only form the revocation API accepts, so the field joins against other activities' account identifiers and never carries an email. + default: claude_chat_sync_source_updated - - `ClaudeCodeReviewConfigUpdated object` + - `ClaudeChatUpdated object` - Claude Code Review configuration was enabled/disabled for an org. + User updated the chat metadata (e.g name, model). - `actor: object or object or object or 8 more` @@ -20081,28 +19882,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` + - `claude_chat_id: string` - Whether code review is now enabled + Tagged ID of the updated conversation, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the chat belongs to, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time - - `environment_id: optional string or null` - - Environment used for code review - - - `model: optional string or null` - - Model configured for code review - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20111,49 +19908,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `per_review_limit_usd: optional string or null` - - Per-review spend limit in USD - - - `previous_enabled: optional boolean or null` - - Whether code review was enabled before the change. Absent when no configuration existed before this update. - - - `previous_environment_id: optional string or null` - - Environment used for code review before the change. Absent when no configuration existed before this update or no environment was set. - - - `previous_model: optional string or null` - - Model configured for code review before the change. Absent when no configuration existed before this update or no model was set. - - - `previous_per_review_limit_usd: optional string or null` - - Per-review spend limit in USD before the change. Absent when no configuration existed before this update or no limit was set. - - - `previous_show_tips: optional boolean or null` - - Whether tip-style pull-request comments were enabled before the change. Absent when no configuration existed before this update. - - - `previous_verification_enabled: optional boolean or null` - - Whether the verification stage of code review was enabled for the organization before the change. Absent when no configuration existed before this update or no preference was set. - - - `show_tips: optional boolean or null` - - Whether tip-style pull-request comments are now enabled - - - `type: optional "claude_code_review_config_updated"` - - default: claude_code_review_config_updated - - - `verification_enabled: optional boolean or null` + - `type: optional "claude_chat_updated"` - Whether the verification stage of code review is now enabled for the organization. Absent when the organization has not set a preference and the default applies. + default: claude_chat_updated - - `ClaudeCodeReviewRepositoryAdded object` + - `ClaudeChatViewed object` - A repository was added to org-level Claude Code Review configuration. + A user viewed a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -20366,26 +20127,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` - - ID of the repository configuration - - - `repo_name: string` - - Repository name - - - `repo_owner: string` - - Repository owner (GitHub org/user) - - - `trigger_mode: string` + - `claude_chat_id: string` - When code review is triggered + The chat conversation that was viewed, e.g. "claude_chat_01Ab...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + The project the chat belongs to, if any, e.g. "claude_proj_01Ab...". + - `created_at: optional string` When this activity occurred. @@ -20400,13 +20153,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_review_repository_added"` + - `type: optional "claude_chat_viewed"` - default: claude_code_review_repository_added + default: claude_chat_viewed - - `ClaudeCodeReviewRepositoryRemoved object` + - `ClaudeCodeCredentialRevoked object` - A repository was removed from org-level Claude Code Review configuration. + A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded. - `actor: object or object or object or 8 more` @@ -20619,28 +20372,40 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` + - `credential_type: "runner_pool_key" or "runner_token" or "session_token" or "unspecified"` - ID of the deleted repository configuration + The kind of credential the revoked target identifies, when known. Subject-targeted revocations cascade to every credential delegated from the target regardless of kind; this field describes the target itself, not the full set of credentials the cascade reached. For a revocation submitted as a pasted credential the kind is best-effort and may be inaccurate; the recorded jti and the revocation itself are unaffected. - - `repo_name: string` + - `"runner_pool_key"` - Repository name at deletion time + - `"runner_token"` - - `repo_owner: string` + - `"session_token"` - Repository owner at deletion time + - `"unspecified"` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `agent_id: optional string or null` + + The agent identity whose Claude Code credentials were revoked, when revocation targeted every session created by an agent identity, e.g. "cagt_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time + - `delegating_jti: optional string or null` + + The credential identifier whose delegated credentials were revoked (a chain revoke): every credential delegated from this one was revoked, but the credential itself was not. Distinct from `jti`, which records a revocation of the credential itself and its delegates. + + - `jti: optional string or null` + + The unique identifier of the revoked credential, recorded in its canonical form. Revoking a runner pool key also revokes every runner and session token delegated from it. A revocation submitted as a pasted credential is recorded by that credential's identifier. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20649,13 +20414,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_review_repository_removed"` + - `runner_id: optional string or null` - default: claude_code_review_repository_removed + The runner whose credentials were revoked, when revocation targeted every credential delegated from the runner, e.g. "ccrunner_01HX...". - - `ClaudeCodeReviewRepositoryUpdated object` + - `runner_pool_id: optional string or null` - A Claude Code Review repository configuration was updated. + The runner pool whose credentials were revoked, when revocation targeted every credential delegated from the pool, e.g. "ccpool_01HX...". + + - `session_id: optional string or null` + + The session whose credentials were revoked, when revocation targeted every credential delegated from the session, e.g. "cse_01HX...". + + - `type: optional "claude_code_credential_revoked"` + + default: claude_code_credential_revoked + + - `user_id: optional string or null` + + The user whose Claude Code credentials were revoked, when revocation targeted every credential minted for a user. Carries the user's tagged account ID, e.g. "user_01HX..." — the only form the revocation API accepts, so the field joins against other activities' account identifiers and never carries an email. + + - `ClaudeCodeReviewConfigUpdated object` + + Claude Code Review configuration was enabled/disabled for an org. - `actor: object or object or object or 8 more` @@ -20868,17 +20649,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` - - ID of the repository configuration - - - `repo_name: string` - - Repository name - - - `repo_owner: string` + - `enabled: boolean` - Repository owner + Whether code review is now enabled - `id: optional string` @@ -20890,6 +20663,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `environment_id: optional string or null` + + Environment used for code review + + - `model: optional string or null` + + Model configured for code review + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20898,21 +20679,49 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `status: optional string or null` + - `per_review_limit_usd: optional string or null` - Updated status (ACTIVE/INACTIVE) + Per-review spend limit in USD - - `trigger_mode: optional string or null` + - `previous_enabled: optional boolean or null` - Updated trigger mode + Whether code review was enabled before the change. Absent when no configuration existed before this update. - - `type: optional "claude_code_review_repository_updated"` + - `previous_environment_id: optional string or null` - default: claude_code_review_repository_updated + Environment used for code review before the change. Absent when no configuration existed before this update or no environment was set. - - `ClaudeCodeRunnerDeleted object` + - `previous_model: optional string or null` - A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again. + Model configured for code review before the change. Absent when no configuration existed before this update or no model was set. + + - `previous_per_review_limit_usd: optional string or null` + + Per-review spend limit in USD before the change. Absent when no configuration existed before this update or no limit was set. + + - `previous_show_tips: optional boolean or null` + + Whether tip-style pull-request comments were enabled before the change. Absent when no configuration existed before this update. + + - `previous_verification_enabled: optional boolean or null` + + Whether the verification stage of code review was enabled for the organization before the change. Absent when no configuration existed before this update or no preference was set. + + - `show_tips: optional boolean or null` + + Whether tip-style pull-request comments are now enabled + + - `type: optional "claude_code_review_config_updated"` + + default: claude_code_review_config_updated + + - `verification_enabled: optional boolean or null` + + Whether the verification stage of code review is now enabled for the organization. Absent when the organization has not set a preference and the default applies. + + - `ClaudeCodeReviewRepositoryAdded object` + + A repository was added to org-level Claude Code Review configuration. - `actor: object or object or object or 8 more` @@ -21125,9 +20934,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `runner_id: string` + - `config_id: string` - The runner that was removed, e.g. "ccrunner_01HX...". + ID of the repository configuration + + - `repo_name: string` + + Repository name + + - `repo_owner: string` + + Repository owner (GitHub org/user) + + - `trigger_mode: string` + + When code review is triggered - `id: optional string` @@ -21147,17 +20968,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_pool_id: optional string or null` - - The pool the runner was removed from, e.g. "ccpool_01HX...". - - - `type: optional "claude_code_runner_deleted"` + - `type: optional "claude_code_review_repository_added"` - default: claude_code_runner_deleted + default: claude_code_review_repository_added - - `ClaudeCodeRunnerPoolCreated object` + - `ClaudeCodeReviewRepositoryRemoved object` - A self-hosted runner pool for Claude Code was created. + A repository was removed from org-level Claude Code Review configuration. - `actor: object or object or object or 8 more` @@ -21370,13 +21187,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` + - `config_id: string` - The display name the pool was created with. + ID of the deleted repository configuration - - `runner_pool_id: string` + - `repo_name: string` - The runner pool that was created, e.g. "ccpool_01HX...". + Repository name at deletion time + + - `repo_owner: string` + + Repository owner at deletion time - `id: optional string` @@ -21396,13 +21217,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_created"` + - `type: optional "claude_code_review_repository_removed"` - default: claude_code_runner_pool_created + default: claude_code_review_repository_removed - - `ClaudeCodeRunnerPoolDeleted object` + - `ClaudeCodeReviewRepositoryUpdated object` - A self-hosted runner pool was deleted. + A Claude Code Review repository configuration was updated. - `actor: object or object or object or 8 more` @@ -21615,9 +21436,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `runner_pool_id: string` + - `config_id: string` - The runner pool that was deleted, e.g. "ccpool_01HX...". + ID of the repository configuration + + - `repo_name: string` + + Repository name + + - `repo_owner: string` + + Repository owner - `id: optional string` @@ -21629,10 +21458,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `display_name: optional string or null` - - The pool's display name at deletion time. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -21641,13 +21466,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_deleted"` + - `status: optional string or null` - default: claude_code_runner_pool_deleted + Updated status (ACTIVE/INACTIVE) - - `ClaudeCodeRunnerPoolSecretMinted object` + - `trigger_mode: optional string or null` - A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded. + Updated trigger mode + + - `type: optional "claude_code_review_repository_updated"` + + default: claude_code_review_repository_updated + + - `ClaudeCodeRunnerDeleted object` + + A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again. - `actor: object or object or object or 8 more` @@ -21860,13 +21693,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `jti: string` - - The minted key's unique identifier (its JWT `jti` claim), usable to revoke that key later. - - - `runner_pool_id: string` + - `runner_id: string` - The runner pool the key was minted for, e.g. "ccpool_01HX...". + The runner that was removed, e.g. "ccrunner_01HX...". - `id: optional string` @@ -21878,16 +21707,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `expires_at: optional string or null` - - When the minted key expires. - - format: date-time - - - `label: optional string or null` - - The label the key was minted with. The key minted automatically when a pool is created carries the label "Initial key". - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -21896,25 +21715,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_secret_minted"` - - default: claude_code_runner_pool_secret_minted - - - `ClaudeCodeRunnerPoolSessionQueueUpdated object` - - An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt. - - - `action: "dismissed" or "provisioning_retried" or "requeued" or "unspecified"` + - `runner_pool_id: optional string or null` - What changed about the session's queue state. + The pool the runner was removed from, e.g. "ccpool_01HX...". - - `"dismissed"` + - `type: optional "claude_code_runner_deleted"` - - `"provisioning_retried"` + default: claude_code_runner_deleted - - `"requeued"` + - `ClaudeCodeRunnerPoolCreated object` - - `"unspecified"` + A self-hosted runner pool for Claude Code was created. - `actor: object or object or object or 8 more` @@ -22127,9 +21938,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `display_name: string` - The session whose queue state changed, e.g. "cse_01HX...". + The display name the pool was created with. + + - `runner_pool_id: string` + + The runner pool that was created, e.g. "ccpool_01HX...". - `id: optional string` @@ -22141,10 +21956,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `excluded_runner_id: optional string or null` - - The runner the session was moved off, when action is "requeued", e.g. "ccrunner_01HX...". - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22153,17 +21964,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_pool_id: optional string or null` - - The runner pool whose queue the session is in, when known, e.g. "ccpool_01HX...". - - - `type: optional "claude_code_runner_pool_session_queue_updated"` + - `type: optional "claude_code_runner_pool_created"` - default: claude_code_runner_pool_session_queue_updated + default: claude_code_runner_pool_created - - `ClaudeCodeRunnerPoolUpdated object` + - `ClaudeCodeRunnerPoolDeleted object` - A self-hosted runner pool's settings were updated. + A self-hosted runner pool was deleted. - `actor: object or object or object or 8 more` @@ -22376,13 +22183,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` - - The pool's display name after the update. - - `runner_pool_id: string` - The runner pool that was updated, e.g. "ccpool_01HX...". + The runner pool that was deleted, e.g. "ccpool_01HX...". - `id: optional string` @@ -22394,6 +22197,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `display_name: optional string or null` + + The pool's display name at deletion time. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22402,17 +22209,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_display_name: optional string or null` - - The pool's display name before the update. Absent when the name was unchanged or the previous value was unavailable. - - - `type: optional "claude_code_runner_pool_updated"` + - `type: optional "claude_code_runner_pool_deleted"` - default: claude_code_runner_pool_updated + default: claude_code_runner_pool_deleted - - `ClaudeCodeSecurityCenterConfigUpdated object` + - `ClaudeCodeRunnerPoolSecretMinted object` - Claude Code Security Center scanning was enabled/disabled for an org. + A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded. - `actor: object or object or object or 8 more` @@ -22625,9 +22428,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` + - `jti: string` - Whether Security Center is now enabled + The minted key's unique identifier (its JWT `jti` claim), usable to revoke that key later. + + - `runner_pool_id: string` + + The runner pool the key was minted for, e.g. "ccpool_01HX...". - `id: optional string` @@ -22639,9 +22446,15 @@ compliance activities that can be filtered by various criteria. format: date-time - - `environment_id: optional string or null` + - `expires_at: optional string or null` - Environment used for security scanning + When the minted key expires. + + format: date-time + + - `label: optional string or null` + + The label the key was minted with. The key minted automatically when a pool is created carries the label "Initial key". - `organization_id: optional string or null` @@ -22651,13 +22464,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_center_config_updated"` + - `type: optional "claude_code_runner_pool_secret_minted"` - default: claude_code_security_center_config_updated + default: claude_code_runner_pool_secret_minted - - `ClaudeCodeSecurityScanCancelled object` + - `ClaudeCodeRunnerPoolSessionQueueUpdated object` - In-flight Claude Code Security scans were cancelled for a project. + An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt. + + - `action: "dismissed" or "provisioning_retried" or "requeued" or "unspecified"` + + What changed about the session's queue state. + + - `"dismissed"` + + - `"provisioning_retried"` + + - `"requeued"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -22870,11 +22695,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_project_id: string` - - Tagged ID of the scan project + - `session_id: string` - - `scans_cancelled: number` + The session whose queue state changed, e.g. "cse_01HX...". - `id: optional string` @@ -22886,6 +22709,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `excluded_runner_id: optional string or null` + + The runner the session was moved off, when action is "requeued", e.g. "ccrunner_01HX...". + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22894,13 +22721,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_cancelled"` + - `runner_pool_id: optional string or null` - default: claude_code_security_scan_cancelled + The runner pool whose queue the session is in, when known, e.g. "ccpool_01HX...". - - `ClaudeCodeSecurityScanCreated object` + - `type: optional "claude_code_runner_pool_session_queue_updated"` - A Claude Code Security scan was started. + default: claude_code_runner_pool_session_queue_updated + + - `ClaudeCodeRunnerPoolUpdated object` + + A self-hosted runner pool's settings were updated. - `actor: object or object or object or 8 more` @@ -23113,13 +22944,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `display_name: string` - Tagged ID of the created scan + The pool's display name after the update. - - `scan_project_id: string` + - `runner_pool_id: string` - Tagged ID of the scan project the scan belongs to + The runner pool that was updated, e.g. "ccpool_01HX...". - `id: optional string` @@ -23139,25 +22970,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_created"` - - default: claude_code_security_scan_created - - - `ClaudeCodeSecurityScanProjectMemberUpdated object` - - A person's access to a Claude Code Security scan project was granted, changed, or revoked. - - - `action: "member_added" or "member_removed" or "member_role_changed" or "unspecified"` + - `previous_display_name: optional string or null` - Whether the member was granted access, had their role changed, or was revoked + The pool's display name before the update. Absent when the name was unchanged or the previous value was unavailable. - - `"member_added"` + - `type: optional "claude_code_runner_pool_updated"` - - `"member_removed"` + default: claude_code_runner_pool_updated - - `"member_role_changed"` + - `ClaudeCodeSecurityCenterConfigUpdated object` - - `"unspecified"` + Claude Code Security Center scanning was enabled/disabled for an org. - `actor: object or object or object or 8 more` @@ -23370,13 +23193,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `member_id: string` - - Tagged ID of the member whose access changed - - - `scan_project_id: string` + - `enabled: boolean` - Tagged ID of the scan project + Whether Security Center is now enabled - `id: optional string` @@ -23388,6 +23207,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `environment_id: optional string or null` + + Environment used for security scanning + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -23396,31 +23219,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `role: optional string or null` - - Role granted to the member (full, view_triage, or view); omitted for revocations - - - `type: optional "claude_code_security_scan_project_member_updated"` - - default: claude_code_security_scan_project_member_updated - - - `ClaudeCodeSecurityScanProjectUpdated object` - - A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience. - - - `action: "archived" or "created" or "migrated" or 2 more` - - The state change applied to the scan project. - - - `"archived"` - - - `"created"` + - `type: optional "claude_code_security_center_config_updated"` - - `"migrated"` + default: claude_code_security_center_config_updated - - `"unarchived"` + - `ClaudeCodeSecurityScanCancelled object` - - `"unspecified"` + In-flight Claude Code Security scans were cancelled for a project. - `actor: object or object or object or 8 more` @@ -23637,6 +23442,8 @@ compliance activities that can be filtered by various criteria. Tagged ID of the scan project + - `scans_cancelled: number` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -23655,23 +23462,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_project_updated"` - - default: claude_code_security_scan_project_updated - - - `ClaudeCodeSecurityScanProjectVisibilityUpdated object` - - A Claude Code Security scan project was shared with the organization or made private. - - - `action: "shared" or "unshared" or "unspecified"` - - Whether the project was shared with the organization or made private + - `type: optional "claude_code_security_scan_cancelled"` - - `"shared"` + default: claude_code_security_scan_cancelled - - `"unshared"` + - `ClaudeCodeSecurityScanCreated object` - - `"unspecified"` + A Claude Code Security scan was started. - `actor: object or object or object or 8 more` @@ -23884,18 +23681,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `scan_id: string` + + Tagged ID of the created scan + - `scan_project_id: string` - Tagged ID of the scan project + Tagged ID of the scan project the scan belongs to - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `access_level: optional string or null` - - Access level granted to organization members (read_only or full); only set when shared - - `created_at: optional string` When this activity occurred. @@ -23910,25 +23707,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_project_visibility_updated"` - - default: claude_code_security_scan_project_visibility_updated + - `type: optional "claude_code_security_scan_created"` - - `ClaudeCodeSecurityScanRunUpdated object` + default: claude_code_security_scan_created - A single Claude Code Security scan run was archived or unarchived. + - `ClaudeCodeSecurityScanProjectMemberUpdated object` - - `action: "archived" or "created" or "migrated" or 2 more` + A person's access to a Claude Code Security scan project was granted, changed, or revoked. - The state change applied to the scan run + - `action: "member_added" or "member_removed" or "member_role_changed" or "unspecified"` - - `"archived"` + Whether the member was granted access, had their role changed, or was revoked - - `"created"` + - `"member_added"` - - `"migrated"` + - `"member_removed"` - - `"unarchived"` + - `"member_role_changed"` - `"unspecified"` @@ -24143,9 +23938,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `member_id: string` - Tagged ID of the scan the request named — any scan in the archived run, not necessarily its canonical (run_index=0) scan + Tagged ID of the member whose access changed + + - `scan_project_id: string` + + Tagged ID of the scan project - `id: optional string` @@ -24165,13 +23964,33 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_run_updated"` + - `role: optional string or null` - default: claude_code_security_scan_run_updated + Role granted to the member (full, view_triage, or view); omitted for revocations - - `ClaudeCodeSecurityScanScheduleDeleted object` + - `type: optional "claude_code_security_scan_project_member_updated"` - A recurring scan schedule was deleted for a Claude Code Security project. + default: claude_code_security_scan_project_member_updated + + - `ClaudeCodeSecurityScanProjectUpdated object` + + A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience. + + - `action: "archived" or "created" or "migrated" or 3 more` + + The state change applied to the scan project. + + - `"archived"` + + - `"created"` + + - `"migrated"` + + - `"resumed"` + + - `"unarchived"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24406,13 +24225,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_schedule_deleted"` + - `type: optional "claude_code_security_scan_project_updated"` - default: claude_code_security_scan_schedule_deleted + default: claude_code_security_scan_project_updated - - `ClaudeCodeSecurityScanScheduleUpdated object` + - `ClaudeCodeSecurityScanProjectVisibilityUpdated object` - A recurring scan schedule was set or replaced for a Claude Code Security project. + A Claude Code Security scan project was shared with the organization or made private. + + - `action: "shared" or "unshared" or "unspecified"` + + Whether the project was shared with the organization or made private + + - `"shared"` + + - `"unshared"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24625,8 +24454,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cadence: string` - - `scan_project_id: string` Tagged ID of the scan project @@ -24635,6 +24462,10 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_level: optional string or null` + + Access level granted to organization members (read_only or full); only set when shared + - `created_at: optional string` When this activity occurred. @@ -24649,13 +24480,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_schedule_updated"` + - `type: optional "claude_code_security_scan_project_visibility_updated"` - default: claude_code_security_scan_schedule_updated + default: claude_code_security_scan_project_visibility_updated - - `ClaudeCodeSecurityVulnerabilityFixSessionCreated object` + - `ClaudeCodeSecurityScanRunUpdated object` - A Claude Code remediation session was created for a Claude Code Security vulnerability finding. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. + + - `action: "archived" or "created" or "migrated" or 3 more` + + The state change applied to the scan run + + - `"archived"` + + - `"created"` + + - `"migrated"` + + - `"resumed"` + + - `"unarchived"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24870,11 +24717,7 @@ compliance activities that can be filtered by various criteria. - `scan_id: string` - Tagged ID of the scan the finding belongs to - - - `session_id: string` - - ID of the created remediation session + Tagged ID of the scan the request named — for archive/unarchive any scan in the run, not necessarily its canonical (run_index=0) scan; for resume, the paused scan - `id: optional string` @@ -24894,27 +24737,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_vulnerability_fix_session_created"` - - default: claude_code_security_vulnerability_fix_session_created - - - `ClaudeCodeSecurityVulnerabilityUpdated object` - - A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened. - - - `action: "dismissed" or "fixed" or "restored" or 2 more` - - The state change applied to the finding - - - `"dismissed"` - - - `"fixed"` + - `type: optional "claude_code_security_scan_run_updated"` - - `"restored"` + default: claude_code_security_scan_run_updated - - `"unfixed"` + - `ClaudeCodeSecurityScanScheduleDeleted object` - - `"unspecified"` + A recurring scan schedule was deleted for a Claude Code Security project. - `actor: object or object or object or 8 more` @@ -25127,9 +24956,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `scan_project_id: string` - Tagged ID of the scan the finding belongs to + Tagged ID of the scan project - `id: optional string` @@ -25141,10 +24970,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `dismissal_reason: optional string or null` - - The categorized dismissal reason (only set when the finding was dismissed) - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -25153,13 +24978,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_vulnerability_updated"` + - `type: optional "claude_code_security_scan_schedule_deleted"` - default: claude_code_security_vulnerability_updated + default: claude_code_security_scan_schedule_deleted - - `ClaudeCodeSecurityWebhookCreated object` + - `ClaudeCodeSecurityScanScheduleUpdated object` - A Claude Code Security outbound webhook was created. + A recurring scan schedule was set or replaced for a Claude Code Security project. - `actor: object or object or object or 8 more` @@ -25372,11 +25197,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `url: string` + - `cadence: string` - - `webhook_id: string` + - `scan_project_id: string` - Tagged ID of the webhook + Tagged ID of the scan project - `id: optional string` @@ -25396,17 +25221,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` - - Tagged ID of the scan project (null for organization-wide webhooks) - - - `type: optional "claude_code_security_webhook_created"` + - `type: optional "claude_code_security_scan_schedule_updated"` - default: claude_code_security_webhook_created + default: claude_code_security_scan_schedule_updated - - `ClaudeCodeSecurityWebhookDeleted object` + - `ClaudeCodeSecurityVulnerabilityFixSessionCreated object` - A Claude Code Security outbound webhook was deleted. + A Claude Code remediation session was created for a Claude Code Security vulnerability finding. - `actor: object or object or object or 8 more` @@ -25619,9 +25440,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `webhook_id: string` + - `scan_id: string` - Tagged ID of the webhook + Tagged ID of the scan the finding belongs to + + - `session_id: string` + + ID of the created remediation session - `id: optional string` @@ -25641,17 +25466,27 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` + - `type: optional "claude_code_security_vulnerability_fix_session_created"` - Tagged ID of the scan project (null for organization-wide webhooks) + default: claude_code_security_vulnerability_fix_session_created - - `type: optional "claude_code_security_webhook_deleted"` + - `ClaudeCodeSecurityVulnerabilityUpdated object` - default: claude_code_security_webhook_deleted + A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened. - - `ClaudeCodeSecurityWebhookSecretUpdated object` + - `action: "dismissed" or "fixed" or "restored" or 2 more` - The HMAC signing secret for a Claude Code Security webhook was rotated. + The state change applied to the finding + + - `"dismissed"` + + - `"fixed"` + + - `"restored"` + + - `"unfixed"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -25864,9 +25699,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `webhook_id: string` + - `scan_id: string` - Tagged ID of the webhook + Tagged ID of the scan the finding belongs to - `id: optional string` @@ -25878,6 +25713,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `dismissal_reason: optional string or null` + + The categorized dismissal reason (only set when the finding was dismissed) + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -25886,17 +25725,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` - - Tagged ID of the scan project (null for organization-wide webhooks) - - - `type: optional "claude_code_security_webhook_secret_updated"` + - `type: optional "claude_code_security_vulnerability_updated"` - default: claude_code_security_webhook_secret_updated + default: claude_code_security_vulnerability_updated - - `ClaudeCodeSecurityWebhookUpdated object` + - `ClaudeCodeSecurityWebhookCreated object` - A Claude Code Security outbound webhook was updated. + A Claude Code Security outbound webhook was created. - `actor: object or object or object or 8 more` @@ -26109,6 +25944,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `url: string` + - `webhook_id: string` Tagged ID of the webhook @@ -26135,23 +25972,13 @@ compliance activities that can be filtered by various criteria. Tagged ID of the scan project (null for organization-wide webhooks) - - `type: optional "claude_code_security_webhook_updated"` - - default: claude_code_security_webhook_updated - - - `ClaudeCodeTeamMemoryACLUpdated object` - - An RBAC group was added to or removed from the Claude Code team-memory ACL. - - - `action: "removed" or "set" or "unspecified"` - - Whether the group was set (added/updated) or removed + - `type: optional "claude_code_security_webhook_created"` - - `"removed"` + default: claude_code_security_webhook_created - - `"set"` + - `ClaudeCodeSecurityWebhookDeleted object` - - `"unspecified"` + A Claude Code Security outbound webhook was deleted. - `actor: object or object or object or 8 more` @@ -26364,18 +26191,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` + - `webhook_id: string` - Tagged ID of the RBAC group + Tagged ID of the webhook - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `access_level: optional string or null` - - Access level granted (when action=set) - - `created_at: optional string` When this activity occurred. @@ -26390,17 +26213,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_access_level: optional string or null` + - `scan_project_id: optional string or null` - Access level the group had before this change; absent when the group was not previously in the access list. For removals this is the access level that was removed. + Tagged ID of the scan project (null for organization-wide webhooks) - - `type: optional "claude_code_team_memory_acl_updated"` + - `type: optional "claude_code_security_webhook_deleted"` - default: claude_code_team_memory_acl_updated + default: claude_code_security_webhook_deleted - - `ClaudeCodeTeamMemoryUpdated object` + - `ClaudeCodeSecurityWebhookSecretUpdated object` - Claude Code team memory shared with the organization was updated. + The HMAC signing secret for a Claude Code Security webhook was rotated. - `actor: object or object or object or 8 more` @@ -26613,9 +26436,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `webhook_id: string` - True when the entire team memory store for this scope was deleted in one request. + Tagged ID of the webhook - `id: optional string` @@ -26627,26 +26450,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of team memory entries removed. - - - `keys_written: optional array of string` - - Withdrawn — never populated. See `keys_written_count`. - - - `keys_written_count: optional number or null` - - Number of team memory entries created or updated. - - - `new_checksum: optional string or null` - - Checksum of the team memory after this change. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -26655,37 +26458,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_checksum: optional string or null` - - Checksum of the team memory before this change; null when it did not exist. - - - `repo: optional string or null` - - Withdrawn — never populated. - - - `type: optional "claude_code_team_memory_updated"` - - default: claude_code_team_memory_updated - - - `version: optional number or null` - - Version number of the team memory store after this change. - - - `ClaudeCodeTeamOnboardingGuideUpdated object` - - A Claude Code team onboarding guide was created, updated, or deleted. - - - `action: "created" or "deleted" or "unspecified" or "updated"` + - `scan_project_id: optional string or null` - The state change applied to the onboarding guide. + Tagged ID of the scan project (null for organization-wide webhooks) - - `"created"` + - `type: optional "claude_code_security_webhook_secret_updated"` - - `"deleted"` + default: claude_code_security_webhook_secret_updated - - `"unspecified"` + - `ClaudeCodeSecurityWebhookUpdated object` - - `"updated"` + A Claude Code Security outbound webhook was updated. - `actor: object or object or object or 8 more` @@ -26898,9 +26681,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `guide_short_code: string` + - `webhook_id: string` - Short code identifying the onboarding guide — the public URL handle shown in the share link. + Tagged ID of the webhook - `id: optional string` @@ -26912,37 +26695,35 @@ compliance activities that can be filtered by various criteria. format: date-time - - `guide_id: optional string or null` - - Tagged ID of the onboarding guide. + - `organization_id: optional string or null` - - `guide_name: optional string or null` + Organization ID this activity is associated with - Withdrawn — never populated. + - `organization_uuid: optional string or null` - - `new_checksum: optional string or null` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - Checksum of the guide content after this change; null when the guide was deleted. + - `scan_project_id: optional string or null` - - `organization_id: optional string or null` + Tagged ID of the scan project (null for organization-wide webhooks) - Organization ID this activity is associated with + - `type: optional "claude_code_security_webhook_updated"` - - `organization_uuid: optional string or null` + default: claude_code_security_webhook_updated - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `ClaudeCodeTeamMemoryACLUpdated object` - - `previous_checksum: optional string or null` + An RBAC group was added to or removed from the Claude Code team-memory ACL. - Checksum of the guide content before this change; null when the guide did not exist. + - `action: "removed" or "set" or "unspecified"` - - `type: optional "claude_code_team_onboarding_guide_updated"` + Whether the group was set (added/updated) or removed - default: claude_code_team_onboarding_guide_updated + - `"removed"` - - `ClaudeCodeUserMarketplacesUpdated object` + - `"set"` - A user's Claude Code plugin marketplace selections were updated on Anthropic servers. + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -27155,40 +26936,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `group_id: string` - True when all of the user's marketplace selections were removed in one request. + Tagged ID of the RBAC group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_level: optional string or null` + + Access level granted (when action=set) + - `created_at: optional string` When this activity occurred. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of marketplace selections removed. - - - `keys_written: optional array of string` - - Withdrawn — never populated. See `keys_written_count`. - - - `keys_written_count: optional number or null` - - Number of marketplace selections added or whose source changed. - - - `new_value: optional string or null` - - Withdrawn — never populated. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -27197,17 +26962,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional string or null` + - `previous_access_level: optional string or null` - Withdrawn — never populated. + Access level the group had before this change; absent when the group was not previously in the access list. For removals this is the access level that was removed. - - `type: optional "claude_code_user_marketplaces_updated"` + - `type: optional "claude_code_team_memory_acl_updated"` - default: claude_code_user_marketplaces_updated + default: claude_code_team_memory_acl_updated - - `ClaudeCodeUserMemoryUpdated object` + - `ClaudeCodeTeamMemoryUpdated object` - A user's synced private Claude Code memory was updated or deleted on Anthropic servers. + Claude Code team memory shared with the organization was updated. - `actor: object or object or object or 8 more` @@ -27422,7 +27187,7 @@ compliance activities that can be filtered by various criteria. - `deleted_all: boolean` - True when the user's entire synced memory for this scope was deleted in one request. + True when the entire team memory store for this scope was deleted in one request. - `id: optional string` @@ -27440,7 +27205,7 @@ compliance activities that can be filtered by various criteria. - `keys_deleted_count: optional number or null` - Number of memory file paths removed. + Number of team memory entries removed. - `keys_written: optional array of string` @@ -27448,11 +27213,11 @@ compliance activities that can be filtered by various criteria. - `keys_written_count: optional number or null` - Number of memory file paths created or updated. + Number of team memory entries created or updated. - `new_checksum: optional string or null` - Checksum of the user's synced memory after this change. + Checksum of the team memory after this change. - `organization_id: optional string or null` @@ -27464,19 +27229,35 @@ compliance activities that can be filtered by various criteria. - `previous_checksum: optional string or null` - Checksum of the user's synced memory before this change; null when the store did not exist. + Checksum of the team memory before this change; null when it did not exist. - `repo: optional string or null` Withdrawn — never populated. - - `type: optional "claude_code_user_memory_updated"` + - `type: optional "claude_code_team_memory_updated"` - default: claude_code_user_memory_updated + default: claude_code_team_memory_updated - - `ClaudeCodeUserPluginsUpdated object` + - `version: optional number or null` - A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers. + Version number of the team memory store after this change. + + - `ClaudeCodeTeamOnboardingGuideUpdated object` + + A Claude Code team onboarding guide was created, updated, or deleted. + + - `action: "created" or "deleted" or "unspecified" or "updated"` + + The state change applied to the onboarding guide. + + - `"created"` + + - `"deleted"` + + - `"unspecified"` + + - `"updated"` - `actor: object or object or object or 8 more` @@ -27689,9 +27470,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `guide_short_code: string` - True when all of the user's plugin selections were removed in one request. + Short code identifying the onboarding guide — the public URL handle shown in the share link. - `id: optional string` @@ -27703,25 +27484,17 @@ compliance activities that can be filtered by various criteria. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of plugin selections removed. - - - `keys_written: optional array of string` + - `guide_id: optional string or null` - Withdrawn — never populated. See `keys_written_count`. + Tagged ID of the onboarding guide. - - `keys_written_count: optional number or null` + - `guide_name: optional string or null` - Number of plugin selections added or whose enabled state changed. + Withdrawn — never populated. - - `new_value: optional string or null` + - `new_checksum: optional string or null` - The targeted plugin's new enabled state, when a single plugin's state changed. + Checksum of the guide content after this change; null when the guide was deleted. - `organization_id: optional string or null` @@ -27731,17 +27504,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional string or null` + - `previous_checksum: optional string or null` - The targeted plugin's previous enabled state, when a single plugin's state changed; null when the plugin did not previously exist or multiple plugins changed. + Checksum of the guide content before this change; null when the guide did not exist. - - `type: optional "claude_code_user_plugins_updated"` + - `type: optional "claude_code_team_onboarding_guide_updated"` - default: claude_code_user_plugins_updated + default: claude_code_team_onboarding_guide_updated - - `ClaudeCodeUserSettingsUpdated object` + - `ClaudeCodeUserMarketplacesUpdated object` - A user's synced Claude Code settings were updated or deleted on Anthropic servers. + A user's Claude Code plugin marketplace selections were updated on Anthropic servers. - `actor: object or object or object or 8 more` @@ -27956,7 +27729,7 @@ compliance activities that can be filtered by various criteria. - `deleted_all: boolean` - True when the user's entire synced settings store was deleted in one request. + True when all of the user's marketplace selections were removed in one request. - `id: optional string` @@ -27974,7 +27747,7 @@ compliance activities that can be filtered by various criteria. - `keys_deleted_count: optional number or null` - Number of settings entries removed. + Number of marketplace selections removed. - `keys_written: optional array of string` @@ -27982,11 +27755,11 @@ compliance activities that can be filtered by various criteria. - `keys_written_count: optional number or null` - Number of settings entries created or updated. + Number of marketplace selections added or whose source changed. - - `new_checksum: optional string or null` + - `new_value: optional string or null` - Checksum of the user's synced settings after this change. + Withdrawn — never populated. - `organization_id: optional string or null` @@ -27996,17 +27769,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_checksum: optional string or null` + - `previous_value: optional string or null` - Checksum of the user's synced settings before this change; null when the store did not exist. + Withdrawn — never populated. - - `type: optional "claude_code_user_settings_updated"` + - `type: optional "claude_code_user_marketplaces_updated"` - default: claude_code_user_settings_updated + default: claude_code_user_marketplaces_updated - - `ClaudeFileAccessFailed object` + - `ClaudeCodeUserMemoryUpdated object` - A user was denied access to a file in Claude.ai. + A user's synced private Claude Code memory was updated or deleted on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28219,27 +27992,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` + - `deleted_all: boolean` - The file the user was denied access to, e.g. "claude_file_01HX...". + True when the user's entire synced memory for this scope was deleted in one request. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_id: optional string or null` + - `created_at: optional string` - The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + When this activity occurred. - - `claude_project_id: optional string or null` + format: date-time - The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `keys_deleted: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_deleted_count`. - When this activity occurred. + - `keys_deleted_count: optional number or null` - format: date-time + Number of memory file paths removed. + + - `keys_written: optional array of string` + + Withdrawn — never populated. See `keys_written_count`. + + - `keys_written_count: optional number or null` + + Number of memory file paths created or updated. + + - `new_checksum: optional string or null` + + Checksum of the user's synced memory after this change. - `organization_id: optional string or null` @@ -28249,19 +28034,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_access_failed"` + - `previous_checksum: optional string or null` - default: claude_file_access_failed + Checksum of the user's synced memory before this change; null when the store did not exist. - - `filename: optional string or null` + - `repo: optional string or null` - **Deprecated** + Withdrawn — never populated. - Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + - `type: optional "claude_code_user_memory_updated"` - - `ClaudeFileExported object` + default: claude_code_user_memory_updated - A file was exported from Claude to an external storage destination. + - `ClaudeCodeUserPluginsUpdated object` + + A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28474,35 +28261,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `export_destination: "google_drive" or "unspecified"` + - `deleted_all: boolean` - The external destination the file was exported to. + True when all of the user's plugin selections were removed in one request. - - `"google_drive"` + - `id: optional string` - - `"unspecified"` + Unique identifier for the activity e.g. 'activity_abcd1234' - - `filename: string` + - `created_at: optional string` - Name of the exported file. + When this activity occurred. - - `id: optional string` + format: date-time - Unique identifier for the activity e.g. 'activity_abcd1234' + - `keys_deleted: optional array of string` - - `claude_chat_id: optional string or null` + Withdrawn — never populated. See `keys_deleted_count`. - The chat conversation the file was exported from, if the export originated in a chat, e.g. "claude_chat_01HX...". + - `keys_deleted_count: optional number or null` - - `claude_file_id: optional string or null` + Number of plugin selections removed. - The exported file, e.g. "claude_file_01HX...", if the file has a stored file record; files that exist only inside a session have no file ID. + - `keys_written: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_written_count`. - When this activity occurred. + - `keys_written_count: optional number or null` - format: date-time + Number of plugin selections added or whose enabled state changed. + + - `new_value: optional string or null` + + The targeted plugin's new enabled state, when a single plugin's state changed. - `organization_id: optional string or null` @@ -28512,13 +28303,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_exported"` + - `previous_value: optional string or null` - default: claude_file_exported + The targeted plugin's previous enabled state, when a single plugin's state changed; null when the plugin did not previously exist or multiple plugins changed. - - `ClaudeFileViewed object` + - `type: optional "claude_code_user_plugins_updated"` - A user viewed a file in Claude.ai. + default: claude_code_user_plugins_updated + + - `ClaudeCodeUserSettingsUpdated object` + + A user's synced Claude Code settings were updated or deleted on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28731,27 +28526,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` + - `deleted_all: boolean` - The file that was viewed, e.g. "claude_file_01HX...". + True when the user's entire synced settings store was deleted in one request. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_id: optional string or null` + - `created_at: optional string` - The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + When this activity occurred. - - `claude_project_id: optional string or null` + format: date-time - The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `keys_deleted: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_deleted_count`. - When this activity occurred. + - `keys_deleted_count: optional number or null` - format: date-time + Number of settings entries removed. + + - `keys_written: optional array of string` + + Withdrawn — never populated. See `keys_written_count`. + + - `keys_written_count: optional number or null` + + Number of settings entries created or updated. + + - `new_checksum: optional string or null` + + Checksum of the user's synced settings after this change. - `organization_id: optional string or null` @@ -28761,19 +28568,27 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_viewed"` + - `previous_checksum: optional string or null` - default: claude_file_viewed + Checksum of the user's synced settings before this change; null when the store did not exist. - - `filename: optional string or null` + - `type: optional "claude_code_user_settings_updated"` - **Deprecated** + default: claude_code_user_settings_updated - Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + - `ClaudeEnterpriseUpgradeCreditUpdated object` - - `ClaudeProjectSyncSourceCreated object` + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. - A sync source was connected to a Claude project's knowledge base. + - `action: "cancelled" or "resumed" or "unspecified"` + + Whether the credit was cancelled or turned back on + + - `"cancelled"` + + - `"resumed"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -28986,18 +28801,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` - - Tagged ID of the project the sync source was connected to. - - - `claude_project_sync_source_id: string` - - Tagged ID of the per-project sync source that was created. - - - `provider: string` - - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -29016,17 +28819,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_project_sync_source_created"` + - `type: optional "claude_enterprise_upgrade_credit_updated"` - default: claude_project_sync_source_created + default: claude_enterprise_upgrade_credit_updated - - `ClaudeProjectSyncSourceDeleted object` + - `ClaudeFileAccessFailed object` - A sync source was disconnected from a Claude project's knowledge base. + A user was denied access to a file in Claude.ai. - `actor: object or object or object or 8 more` @@ -29239,21 +29038,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `claude_file_id: string` - Tagged ID of the project the sync source was disconnected from. + The file the user was denied access to, e.g. "claude_file_01HX...". - - `claude_project_sync_source_id: string` + - `id: optional string` - Tagged ID of the per-project sync source that was deleted. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `provider: string` + - `claude_artifact_id: optional string or null` - The external provider backing the sync source. Always `unspecified` for deletion events. + The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". - - `id: optional string` + - `claude_project_id: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The project the file was accessed through, if any, e.g. "claude_proj_01HX...". - `created_at: optional string` @@ -29269,13 +29068,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_sync_source_deleted"` + - `type: optional "claude_file_access_failed"` - default: claude_project_sync_source_deleted + default: claude_file_access_failed - - `ClaudeProjectSyncSourceUpdated object` + - `filename: optional string or null` - A Claude project sync source's configuration was updated. + **Deprecated** + + Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + + - `ClaudeFileExported object` + + A file was exported from Claude to an external storage destination. - `actor: object or object or object or 8 more` @@ -29488,25 +29293,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `export_destination: "google_drive" or "unspecified"` - Tagged ID of the project the sync source belongs to. + The external destination the file was exported to. - - `claude_project_sync_source_id: string` + - `"google_drive"` - Tagged ID of the per-project sync source that was updated. + - `"unspecified"` - - `provider: string` + - `filename: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + Name of the exported file. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `config_changed: optional boolean or null` + - `claude_chat_id: optional string or null` - Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. + The chat conversation the file was exported from, if the export originated in a chat, e.g. "claude_chat_01HX...". + + - `claude_file_id: optional string or null` + + The exported file, e.g. "claude_file_01HX...", if the file has a stored file record; files that exist only inside a session have no file ID. - `created_at: optional string` @@ -29522,17 +29331,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_project_sync_source_updated"` + - `type: optional "claude_file_exported"` - default: claude_project_sync_source_updated + default: claude_file_exported - - `ClaudeUserSeatTierUpdated object` + - `ClaudeFileViewed object` - An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed. + A user viewed a file in Claude.ai. - `actor: object or object or object or 8 more` @@ -29745,28 +29550,28 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_email: string` - - Email address of the member at the time of the change. - - - `user_id: string` + - `claude_file_id: string` - Tagged ID of the member whose seat tier changed. + The file that was viewed, e.g. "claude_file_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_artifact_id: optional string or null` + + The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + + - `claude_project_id: optional string or null` + + The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time - - `current_seat_tier: optional string or null` - - The member's seat tier after this change, or null if the seat was removed. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -29775,17 +29580,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_seat_tier: optional string or null` + - `type: optional "claude_file_viewed"` - The member's seat tier before this change, or null if no seat was assigned. + default: claude_file_viewed - - `type: optional "claude_user_seat_tier_updated"` + - `filename: optional string or null` - default: claude_user_seat_tier_updated + **Deprecated** - - `CliPluginExecPolicyUpdated object` + Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. - Admin set or cleared the per-op permission ceiling for a plugin CLI. + - `ClaudeProjectSyncSourceCreated object` + + A sync source was connected to a Claude project's knowledge base. - `actor: object or object or object or 8 more` @@ -29998,25 +29805,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cli_name: string` - - CLI name as declared by the plugin manifest - - - `marketplace_id: string` - - Marketplace ID owning the plugin - - - `op_name: string` + - `claude_project_id: string` - Op name (or '*' for the per-CLI default) + Tagged ID of the project the sync source was connected to. - - `plugin_id: string` + - `claude_project_sync_source_id: string` - Plugin ID resolved from the URL + Tagged ID of the per-project sync source that was created. - - `plugin_name: string` + - `provider: string` - Plugin name within its marketplace + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - `id: optional string` @@ -30028,10 +29827,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `max_permission: optional string or null` - - New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -30040,17 +29835,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_max_permission: optional string or null` + - `resource_descriptor: optional string or null` - Max permission the op had before this change ('allow' | 'ask' | 'blocked'), or null when no policy existed for the op + A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `type: optional "cli_plugin_exec_policy_updated"` + - `type: optional "claude_project_sync_source_created"` - default: cli_plugin_exec_policy_updated + default: claude_project_sync_source_created - - `ClaudeCommandCreated object` + - `ClaudeProjectSyncSourceDeleted object` - Command was created. + A sync source was disconnected from a Claude project's knowledge base. - `actor: object or object or object or 8 more` @@ -30263,13 +30058,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `claude_project_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the project the sync source was disconnected from. - - `command_id: optional string or null` + - `claude_project_sync_source_id: string` - - `command_name: optional string or null` + Tagged ID of the per-project sync source that was deleted. + + - `provider: string` + + The external provider backing the sync source. Always `unspecified` for deletion events. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -30285,13 +30088,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_created"` + - `type: optional "claude_project_sync_source_deleted"` - default: claude_command_created + default: claude_project_sync_source_deleted - - `ClaudeCommandDeleted object` + - `ClaudeProjectSyncSourceUpdated object` - Command was deleted. + A Claude project sync source's configuration was updated. - `actor: object or object or object or 8 more` @@ -30504,13 +30307,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_project_id: string` + + Tagged ID of the project the sync source belongs to. + + - `claude_project_sync_source_id: string` + + Tagged ID of the per-project sync source that was updated. + + - `provider: string` + + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `command_id: optional string or null` + - `config_changed: optional boolean or null` - - `command_name: optional string or null` + Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - `created_at: optional string` @@ -30526,13 +30341,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_deleted"` + - `resource_descriptor: optional string or null` - default: claude_command_deleted + A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `ClaudeCommandReplaced object` + - `type: optional "claude_project_sync_source_updated"` - Command was replaced. + default: claude_project_sync_source_updated + + - `ClaudeUserSeatTierUpdated object` + + An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed. - `actor: object or object or object or 8 more` @@ -30745,13 +30564,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `user_email: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Email address of the member at the time of the change. - - `command_id: optional string or null` + - `user_id: string` - - `command_name: optional string or null` + Tagged ID of the member whose seat tier changed. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -30759,6 +30582,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_seat_tier: optional string or null` + + The member's seat tier after this change, or null if the seat was removed. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -30767,13 +30594,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_replaced"` + - `previous_seat_tier: optional string or null` - default: claude_command_replaced + The member's seat tier before this change, or null if no seat was assigned. - - `ComplianceAPIAccessed object` + - `type: optional "claude_user_seat_tier_updated"` - Logging event auto-generated for each compliance API request. + default: claude_user_seat_tier_updated + + - `CliPluginExecPolicyUpdated object` + + Admin set or cleared the per-op permission ceiling for a plugin CLI. - `actor: object or object or object or 8 more` @@ -30986,23 +30817,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `request_id: string` + - `cli_name: string` - - `request_method: "DELETE" or "GET" or "POST" or "PUT"` + CLI name as declared by the plugin manifest - - `"DELETE"` + - `marketplace_id: string` - - `"GET"` + Marketplace ID owning the plugin - - `"POST"` + - `op_name: string` - - `"PUT"` + Op name (or '*' for the per-CLI default) - - `status_code: number` + - `plugin_id: string` - HTTP status code + Plugin ID resolved from the URL - - `url: string` + - `plugin_name: string` + + Plugin name within its marketplace - `id: optional string` @@ -31014,6 +30847,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `max_permission: optional string or null` + + New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -31022,17 +30859,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `request_body: optional string or null` + - `previous_max_permission: optional string or null` - Serialized JSON request body + Max permission the op had before this change ('allow' | 'ask' | 'blocked'), or null when no policy existed for the op - - `type: optional "compliance_api_accessed"` + - `type: optional "cli_plugin_exec_policy_updated"` - default: compliance_api_accessed + default: cli_plugin_exec_policy_updated - - `CoworkSessionUpdated object` + - `ClaudeCommandCreated object` - A Cowork session was updated. + Command was created. - `actor: object or object or object or 8 more` @@ -31245,17 +31082,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cowork_session_id: string` - - Tagged ID of the updated session, e.g. "sess_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` + - `command_id: optional string or null` - Tagged ID of the project the session was moved to, if any, e.g. "claude_proj_01HX...". Absent when the session was removed from its project. + - `command_name: optional string or null` - `created_at: optional string` @@ -31271,13 +31104,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "cowork_session_updated"` + - `type: optional "claude_command_created"` - default: cowork_session_updated + default: claude_command_created - - `DesignProjectArtifactPublished object` + - `ClaudeCommandDeleted object` - A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings. + Command was deleted. - `actor: object or object or object or 8 more` @@ -31490,24 +31323,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project whose content was published, e.g. "design_proj_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `command_id: optional string or null` + + - `command_name: optional string or null` + - `created_at: optional string` When this activity occurred. format: date-time - - `is_public: optional boolean or null` - - True when the published artifact is publicly viewable after this call (anyone with the link). False when it is not — by default, a newly published artifact is visible only to the person who published it. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -31516,17 +31345,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_artifact_published"` + - `type: optional "claude_command_deleted"` - default: design_project_artifact_published + default: claude_command_deleted - - `DesignProjectCreated object` + - `ClaudeCommandReplaced object` - A Claude Design project was created. + Command was replaced. - `actor: object or object or object or 8 more` @@ -31739,18 +31564,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `creation_method: string` - - How the project was created: "direct", "duplicate", "remix", or "template_from_project". - - - `design_project_id: string` - - The Design project that was created, e.g. "design_proj_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `command_id: optional string or null` + + - `command_name: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -31765,21 +31586,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project type: "project", "template", or "design_system". - - - `source_project_id: optional string or null` - - The source project this was created from, when created via duplicate, remix, or template-from-project. Unset for direct creation. - - - `type: optional "design_project_created"` + - `type: optional "claude_command_replaced"` - default: design_project_created + default: claude_command_replaced - - `DesignProjectDeleted object` + - `ComplianceAPIAccessed object` - A Claude Design project was deleted. + Logging event auto-generated for each compliance API request. - `actor: object or object or object or 8 more` @@ -31992,9 +31805,31 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` + - `request_id: string` - The Design project that was deleted, e.g. "design_proj_01HX...". + Identifier of the request, as returned in the response's request-id header + + - `request_method: "DELETE" or "GET" or "POST" or 2 more` + + HTTP method of the request + + - `"DELETE"` + + - `"GET"` + + - `"POST"` + + - `"PUT"` + + - `"unspecified"` + + - `status_code: number` + + HTTP status code + + - `url: string` + + Full URL that was requested, including any query string - `id: optional string` @@ -32014,13 +31849,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "design_project_deleted"` + - `request_body: optional string or null` - default: design_project_deleted + Serialized JSON request body - - `DesignProjectMemberAdded object` + - `type: optional "compliance_api_accessed"` - A member was granted access to a Claude Design project. + default: compliance_api_accessed + + - `CoworkSessionUpdated object` + + A Cowork session was updated. - `actor: object or object or object or 8 more` @@ -32233,26 +32072,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project the member was added to, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` - - The kind of member that was added: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). - - - `role: string` + - `cowork_session_id: string` - The role the member was granted: "viewer", "commenter", or "editor". Access-group ("compartment") members are always view-only. + Tagged ID of the updated session, e.g. "sess_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the session was moved to, if any, e.g. "claude_proj_01HX...". Absent when the session was removed from its project. + - `created_at: optional string` When this activity occurred. @@ -32267,17 +32098,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_member_added"` + - `type: optional "cowork_session_updated"` - default: design_project_member_added + default: cowork_session_updated - - `DesignProjectMemberRemoved object` + - `DesignProjectArtifactPublished object` - A member's access to a Claude Design project was revoked. + A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings. - `actor: object or object or object or 8 more` @@ -32492,15 +32319,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project the member was removed from, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` - - The kind of member that was removed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + The Design project whose content was published, e.g. "design_proj_01HX...". - `id: optional string` @@ -32512,6 +32331,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `is_public: optional boolean or null` + + True when the published artifact is publicly viewable after this call (anyone with the link). False when it is not — by default, a newly published artifact is visible only to the person who published it. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -32524,13 +32347,13 @@ compliance activities that can be filtered by various criteria. The project's type: "project", "template", or "design_system". - - `type: optional "design_project_member_removed"` + - `type: optional "design_project_artifact_published"` - default: design_project_member_removed + default: design_project_artifact_published - - `DesignProjectMemberRoleUpdated object` + - `DesignProjectCreated object` - A Claude Design project member's role was changed. + A Claude Design project was created. - `actor: object or object or object or 8 more` @@ -32743,21 +32566,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project the member belongs to, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` + - `creation_method: string` - The kind of member whose role was changed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + How the project was created: "direct", "duplicate", "remix", or "template_from_project". - - `role: string` + - `design_project_id: string` - The member's role after the change: "viewer", "commenter", or "editor". + The Design project that was created, e.g. "design_proj_01HX...". - `id: optional string` @@ -32777,21 +32592,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_role: optional string or null` + - `project_type: optional string or null` - The member's role before the change. + The project type: "project", "template", or "design_system". - - `project_type: optional string or null` + - `source_project_id: optional string or null` - The project's type: "project", "template", or "design_system". + The source project this was created from, when created via duplicate, remix, or template-from-project. Unset for direct creation. - - `type: optional "design_project_member_role_updated"` + - `type: optional "design_project_created"` - default: design_project_member_role_updated + default: design_project_created - - `DesignProjectPublished object` + - `DesignProjectDeleted object` - A Claude Design template or design system was published, making it discoverable by everyone in its organization. + A Claude Design project was deleted. - `actor: object or object or object or 8 more` @@ -33006,7 +32821,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was published, e.g. "design_proj_01HX...". + The Design project that was deleted, e.g. "design_proj_01HX...". - `id: optional string` @@ -33026,17 +32841,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "template" or "design_system". - - - `type: optional "design_project_published"` + - `type: optional "design_project_deleted"` - default: design_project_published + default: design_project_deleted - - `DesignProjectSharingUpdated object` + - `DesignProjectMemberAdded object` - A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added). + A member was granted access to a Claude Design project. - `actor: object or object or object or 8 more` @@ -33251,15 +33062,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project whose sharing settings changed, e.g. "design_proj_01HX...". + The Design project the member was added to, e.g. "design_proj_01HX...". - - `new_link_permission: string` + - `principal_id: string` - What people opening the project through its link may do after the change: "view", "comment", or "edit". + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - `new_scope: string` + - `principal_type: string` - Who the project link is set to work for after the change: "invited" (only the owner and individually invited members) or "org" (anyone in the project's organization, where the organization's own sharing settings allow org-wide visibility). This records the project's stored setting as changed by the actor; organization-level settings can further restrict who the link actually admits, and changes to those settings are not project events. Projects created before link sharing was restricted may also report a legacy "public" value. + The kind of member that was added: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + + - `role: string` + + The role the member was granted: "viewer", "commenter", or "editor". Access-group ("compartment") members are always view-only. - `id: optional string` @@ -33279,25 +33094,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_link_permission: optional string or null` - - What people opening the project through its link could do before the change. - - - `previous_scope: optional string or null` - - Who the project link was set to work for before the change — the stored setting, with the same organization-level caveat as new_scope. May include the legacy "public" value. - - `project_type: optional string or null` The project's type: "project", "template", or "design_system". - - `type: optional "design_project_sharing_updated"` + - `type: optional "design_project_member_added"` - default: design_project_sharing_updated + default: design_project_member_added - - `DesignProjectUnpublished object` + - `DesignProjectMemberRemoved object` - A Claude Design template or design system was unpublished, removing it from its organization's shared gallery. + A member's access to a Claude Design project was revoked. - `actor: object or object or object or 8 more` @@ -33512,7 +33319,15 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was unpublished, e.g. "design_proj_01HX...". + The Design project the member was removed from, e.g. "design_proj_01HX...". + + - `principal_id: string` + + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". + + - `principal_type: string` + + The kind of member that was removed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). - `id: optional string` @@ -33534,15 +33349,15 @@ compliance activities that can be filtered by various criteria. - `project_type: optional string or null` - The project's type: "template" or "design_system". + The project's type: "project", "template", or "design_system". - - `type: optional "design_project_unpublished"` + - `type: optional "design_project_member_removed"` - default: design_project_unpublished + default: design_project_member_removed - - `DesignProjectUpdated object` + - `DesignProjectMemberRoleUpdated object` - A Claude Design project's metadata was updated. + A Claude Design project member's role was changed. - `actor: object or object or object or 8 more` @@ -33757,7 +33572,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was updated, e.g. "design_proj_01HX...". + The Design project the member belongs to, e.g. "design_proj_01HX...". + + - `principal_id: string` + + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". + + - `principal_type: string` + + The kind of member whose role was changed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + + - `role: string` + + The member's role after the change: "viewer", "commenter", or "editor". - `id: optional string` @@ -33777,21 +33604,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` + - `previous_role: optional string or null` - The project's type after the update: "project", "template", or "design_system". Present only when the update changed it. + The member's role before the change. - - `type: optional "design_project_updated"` + - `project_type: optional string or null` - default: design_project_updated + The project's type: "project", "template", or "design_system". - - `updated_fields: optional array of string` + - `type: optional "design_project_member_role_updated"` - Names of the fields changed by this update, e.g. "name", "description", "project_type", "design_systems". + default: design_project_member_role_updated - - `DesignProjectVersionRestored object` + - `DesignProjectPublished object` - A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files. + A Claude Design template or design system was published, making it discoverable by everyone in its organization. - `actor: object or object or object or 8 more` @@ -34006,7 +33833,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was restored, e.g. "design_proj_01HX...". + The Design project that was published, e.g. "design_proj_01HX...". - `id: optional string` @@ -34028,19 +33855,15 @@ compliance activities that can be filtered by various criteria. - `project_type: optional string or null` - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_version_restored"` + The project's type: "template" or "design_system". - default: design_project_version_restored + - `type: optional "design_project_published"` - - `DesignProjectViewed object` + default: design_project_published - A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader. + - `DesignProjectSharingUpdated object` - This activity type is retired: project content reads are no longer - recorded. Events of this type may still appear in feeds for reads that - occurred while it was active. + A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added). - `actor: object or object or object or 8 more` @@ -34255,19 +34078,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project whose content was read, e.g. "design_proj_01HX...". + The Design project whose sharing settings changed, e.g. "design_proj_01HX...". - - `surface: string` + - `new_link_permission: string` - Which read surface recorded this open: "project" (the project was opened), "project_data" (the project's full contents were read or made readable — either a direct data read, which also includes the project's conversations when the reader's access extends to them, or a render-token request, which exposes the project's files for the token's lifetime; the two share this value and are not distinguished), "file" (one of the project's files was read), "version" (a saved version of the project's files, including their contents, was read — version-history browsing that lists names without contents is not recorded), or "export" (an authenticated export of the project's contents was requested). + What people opening the project through its link may do after the change: "view", "comment", or "edit". - - `id: optional string` + - `new_scope: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Who the project link is set to work for after the change: "invited" (only the owner and individually invited members) or "org" (anyone in the project's organization, where the organization's own sharing settings allow org-wide visibility). This records the project's stored setting as changed by the actor; organization-level settings can further restrict who the link actually admits, and changes to those settings are not project events. Projects created before link sharing was restricted may also report a legacy "public" value. - - `access_via: optional string or null` + - `id: optional string` - How the viewer was authorized to open the project: "owner" (the project's owner), "member_grant" (an individually invited member), "org_link" (org-wide link sharing), "trusted_service" (an authorized agent), or "design_system_reference" (an indirect read of a design system through a project that uses it). + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -34283,17 +34106,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `previous_link_permission: optional string or null` + + What people opening the project through its link could do before the change. + + - `previous_scope: optional string or null` + + Who the project link was set to work for before the change — the stored setting, with the same organization-level caveat as new_scope. May include the legacy "public" value. + - `project_type: optional string or null` The project's type: "project", "template", or "design_system". - - `type: optional "design_project_viewed"` + - `type: optional "design_project_sharing_updated"` - default: design_project_viewed + default: design_project_sharing_updated - - `DesktopExtensionAllowlisted object` + - `DesignProjectUnpublished object` - A desktop extension was added to an org's allowlist. + A Claude Design template or design system was unpublished, removing it from its organization's shared gallery. - `actor: object or object or object or 8 more` @@ -34506,9 +34337,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - Allowlisted DXT extension ID + The Design project that was unpublished, e.g. "design_proj_01HX...". - `id: optional string` @@ -34528,13 +34359,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_allowlisted"` + - `project_type: optional string or null` - default: desktop_extension_allowlisted + The project's type: "template" or "design_system". - - `DesktopExtensionBlocklisted object` + - `type: optional "design_project_unpublished"` - A desktop extension was added to the global blocklist. + default: design_project_unpublished + + - `DesignProjectUpdated object` + + A Claude Design project's metadata was updated. - `actor: object or object or object or 8 more` @@ -34747,9 +34582,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - Blocklisted DXT extension ID + The Design project that was updated, e.g. "design_proj_01HX...". - `id: optional string` @@ -34769,13 +34604,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_blocklisted"` + - `project_type: optional string or null` - default: desktop_extension_blocklisted + The project's type after the update: "project", "template", or "design_system". Present only when the update changed it. - - `DesktopExtensionDeleted object` + - `type: optional "design_project_updated"` - A desktop extension was deleted, either globally by an admin or org-scoped by an org owner. + default: design_project_updated + + - `updated_fields: optional array of string` + + Names of the fields changed by this update, e.g. "name", "description", "project_type", "design_systems". + + - `DesignProjectVersionRestored object` + + A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files. - `actor: object or object or object or 8 more` @@ -34988,9 +34831,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - DXT extension ID + The Design project that was restored, e.g. "design_proj_01HX...". - `id: optional string` @@ -35010,17 +34853,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_deleted"` + - `project_type: optional string or null` - default: desktop_extension_deleted + The project's type: "project", "template", or "design_system". - - `version: optional string or null` + - `type: optional "design_project_version_restored"` - Specific version deleted (null if all versions) + default: design_project_version_restored - - `DesktopExtensionRemovedFromAllowlist object` + - `DesignProjectViewed object` - A desktop extension was removed from an org's allowlist. + A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader. + + This activity type is retired: project content reads are no longer + recorded. Events of this type may still appear in feeds for reads that + occurred while it was active. - `actor: object or object or object or 8 more` @@ -35233,14 +35080,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - DXT extension ID removed from allowlist + The Design project whose content was read, e.g. "design_proj_01HX...". + + - `surface: string` + + Which read surface recorded this open: "project" (the project was opened), "project_data" (the project's full contents were read or made readable — either a direct data read, which also includes the project's conversations when the reader's access extends to them, or a render-token request, which exposes the project's files for the token's lifetime; the two share this value and are not distinguished), "file" (one of the project's files was read), "version" (a saved version of the project's files, including their contents, was read — version-history browsing that lists names without contents is not recorded), or "export" (an authenticated export of the project's contents was requested). - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_via: optional string or null` + + How the viewer was authorized to open the project: "owner" (the project's owner), "member_grant" (an individually invited member), "org_link" (org-wide link sharing), "trusted_service" (an authorized agent), or "design_system_reference" (an indirect read of a design system through a project that uses it). + - `created_at: optional string` When this activity occurred. @@ -35255,13 +35110,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_removed_from_allowlist"` + - `project_type: optional string or null` - default: desktop_extension_removed_from_allowlist + The project's type: "project", "template", or "design_system". - - `DesktopExtensionUnblocked object` + - `type: optional "design_project_viewed"` - A desktop extension was removed from the global blocklist. + default: design_project_viewed + + - `DesktopExtensionAllowlisted object` + + A desktop extension was added to an org's allowlist. - `actor: object or object or object or 8 more` @@ -35476,7 +35335,7 @@ compliance activities that can be filtered by various criteria. - `extension_id: string` - Unblocked DXT extension ID + Allowlisted DXT extension ID - `id: optional string` @@ -35496,13 +35355,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_unblocked"` + - `type: optional "desktop_extension_allowlisted"` - default: desktop_extension_unblocked + default: desktop_extension_allowlisted - - `DesktopExtensionUploaded object` + - `DesktopExtensionBlocklisted object` - A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner. + A desktop extension was added to the global blocklist. - `actor: object or object or object or 8 more` @@ -35717,11 +35576,7 @@ compliance activities that can be filtered by various criteria. - `extension_id: string` - DXT extension ID - - - `version: string` - - Version string from the manifest + Blocklisted DXT extension ID - `id: optional string` @@ -35741,13 +35596,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_uploaded"` + - `type: optional "desktop_extension_blocklisted"` - default: desktop_extension_uploaded + default: desktop_extension_blocklisted - - `DesktopExtensionVersionUploaded object` + - `DesktopExtensionDeleted object` - A new version of an existing org-owned desktop extension was uploaded. + A desktop extension was deleted, either globally by an admin or org-scoped by an org owner. - `actor: object or object or object or 8 more` @@ -35964,10 +35819,6 @@ compliance activities that can be filtered by various criteria. DXT extension ID - - `version: string` - - Version string from the manifest - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -35986,14 +35837,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_version_uploaded"` + - `type: optional "desktop_extension_deleted"` - default: desktop_extension_version_uploaded + default: desktop_extension_deleted - - `InferenceHooksConfigDeleted object` + - `version: optional string or null` - Inference hooks configuration was removed for the - organization. + Specific version deleted (null if all versions) + + - `DesktopExtensionRemovedFromAllowlist object` + + A desktop extension was removed from an org's allowlist. - `actor: object or object or object or 8 more` @@ -36206,6 +36060,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `extension_id: string` + + DXT extension ID removed from allowlist + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -36224,14 +36082,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "inference_hooks_config_deleted"` + - `type: optional "desktop_extension_removed_from_allowlist"` - default: inference_hooks_config_deleted + default: desktop_extension_removed_from_allowlist - - `InferenceHooksConfigUpdated object` + - `DesktopExtensionUnblocked object` - Inference hooks configuration was created or updated for the - organization. + A desktop extension was removed from the global blocklist. - `actor: object or object or object or 8 more` @@ -36444,29 +36301,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - Whether Inference hooks enforcement is enabled after this change. - - - `enforcement_mode: string` - - Whether Inference hooks inspects both prompts and responses (prompt_and_response) or prompts only (prompt_only). - - - `fail_mode: string` - - Whether requests are allowed (fail_open) or blocked (fail_closed) when the Inference hooks endpoint cannot be reached. - - - `final_verdict_timeout_ms: number` - - Milliseconds inference waits for the Inference hooks verdict on the response. - - - `prompt_verdict_timeout_ms: number` - - Milliseconds inference waits for the Inference hooks verdict on the prompt. - - - `webhook_url: string` + - `extension_id: string` - The endpoint that inspected prompts and responses are sent to. + Unblocked DXT extension ID - `id: optional string` @@ -36478,20 +36315,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `deny_message: optional string or null` - - Administrator-written text shown to users at the end of the error message when a request is blocked by the organization's Inference hooks policy, as configured after this change. Null when the built-in default message is in effect; an empty string when the administrator configured an empty message, in which case no text is appended. - - - `deny_message_enabled: optional boolean` - - Whether the organization has the appended deny message turned on, as configured after this change. When on, the administrator-written message (or the built-in default, when none is configured) is appended to the error users see when a request is blocked by the organization's Inference hooks policy; no text is appended when the administrator-written message is empty, or when this is off. - - default: true - - - `extra_header_names: optional array of string or null` - - Names of the custom HTTP headers attached to every Inference hooks request after this change, or null when this update did not change headers. Header values are write-only and are not recorded. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -36500,28 +36323,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reset_circuit_breaker: optional boolean` - - Whether this update carried an explicit request to clear the circuit breaker. A tripped breaker otherwise survives configuration updates; it also clears whenever an update enables enforcement. - - default: false - - - `rollout_percentage: optional number or null` - - Percentage of requests (0-100) inspected by Inference hooks after this change, or null when this update did not change it. 0 disables inspection; 100 inspects every request. - - - `shadow_mode: optional boolean or null` - - Whether the organization's Inference hooks run in shadow mode after this change, or null when this update did not change it. In shadow mode, prompts are still sent to the organization's endpoint and verdicts are recorded, but requests are never blocked. - - - `type: optional "inference_hooks_config_updated"` + - `type: optional "desktop_extension_unblocked"` - default: inference_hooks_config_updated + default: desktop_extension_unblocked - - `InferenceHooksSigningSecretGenerated object` + - `DesktopExtensionUploaded object` - A request signing secret was generated for the organization's - Inference hooks configuration. + A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner. - `actor: object or object or object or 8 more` @@ -36734,9 +36542,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `rotated: boolean` + - `extension_id: string` - Whether this generation replaced an existing signing secret (true) or created the organization's first one (false). Replacing a secret invalidates the previous one immediately. + DXT extension ID + + - `version: string` + + Version string from the manifest - `id: optional string` @@ -36756,13 +36568,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "inference_hooks_signing_secret_generated"` + - `type: optional "desktop_extension_uploaded"` - default: inference_hooks_signing_secret_generated + default: desktop_extension_uploaded - - `DomainClaimInitiated object` + - `DesktopExtensionVersionUploaded object` - Domain capture claim initiated over personal accounts on verified domains. + A new version of an existing org-owned desktop extension was uploaded. - `actor: object or object or object or 8 more` @@ -36975,6 +36787,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `extension_id: string` + + DXT extension ID + + - `version: string` + + Version string from the manifest + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -36993,13 +36813,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "domain_claim_initiated"` + - `type: optional "desktop_extension_version_uploaded"` - default: domain_claim_initiated + default: desktop_extension_version_uploaded - - `EndUserInviteRequested object` + - `InferenceHooksConfigDeleted object` - Non-admin member submitted an invite request for a new org member. + Inference hooks configuration was removed for the + organization. - `actor: object or object or object or 8 more` @@ -37212,8 +37033,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37232,13 +37051,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "end_user_invite_requested"` + - `type: optional "inference_hooks_config_deleted"` - default: end_user_invite_requested + default: inference_hooks_config_deleted - - `ExtraUsageBillingEnabled object` + - `InferenceHooksConfigUpdated object` - Usage credit billing was enabled for an organization. + Inference hooks configuration was created or updated for the + organization. - `actor: object or object or object or 8 more` @@ -37451,6 +37271,30 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + + Whether Inference hooks enforcement is enabled after this change. + + - `enforcement_mode: string` + + Whether Inference hooks inspects both prompts and responses (prompt_and_response) or prompts only (prompt_only). + + - `fail_mode: string` + + Whether requests are allowed (fail_open) or blocked (fail_closed) when the Inference hooks endpoint cannot be reached. + + - `final_verdict_timeout_ms: number` + + Milliseconds inference waits for the Inference hooks verdict on the response. + + - `prompt_verdict_timeout_ms: number` + + Milliseconds inference waits for the Inference hooks verdict on the prompt. + + - `webhook_url: string` + + The endpoint that inspected prompts and responses are sent to. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37461,6 +37305,20 @@ compliance activities that can be filtered by various criteria. format: date-time + - `deny_message: optional string or null` + + Administrator-written text shown to users at the end of the error message when a request is blocked by the organization's Inference hooks policy, as configured after this change. Null when the built-in default message is in effect; an empty string when the administrator configured an empty message, in which case no text is appended. + + - `deny_message_enabled: optional boolean` + + Whether the organization has the appended deny message turned on, as configured after this change. When on, the administrator-written message (or the built-in default, when none is configured) is appended to the error users see when a request is blocked by the organization's Inference hooks policy; no text is appended when the administrator-written message is empty, or when this is off. + + default: true + + - `extra_header_names: optional array of string or null` + + Names of the custom HTTP headers attached to every Inference hooks request after this change, or null when this update did not change headers. Header values are write-only and are not recorded. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -37469,13 +37327,28 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "extra_usage_billing_enabled"` + - `reset_circuit_breaker: optional boolean` - default: extra_usage_billing_enabled + Whether this update carried an explicit request to clear the circuit breaker. A tripped breaker otherwise survives configuration updates; it also clears whenever an update enables enforcement. - - `ExtraUsageCreditGranted object` + default: false - A promotional usage credit grant was claimed. + - `rollout_percentage: optional number or null` + + Percentage of requests (0-100) inspected by Inference hooks after this change, or null when this update did not change it. 0 disables inspection; 100 inspects every request. + + - `shadow_mode: optional boolean or null` + + Whether the organization's Inference hooks run in shadow mode after this change, or null when this update did not change it. In shadow mode, prompts are still sent to the organization's endpoint and verdicts are recorded, but requests are never blocked. + + - `type: optional "inference_hooks_config_updated"` + + default: inference_hooks_config_updated + + - `InferenceHooksSigningSecretGenerated object` + + A request signing secret was generated for the organization's + Inference hooks configuration. - `actor: object or object or object or 8 more` @@ -37688,6 +37561,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `rotated: boolean` + + Whether this generation replaced an existing signing secret (true) or created the organization's first one (false). Replacing a secret invalidates the previous one immediately. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37706,13 +37583,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "extra_usage_credit_granted"` + - `type: optional "inference_hooks_signing_secret_generated"` - default: extra_usage_credit_granted + default: inference_hooks_signing_secret_generated - - `ExtraUsageSpendLimitCreated object` + - `DomainClaimInitiated object` - Usage credit spend limit was created. + Domain capture claim initiated over personal accounts on verified domains. - `actor: object or object or object or 8 more` @@ -37929,24 +37806,12 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `amount: optional number or null` - - The monthly credit limit amount in minor units (e.g. cents). - - `created_at: optional string` When this activity occurred. format: date-time - - `is_enabled: optional boolean or null` - - Whether the spend limit is enabled. - - - `limit_type: optional string or null` - - The type of spend limit created (e.g. organization, seat_tier, member, service, group). - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -37955,23 +37820,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - Tagged ID of the spend limit. - - - `type: optional "extra_usage_spend_limit_created"` - - default: extra_usage_spend_limit_created - - - `user_id: optional string or null` - - **Deprecated** + - `type: optional "domain_claim_initiated"` - Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + default: domain_claim_initiated - - `ExtraUsageSpendLimitDeleted object` + - `EndUserInviteRequested object` - Usage credit spend limit was deleted. + Non-admin member submitted an invite request for a new org member. - `actor: object or object or object or 8 more` @@ -38184,6 +38039,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invitee_email: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -38202,23 +38059,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - Tagged ID of the spend limit. - - - `type: optional "extra_usage_spend_limit_deleted"` - - default: extra_usage_spend_limit_deleted - - - `user_id: optional string or null` - - **Deprecated** + - `type: optional "end_user_invite_requested"` - Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + default: end_user_invite_requested - - `ExtraUsageSpendLimitIncreaseRequestApproved object` + - `ExtraUsageBillingEnabled object` - A usage credit spend limit increase request was approved. + Usage credit billing was enabled for an organization. - `actor: object or object or object or 8 more` @@ -38435,8 +38282,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `amount: optional number or null` - - `created_at: optional string` When this activity occurred. @@ -38451,19 +38296,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `requester_user_id: optional string or null` - - - `spend_limit_id: optional string or null` - - - `spend_limit_increase_request_id: optional string or null` - - - `type: optional "extra_usage_spend_limit_increase_request_approved"` + - `type: optional "extra_usage_billing_enabled"` - default: extra_usage_spend_limit_increase_request_approved + default: extra_usage_billing_enabled - - `ExtraUsageSpendLimitIncreaseRequestDenied object` + - `ExtraUsageCreditGranted object` - A usage credit spend limit increase request was denied. + A promotional usage credit grant was claimed. - `actor: object or object or object or 8 more` @@ -38694,17 +38533,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `requester_user_id: optional string or null` - - - `spend_limit_increase_request_id: optional string or null` - - - `type: optional "extra_usage_spend_limit_increase_request_denied"` + - `type: optional "extra_usage_credit_granted"` - default: extra_usage_spend_limit_increase_request_denied + default: extra_usage_credit_granted - - `ExtraUsageSpendLimitUpdated object` + - `ExtraUsageSpendLimitCreated object` - Usage credit spend limit was updated. + Usage credit spend limit was created. - `actor: object or object or object or 8 more` @@ -38923,7 +38758,7 @@ compliance activities that can be filtered by various criteria. - `amount: optional number or null` - The new monthly credit limit amount in minor units (e.g. cents). + The monthly credit limit amount in minor units (e.g. cents). - `created_at: optional string` @@ -38937,7 +38772,7 @@ compliance activities that can be filtered by various criteria. - `limit_type: optional string or null` - The type of spend limit updated (e.g. organization, seat_tier, member, service, group). + The type of spend limit created (e.g. organization, seat_tier, member, service, group). - `organization_id: optional string or null` @@ -38951,9 +38786,9 @@ compliance activities that can be filtered by various criteria. Tagged ID of the spend limit. - - `type: optional "extra_usage_spend_limit_updated"` + - `type: optional "extra_usage_spend_limit_created"` - default: extra_usage_spend_limit_updated + default: extra_usage_spend_limit_created - `user_id: optional string or null` @@ -38961,9 +38796,9 @@ compliance activities that can be filtered by various criteria. Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. - - `ClaudeFileDeleted object` + - `ExtraUsageSpendLimitDeleted object` - A file was deleted. + Usage credit spend limit was deleted. - `actor: object or object or object or 8 more` @@ -39176,10 +39011,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` - - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -39198,13 +39029,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_deleted"` + - `spend_limit_id: optional string or null` - default: claude_file_deleted + Tagged ID of the spend limit. - - `ClaudeFileUploaded object` + - `type: optional "extra_usage_spend_limit_deleted"` - A file was uploaded. + default: extra_usage_spend_limit_deleted + + - `user_id: optional string or null` + + **Deprecated** + + Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + + - `ExtraUsageSpendLimitIncreaseRequestApproved object` + + A usage credit spend limit increase request was approved. - `actor: object or object or object or 8 more` @@ -39417,21 +39258,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` - - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` - - Chat ID if known at upload time (null for the upload-then-attach flow). To find which chats a file was later attached to, use `GET /v1/compliance/apps/chats/files/{claude_file_id}`. - - - `claude_project_id: optional string or null` - - Project ID if file was uploaded to a project + - `amount: optional number or null` - `created_at: optional string` @@ -39447,13 +39278,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_uploaded"` + - `requester_user_id: optional string or null` - default: claude_file_uploaded + - `spend_limit_id: optional string or null` - - `GheConfigurationCreated object` + - `spend_limit_increase_request_id: optional string or null` - Admin created a GHE configuration. + - `type: optional "extra_usage_spend_limit_increase_request_approved"` + + default: extra_usage_spend_limit_increase_request_approved + + - `ExtraUsageSpendLimitIncreaseRequestDenied object` + + A usage credit spend limit increase request was denied. - `actor: object or object or object or 8 more` @@ -39666,10 +39503,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` - - ID of the GHE configuration - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -39680,14 +39513,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `display_name: optional string or null` - - Display name given to the configuration - - - `hostname: optional string or null` - - Hostname of the GitHub Enterprise instance - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -39696,17 +39521,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` + - `requester_user_id: optional string or null` - Custom port, if not the HTTPS default + - `spend_limit_increase_request_id: optional string or null` - - `type: optional "ghe_configuration_created"` + - `type: optional "extra_usage_spend_limit_increase_request_denied"` - default: ghe_configuration_created + default: extra_usage_spend_limit_increase_request_denied - - `GheConfigurationDeleted object` + - `ExtraUsageSpendLimitUpdated object` - Admin deleted a GHE configuration. + Usage credit spend limit was updated. - `actor: object or object or object or 8 more` @@ -39919,27 +39744,27 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` - - ID of the GHE configuration - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `amount: optional number or null` + + The new monthly credit limit amount in minor units (e.g. cents). + - `created_at: optional string` When this activity occurred. format: date-time - - `display_name: optional string or null` + - `is_enabled: optional boolean or null` - Display name the configuration had when deleted + Whether the spend limit is enabled. - - `hostname: optional string or null` + - `limit_type: optional string or null` - Hostname of the GitHub Enterprise instance + The type of spend limit updated (e.g. organization, seat_tier, member, service, group). - `organization_id: optional string or null` @@ -39949,17 +39774,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` + - `spend_limit_id: optional string or null` - Custom port, if not the HTTPS default + Tagged ID of the spend limit. - - `type: optional "ghe_configuration_deleted"` + - `type: optional "extra_usage_spend_limit_updated"` - default: ghe_configuration_deleted + default: extra_usage_spend_limit_updated - - `GheConfigurationUpdated object` + - `user_id: optional string or null` - Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced. + **Deprecated** + + Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + + - `ClaudeFileDeleted object` + + A file was deleted. - `actor: object or object or object or 8 more` @@ -40172,9 +40003,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` + - `claude_file_id: string` - ID of the GHE configuration + - `filename: string or null` - `id: optional string` @@ -40186,38 +40017,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `custom_ca_certificate_updated: optional boolean or null` - - Whether the custom CA certificate was replaced in this update - - - `display_name: optional string or null` - - New display name, when it changed - - - `github_app_client_id: optional string or null` - - New GitHub App client ID, when it changed - - - `github_app_client_secret_updated: optional boolean or null` - - Whether the GitHub App client secret was replaced in this update - - - `github_app_id: optional number or null` - - New GitHub App ID, when it changed - - - `github_app_private_key_updated: optional boolean or null` - - Whether the GitHub App private key was replaced in this update - - - `hostname: optional string or null` - - Hostname of the GitHub Enterprise instance (immutable; included for context) - - - `is_active: optional boolean or null` - - New active state, when it changed - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40226,45 +40025,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` - - New port, when it changed - - - `previous_display_name: optional string or null` - - Display name before the change, when it changed - - - `previous_github_app_client_id: optional string or null` - - GitHub App client ID before the change, when it changed - - - `previous_github_app_id: optional number or null` - - GitHub App ID before the change, when it changed - - - `previous_is_active: optional boolean or null` - - Active state before the change, when it changed - - - `previous_port: optional number or null` - - Port before the change, when it changed - - - `read_replica_hostnames_updated: optional boolean or null` - - Whether the read replica hostnames were replaced in this update - - - `type: optional "ghe_configuration_updated"` - - default: ghe_configuration_updated - - - `webhook_secret_updated: optional boolean or null` + - `type: optional "claude_file_deleted"` - Whether the webhook secret was replaced in this update + default: claude_file_deleted - - `GheUserConnected object` + - `ClaudeFileUploaded object` - User connected to a GHE instance. + A file was uploaded. - `actor: object or object or object or 8 more` @@ -40477,20 +40244,28 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_file_id: string` + + - `filename: string or null` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_chat_id: optional string or null` + + Chat ID if known at upload time (null for the upload-then-attach flow). To find which chats a file was later attached to, use `GET /v1/compliance/apps/chats/files/{claude_file_id}`. + + - `claude_project_id: optional string or null` + + Project ID if file was uploaded to a project + - `created_at: optional string` When this activity occurred. format: date-time - - `ghe_configuration_id: optional string or null` - - ID of the GHE configuration - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40499,13 +40274,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_user_connected"` + - `type: optional "claude_file_uploaded"` - default: ghe_user_connected + default: claude_file_uploaded - - `GheUserDisconnected object` + - `GheConfigurationCreated object` - User disconnected from a GHE instance. + Admin created a GHE configuration. - `actor: object or object or object or 8 more` @@ -40718,6 +40493,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `ghe_configuration_id: string` + + ID of the GHE configuration + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -40728,9 +40507,13 @@ compliance activities that can be filtered by various criteria. format: date-time - - `ghe_configuration_id: optional string or null` + - `display_name: optional string or null` - ID of the GHE configuration + Display name given to the configuration + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance - `organization_id: optional string or null` @@ -40740,13 +40523,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_user_disconnected"` + - `port: optional number or null` - default: ghe_user_disconnected + Custom port, if not the HTTPS default - - `GheWebhookSignatureInvalid object` + - `type: optional "ghe_configuration_created"` - Webhook signature validation failed. + default: ghe_configuration_created + + - `GheConfigurationDeleted object` + + Admin deleted a GHE configuration. - `actor: object or object or object or 8 more` @@ -40973,6 +40760,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `display_name: optional string or null` + + Display name the configuration had when deleted + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40981,13 +40776,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_webhook_signature_invalid"` + - `port: optional number or null` - default: ghe_webhook_signature_invalid + Custom port, if not the HTTPS default - - `ClaudeGitHubIntegrationCreated object` + - `type: optional "ghe_configuration_deleted"` - A GitHub integration was enabled for the organization. + default: ghe_configuration_deleted + + - `GheConfigurationUpdated object` + + Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced. - `actor: object or object or object or 8 more` @@ -41200,7 +40999,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` + - `ghe_configuration_id: string` + + ID of the GHE configuration - `id: optional string` @@ -41212,33 +41013,85 @@ compliance activities that can be filtered by various criteria. format: date-time - - `enabled: optional boolean or null` + - `custom_ca_certificate_updated: optional boolean or null` - Whether the integration is enabled after this change. + Whether the custom CA certificate was replaced in this update + + - `display_name: optional string or null` + + New display name, when it changed + + - `github_app_client_id: optional string or null` + + New GitHub App client ID, when it changed + + - `github_app_client_secret_updated: optional boolean or null` + + Whether the GitHub App client secret was replaced in this update + + - `github_app_id: optional number or null` + + New GitHub App ID, when it changed + + - `github_app_private_key_updated: optional boolean or null` + + Whether the GitHub App private key was replaced in this update + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance (immutable; included for context) + + - `is_active: optional boolean or null` + + New active state, when it changed - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` + - `port: optional number or null` - Whether the integration was enabled before this change; null when the integration had never been configured. + New port, when it changed - - `repository_name: optional string or null` + - `previous_display_name: optional string or null` - - `type: optional "claude_github_integration_created"` + Display name before the change, when it changed - default: claude_github_integration_created + - `previous_github_app_client_id: optional string or null` - - `ClaudeGitHubIntegrationDeleted object` + GitHub App client ID before the change, when it changed - A GitHub integration was disabled for the organization. + - `previous_github_app_id: optional number or null` + + GitHub App ID before the change, when it changed + + - `previous_is_active: optional boolean or null` + + Active state before the change, when it changed + + - `previous_port: optional number or null` + + Port before the change, when it changed + + - `read_replica_hostnames_updated: optional boolean or null` + + Whether the read replica hostnames were replaced in this update + + - `type: optional "ghe_configuration_updated"` + + default: ghe_configuration_updated + + - `webhook_secret_updated: optional boolean or null` + + Whether the webhook secret was replaced in this update + + - `GheUserConnected object` + + User connected to a GHE instance. - `actor: object or object or object or 8 more` @@ -41451,8 +41304,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -41463,33 +41314,25 @@ compliance activities that can be filtered by various criteria. format: date-time - - `enabled: optional boolean or null` + - `ghe_configuration_id: optional string or null` - Whether the integration is enabled after this change. + ID of the GHE configuration - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether the integration was enabled before this change; null when the integration had never been configured. - - - `repository_name: optional string or null` - - - `type: optional "claude_github_integration_deleted"` + - `type: optional "ghe_user_connected"` - default: claude_github_integration_deleted + default: ghe_user_connected - - `ClaudeGitHubIntegrationUpdated object` + - `GheUserDisconnected object` - A GitHub integration's configuration was updated. + User disconnected from a GHE instance. - `actor: object or object or object or 8 more` @@ -41702,8 +41545,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -41714,25 +41555,25 @@ compliance activities that can be filtered by various criteria. format: date-time + - `ghe_configuration_id: optional string or null` + + ID of the GHE configuration + - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `repository_name: optional string or null` - - - `type: optional "claude_github_integration_updated"` + - `type: optional "ghe_user_disconnected"` - default: claude_github_integration_updated + default: ghe_user_disconnected - - `GitHubTokenImport object` + - `GheWebhookSignatureInvalid object` - A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed). + Webhook signature validation failed. - `actor: object or object or object or 8 more` @@ -41945,29 +41786,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `result: "failed_internal" or "imported" or "rejected_feature_disabled" or 5 more` - - The outcome of the import. - - - `"failed_internal"` - - - `"imported"` - - - `"rejected_feature_disabled"` - - - `"rejected_invalid_credential"` - - - `"rejected_missing_repo_scope"` - - - `"rejected_tenant_not_ready"` - - - `"rejected_zdr_policy"` - - - `"unspecified"` - - - `source: string` + - `ghe_configuration_id: string` - How the token was imported. + ID of the GHE configuration - `id: optional string` @@ -41979,14 +41800,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_username: optional string or null` - - The GitHub username the imported token authenticates as, when known. - - - `granted_scopes: optional string or null` - - The scopes granted to the imported token, when available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -41995,17 +41808,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `token_fingerprint_sha256: optional string or null` - - Org-scoped SHA-256 of the submitted token: `sha256(org_uuid || 0x00 || token)`, lowercase-hex-encoded, where `org_uuid` is the organization's UUID as a dashed lowercase string, `0x00` is a single zero byte, and `token` is the submitted value's raw bytes. Per-org correlation only — the same token in two orgs produces distinct fingerprints. Set only when the submitted value carries a known GitHub PAT prefix (a high-entropy token format); unset for all other submissions, including rejected non-PAT input. - - - `type: optional "github_token_import"` + - `type: optional "ghe_webhook_signature_invalid"` - default: github_token_import + default: ghe_webhook_signature_invalid - - `ClaudeGdriveIntegrationCreated object` + - `ClaudeGitHubIntegrationCreated object` - A Google Drive integration was enabled for the organization. + A GitHub integration was enabled for the organization. - `actor: object or object or object or 8 more` @@ -42230,23 +42039,33 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` + - `enabled: optional boolean or null` + + Whether the integration is enabled after this change. - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_created"` + - `previous_enabled: optional boolean or null` - default: claude_gdrive_integration_created + Whether the integration was enabled before this change; null when the integration had never been configured. - - `ClaudeGdriveIntegrationDeleted object` + - `repository_name: optional string or null` - A Google Drive integration was disabled for the organization. + - `type: optional "claude_github_integration_created"` + + default: claude_github_integration_created + + - `ClaudeGitHubIntegrationDeleted object` + + A GitHub integration was disabled for the organization. - `actor: object or object or object or 8 more` @@ -42471,23 +42290,33 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` + - `enabled: optional boolean or null` + + Whether the integration is enabled after this change. - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_deleted"` + - `previous_enabled: optional boolean or null` - default: claude_gdrive_integration_deleted + Whether the integration was enabled before this change; null when the integration had never been configured. - - `ClaudeGdriveIntegrationUpdated object` + - `repository_name: optional string or null` - A Google Drive integration's configuration was updated. + - `type: optional "claude_github_integration_deleted"` + + default: claude_github_integration_deleted + + - `ClaudeGitHubIntegrationUpdated object` + + A GitHub integration's configuration was updated. - `actor: object or object or object or 8 more` @@ -42712,23 +42541,25 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_updated"` + - `repository_name: optional string or null` - default: claude_gdrive_integration_updated + - `type: optional "claude_github_integration_updated"` - - `GroupCreated object` + default: claude_github_integration_updated - A group was created (RBAC admin or SCIM provisioning). + - `GitHubTokenImport object` + + A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed). - `actor: object or object or object or 8 more` @@ -42941,13 +42772,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` + - `result: "failed_internal" or "imported" or "rejected_feature_disabled" or 5 more` - Tagged ID of the created group + The outcome of the import. - - `group_name: string` + - `"failed_internal"` - Name of the created group + - `"imported"` + + - `"rejected_feature_disabled"` + + - `"rejected_invalid_credential"` + + - `"rejected_missing_repo_scope"` + + - `"rejected_tenant_not_ready"` + + - `"rejected_zdr_policy"` + + - `"unspecified"` + + - `source: string` + + How the token was imported. - `id: optional string` @@ -42959,6 +42806,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_username: optional string or null` + + The GitHub username the imported token authenticates as, when known. + + - `granted_scopes: optional string or null` + + The scopes granted to the imported token, when available. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -42967,13 +42822,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_created"` + - `token_fingerprint_sha256: optional string or null` - default: group_created + Org-scoped SHA-256 of the submitted token: `sha256(org_uuid || 0x00 || token)`, lowercase-hex-encoded, where `org_uuid` is the organization's UUID as a dashed lowercase string, `0x00` is a single zero byte, and `token` is the submitted value's raw bytes. Per-org correlation only — the same token in two orgs produces distinct fingerprints. Set only when the submitted value carries a known GitHub PAT prefix (a high-entropy token format); unset for all other submissions, including rejected non-PAT input. - - `GroupDeleted object` + - `type: optional "github_token_import"` - A group was deleted (RBAC admin or SCIM provisioning). + default: github_token_import + + - `ClaudeGdriveIntegrationCreated object` + + A Google Drive integration was enabled for the organization. - `actor: object or object or object or 8 more` @@ -43186,9 +43045,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the deleted group + - `integration_id: string` - `id: optional string` @@ -43200,6 +43057,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `folder_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43208,13 +43067,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_deleted"` + - `type: optional "claude_gdrive_integration_created"` - default: group_deleted + default: claude_gdrive_integration_created - - `GroupListViewed object` + - `ClaudeGdriveIntegrationDeleted object` - Admin viewed the list of RBAC groups. + A Google Drive integration was disabled for the organization. - `actor: object or object or object or 8 more` @@ -43427,6 +43286,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `integration_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -43437,6 +43298,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `folder_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43445,13 +43308,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_list_viewed"` + - `type: optional "claude_gdrive_integration_deleted"` - default: group_list_viewed + default: claude_gdrive_integration_deleted - - `GroupMemberAdded object` + - `ClaudeGdriveIntegrationUpdated object` - One or more members were added to a group. + A Google Drive integration's configuration was updated. - `actor: object or object or object or 8 more` @@ -43664,9 +43527,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the group + - `integration_id: string` - `id: optional string` @@ -43678,9 +43539,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members added: user IDs, or service account IDs (svac_...) when a service account was added + - `folder_id: optional string or null` - `organization_id: optional string or null` @@ -43690,13 +43549,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_added"` + - `type: optional "claude_gdrive_integration_updated"` - default: group_member_added + default: claude_gdrive_integration_updated - - `GroupMemberAdditionFailed object` + - `GroupCreated object` - A request to add members to a group failed. Some of the requested members may have been added before the failure. + A group was created (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -43911,7 +43770,11 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group + Tagged ID of the created group + + - `group_name: string` + + Name of the created group - `id: optional string` @@ -43923,10 +43786,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members the request attempted to add - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43935,13 +43794,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_addition_failed"` + - `type: optional "group_created"` - default: group_member_addition_failed + default: group_created - - `GroupMemberListViewed object` + - `GroupDeleted object` - Admin viewed the members of an RBAC group. + A group was deleted (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -44156,7 +44015,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group + Tagged ID of the deleted group - `id: optional string` @@ -44176,13 +44035,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_list_viewed"` + - `type: optional "group_deleted"` - default: group_member_list_viewed + default: group_deleted - - `GroupMemberRemovalFailed object` + - `GroupListViewed object` - A request to remove members from a group failed. Some of the requested members may have been removed before the failure. + Admin viewed the list of RBAC groups. - `actor: object or object or object or 8 more` @@ -44395,10 +44254,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the group - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -44409,10 +44264,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members the request attempted to remove. These are always recorded as user IDs, since whether a member was a service account is only established once its removal succeeds - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -44421,13 +44272,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_removal_failed"` + - `type: optional "group_list_viewed"` - default: group_member_removal_failed + default: group_list_viewed - - `GroupMemberRemoved object` + - `GroupMemberAdded object` - One or more members were removed from a group. + One or more members were added to a group. - `actor: object or object or object or 8 more` @@ -44656,7 +44507,7 @@ compliance activities that can be filtered by various criteria. - `member_ids: optional array of string` - Tagged IDs of the members removed: user IDs, or service account IDs (svac_...) when a service account was removed. A requested member that was not in the group is listed as a user ID + Tagged IDs of the members added: user IDs, or service account IDs (svac_...) when a service account was added - `organization_id: optional string or null` @@ -44666,13 +44517,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_removed"` + - `type: optional "group_member_added"` - default: group_member_removed + default: group_member_added - - `GroupProjectSharesRevoked object` + - `GroupMemberAdditionFailed object` - An RBAC group's project shares in one organization were revoked in bulk. + A request to add members to a group failed. Some of the requested members may have been added before the failure. - `actor: object or object or object or 8 more` @@ -44887,26 +44738,22 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose project shares were revoked. - - - `revoked_count: number` - - Number of distinct projects whose share with this group was revoked. + Tagged ID of the group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_ids: optional array of string` - - Tagged IDs of the projects whose share with this group was revoked. - - `created_at: optional string` When this activity occurred. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members the request attempted to add + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -44915,13 +44762,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_project_shares_revoked"` + - `type: optional "group_member_addition_failed"` - default: group_project_shares_revoked + default: group_member_addition_failed - - `GroupSkillSharesRevoked object` + - `GroupMemberListViewed object` - An RBAC group's skill shares in one organization were revoked in bulk. + Admin viewed the members of an RBAC group. - `actor: object or object or object or 8 more` @@ -45136,11 +44983,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose skill shares were revoked. - - - `revoked_count: number` - - Number of distinct skills and plugins whose share with this group was revoked: the combined size of `skill_ids` and `plugin_ids`. + Tagged ID of the group - `id: optional string` @@ -45160,21 +45003,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plugin_ids: optional array of string` - - Tagged IDs of the plugins whose share with this group was revoked. - - - `skill_ids: optional array of string` - - Tagged IDs of the skills whose share with this group was revoked. - - - `type: optional "group_skill_shares_revoked"` + - `type: optional "group_member_list_viewed"` - default: group_skill_shares_revoked + default: group_member_list_viewed - - `GroupUpdated object` + - `GroupMemberRemovalFailed object` - A group was updated (RBAC admin or SCIM provisioning). + A request to remove members from a group failed. Some of the requested members may have been removed before the failure. - `actor: object or object or object or 8 more` @@ -45389,7 +45224,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the updated group + Tagged ID of the group - `id: optional string` @@ -45401,6 +45236,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members the request attempted to remove. These are always recorded as user IDs, since whether a member was a service account is only established once its removal succeeds + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -45409,13 +45248,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_updated"` + - `type: optional "group_member_removal_failed"` - default: group_updated + default: group_member_removal_failed - - `GroupViewed object` + - `GroupMemberRemoved object` - A group was viewed. + One or more members were removed from a group. - `actor: object or object or object or 8 more` @@ -45630,7 +45469,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the viewed group + Tagged ID of the group - `id: optional string` @@ -45642,6 +45481,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members removed: user IDs, or service account IDs (svac_...) when a service account was removed. A requested member that was not in the group is listed as a user ID + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -45650,13 +45493,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_viewed"` + - `type: optional "group_member_removed"` - default: group_viewed + default: group_member_removed - - `GroupVisibilityUpdated object` + - `GroupProjectSharesRevoked object` - An RBAC group's visibility policy was updated. + An RBAC group's project shares in one organization were revoked in bulk. - `actor: object or object or object or 8 more` @@ -45871,12 +45714,20 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose visibility policy was updated. + Tagged ID of the group whose project shares were revoked. + + - `revoked_count: number` + + Number of distinct projects whose share with this group was revoked. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_ids: optional array of string` + + Tagged IDs of the projects whose share with this group was revoked. + - `created_at: optional string` When this activity occurred. @@ -45891,69 +45742,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `policies: optional array of object` - - The group's visibility policy after this update. - - - `audience: "everyone" or "members" or "none" or "unspecified"` - - The audience granted this visibility facet. - - - `"everyone"` - - - `"members"` - - - `"none"` - - - `"unspecified"` - - - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` - - The visibility facet this entry grants. - - - `"discover"` - - - `"share_with"` - - - `"unspecified"` - - - `"view_members"` - - - `previous_policies: optional array of object` - - The group's visibility policy before this update. - - - `audience: "everyone" or "members" or "none" or "unspecified"` - - The audience granted this visibility facet. - - - `"everyone"` - - - `"members"` - - - `"none"` - - - `"unspecified"` - - - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` - - The visibility facet this entry grants. - - - `"discover"` - - - `"share_with"` - - - `"unspecified"` - - - `"view_members"` - - - `type: optional "group_visibility_updated"` + - `type: optional "group_project_shares_revoked"` - default: group_visibility_updated + default: group_project_shares_revoked - - `InferenceHooksCircuitBreakerTripped object` + - `GroupSkillSharesRevoked object` - The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. The tripped state persists until an administrator re-enables Inference hooks inspection (or explicitly resets the circuit breaker). + An RBAC group's skill shares in one organization were revoked in bulk. - `actor: object or object or object or 8 more` @@ -46166,13 +45961,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `fail_mode: string` + - `group_id: string` - The failure handling in effect when the breaker tripped: "fail_open" (requests proceed uninspected) or "fail_closed" (requests are rejected). + Tagged ID of the group whose skill shares were revoked. - - `trigger_reason: string` + - `revoked_count: number` - The kind of failure that crossed the threshold. Currently always "webhook_error": repeated failures of calls to the organization's Inference hooks endpoint. + Number of distinct skills and plugins whose share with this group was revoked: the combined size of `skill_ids` and `plugin_ids`. - `id: optional string` @@ -46192,17 +45987,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `surface: optional string or null` + - `plugin_ids: optional array of string` - The product surface of the request whose failure tripped the breaker, e.g. "claude-ai" or "claude-code". + Tagged IDs of the plugins whose share with this group was revoked. - - `type: optional "inference_hooks_circuit_breaker_tripped"` + - `skill_ids: optional array of string` - default: inference_hooks_circuit_breaker_tripped + Tagged IDs of the skills whose share with this group was revoked. - - `InferenceHooksRequestDenied object` + - `type: optional "group_skill_shares_revoked"` - Inference hooks inspection denied a request. The request was blocked and no model response was produced. + default: group_skill_shares_revoked + + - `GroupUpdated object` + + A group was updated (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -46415,13 +46214,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `group_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the updated group - - `conversation_id: optional string or null` + - `id: optional string` - The conversation the denied request belonged to, when available. The identifier format depends on `surface`. + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -46437,25 +46236,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reference_id: optional string or null` - - The Inference hooks endpoint's own identifier for this scan, when it returned one — lets this denial be matched to the corresponding record in the inspection provider's console. - - - `request_id: optional string or null` - - Anthropic's identifier for the denied request — the same value sent to the Inference hooks endpoint as `request_id`. - - - `surface: optional string or null` - - The product surface the request came from, e.g. "claude-ai" or "claude-code". - - - `type: optional "inference_hooks_request_denied"` + - `type: optional "group_updated"` - default: inference_hooks_request_denied + default: group_updated - - `InferenceHooksRequestFailedOpen object` + - `GroupViewed object` - A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open. + A group was viewed. - `actor: object or object or object or 8 more` @@ -46668,26 +46455,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `reason: "endpoint_error" or "endpoint_timeout" or "internal_error" or "unspecified"` - - Why Inference hooks inspection did not return a verdict. - - - `"endpoint_error"` - - - `"endpoint_timeout"` - - - `"internal_error"` + - `group_id: string` - - `"unspecified"` + Tagged ID of the viewed group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `conversation_id: optional string or null` - - The conversation the request belonged to, when available. The identifier format depends on `surface`. - - `created_at: optional string` When this activity occurred. @@ -46702,17 +46477,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `surface: optional string or null` - - The product surface the request came from, e.g. "claude-ai" or "claude-code". - - - `type: optional "inference_hooks_request_failed_open"` + - `type: optional "group_viewed"` - default: inference_hooks_request_failed_open + default: group_viewed - - `IntegrationUserConnected object` + - `GroupVisibilityUpdated object` - User connected to an integration. + An RBAC group's visibility policy was updated. - `actor: object or object or object or 8 more` @@ -46925,6 +46696,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `group_id: string` + + Tagged ID of the group whose visibility policy was updated. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -46935,31 +46710,77 @@ compliance activities that can be filtered by various criteria. format: date-time - - `integration_type: optional string or null` + - `organization_id: optional string or null` - - `mcp_server_id: optional string or null` + Organization ID this activity is associated with - ID of the connected remote MCP server, when the integration is a remote MCP server. + - `organization_uuid: optional string or null` - - `mcp_server_name: optional string or null` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - Display name of the connected remote MCP server, when the integration is a remote MCP server. + - `policies: optional array of object` - - `organization_id: optional string or null` + The group's visibility policy after this update. - Organization ID this activity is associated with + - `audience: "everyone" or "members" or "none" or "unspecified"` - - `organization_uuid: optional string or null` + The audience granted this visibility facet. - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `"everyone"` - - `type: optional "integration_user_connected"` + - `"members"` - default: integration_user_connected + - `"none"` - - `IntegrationUserDisconnected object` + - `"unspecified"` - User disconnected from an integration. + - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` + + The visibility facet this entry grants. + + - `"discover"` + + - `"share_with"` + + - `"unspecified"` + + - `"view_members"` + + - `previous_policies: optional array of object` + + The group's visibility policy before this update. + + - `audience: "everyone" or "members" or "none" or "unspecified"` + + The audience granted this visibility facet. + + - `"everyone"` + + - `"members"` + + - `"none"` + + - `"unspecified"` + + - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` + + The visibility facet this entry grants. + + - `"discover"` + + - `"share_with"` + + - `"unspecified"` + + - `"view_members"` + + - `type: optional "group_visibility_updated"` + + default: group_visibility_updated + + - `InferenceHooksCircuitBreakerTripped object` + + The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. The tripped state persists until an administrator re-enables Inference hooks inspection (or explicitly resets the circuit breaker). - `actor: object or object or object or 8 more` @@ -47172,6 +46993,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `fail_mode: string` + + The failure handling in effect when the breaker tripped: "fail_open" (requests proceed uninspected) or "fail_closed" (requests are rejected). + + - `trigger_reason: string` + + The kind of failure that crossed the threshold. Currently always "webhook_error": repeated failures of calls to the organization's Inference hooks endpoint. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -47182,16 +47011,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `integration_type: optional string or null` - - - `mcp_server_id: optional string or null` - - ID of the disconnected remote MCP server, when the integration is a remote MCP server. - - - `mcp_server_name: optional string or null` - - Display name of the disconnected remote MCP server, when the integration is a remote MCP server. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47200,13 +47019,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "integration_user_disconnected"` + - `surface: optional string or null` - default: integration_user_disconnected + The product surface of the request whose failure tripped the breaker, e.g. "claude-ai" or "claude-code". - - `InvoiceCollectionMethodUpdated object` + - `type: optional "inference_hooks_circuit_breaker_tripped"` - Invoice collection method was changed. + default: inference_hooks_circuit_breaker_tripped + + - `InferenceHooksRequestDenied object` + + Inference hooks inspection denied a request. The request was blocked and no model response was produced. - `actor: object or object or object or 8 more` @@ -47423,16 +47246,16 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `conversation_id: optional string or null` + + The conversation the denied request belonged to, when available. The identifier format depends on `surface`. + - `created_at: optional string` When this activity occurred. format: date-time - - `new_collection_method: optional string or null` - - New collection method (e.g. charge_automatically, send_invoice). - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47441,13 +47264,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "invoice_collection_method_updated"` + - `reference_id: optional string or null` - default: invoice_collection_method_updated + The Inference hooks endpoint's own identifier for this scan, when it returned one — lets this denial be matched to the corresponding record in the inspection provider's console. - - `UserLoggedOut object` + - `request_id: optional string or null` - A user signed out of one or all sessions. + Anthropic's identifier for the denied request — the same value sent to the Inference hooks endpoint as `request_id`. + + - `surface: optional string or null` + + The product surface the request came from, e.g. "claude-ai" or "claude-code". + + - `type: optional "inference_hooks_request_denied"` + + default: inference_hooks_request_denied + + - `InferenceHooksRequestFailedOpen object` + + A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open. - `actor: object or object or object or 8 more` @@ -47660,10 +47495,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `reason: "endpoint_error" or "endpoint_timeout" or "internal_error" or "unspecified"` + + Why Inference hooks inspection did not return a verdict. + + - `"endpoint_error"` + + - `"endpoint_timeout"` + + - `"internal_error"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `conversation_id: optional string or null` + + The conversation the request belonged to, when available. The identifier format depends on `surface`. + - `created_at: optional string` When this activity occurred. @@ -47678,13 +47529,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "user_logged_out"` + - `surface: optional string or null` - default: user_logged_out + The product surface the request came from, e.g. "claude-ai" or "claude-code". - - `LtiLaunchInitiated object` + - `type: optional "inference_hooks_request_failed_open"` - LTI launch was initiated. + default: inference_hooks_request_failed_open + + - `IntegrationUserConnected object` + + User connected to an integration. - `actor: object or object or object or 8 more` @@ -47907,6 +47762,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `integration_type: optional string or null` + + - `mcp_server_id: optional string or null` + + ID of the connected remote MCP server, when the integration is a remote MCP server. + + - `mcp_server_name: optional string or null` + + Display name of the connected remote MCP server, when the integration is a remote MCP server. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47915,13 +47780,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_launch_initiated"` + - `token_vault_connect_mode: optional string or null` - default: lti_launch_initiated + How a token vault credential sign-in was completed: "authorization_server" for a sign-in at an administrator-provided authorization server, or "mcp_server" for a sign-in at a tool server the organization has not registered as a connector. - - `LtiLaunchSuccess object` + - `type: optional "integration_user_connected"` - LTI launch completed successfully. + default: integration_user_connected + + - `IntegrationUserDisconnected object` + + User disconnected from an integration. - `actor: object or object or object or 8 more` @@ -48144,6 +48013,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `integration_type: optional string or null` + + - `mcp_server_id: optional string or null` + + ID of the disconnected remote MCP server, when the integration is a remote MCP server. + + - `mcp_server_name: optional string or null` + + Display name of the disconnected remote MCP server, when the integration is a remote MCP server. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48152,13 +48031,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_launch_success"` + - `type: optional "integration_user_disconnected"` - default: lti_launch_success + default: integration_user_disconnected - - `LtiPlatformCreated object` + - `InvoiceCollectionMethodUpdated object` - Anthropic staff created an LTI platform integration on behalf of an org. + Invoice collection method was changed. - `actor: object or object or object or 8 more` @@ -48371,14 +48250,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `lti_platform_id: string` - - UUID of the LTI platform - - - `lti_platform_issuer: string` - - Platform issuer URL - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -48389,6 +48260,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `new_collection_method: optional string or null` + + New collection method (e.g. charge_automatically, send_invoice). + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48397,13 +48272,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_platform_created"` + - `type: optional "invoice_collection_method_updated"` - default: lti_platform_created + default: invoice_collection_method_updated - - `LtiPlatformUpdated object` + - `UserLoggedOut object` - Anthropic staff updated an LTI platform integration on behalf of an org. + A user signed out of one or all sessions. - `actor: object or object or object or 8 more` @@ -48616,10 +48491,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `lti_platform_id: string` - - UUID of the LTI platform - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -48630,10 +48501,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `lti_platform_issuer: optional string or null` - - Platform issuer URL - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48642,13 +48509,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_platform_updated"` + - `type: optional "user_logged_out"` - default: lti_platform_updated + default: user_logged_out - - `MagicLinkLoginFailed object` + - `LtiLaunchInitiated object` - A magic link sign-in attempt failed. + LTI launch was initiated. - `actor: object or object or object or 8 more` @@ -48879,13 +48746,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_failed"` + - `type: optional "lti_launch_initiated"` - default: magic_link_login_failed + default: lti_launch_initiated - - `MagicLinkLoginInitiated object` + - `LtiLaunchSuccess object` - A user requested a magic link sign-in email. + LTI launch completed successfully. - `actor: object or object or object or 8 more` @@ -49116,13 +48983,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_initiated"` + - `type: optional "lti_launch_success"` - default: magic_link_login_initiated + default: lti_launch_success - - `MagicLinkLoginSucceeded object` + - `LtiPlatformCreated object` - A user successfully signed in with a magic link email. + Anthropic staff created an LTI platform integration on behalf of an org. - `actor: object or object or object or 8 more` @@ -49335,15 +49202,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `lti_platform_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + UUID of the LTI platform - - `auth_method: optional "magic_link"` + - `lti_platform_issuer: string` - The method the user used to authenticate. May be absent on activities recorded before this field was introduced. + Platform issuer URL + + - `id: optional string` - default: magic_link + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -49351,10 +49220,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `mfa_method: optional "not_used" or null` - - The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -49363,13 +49228,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_succeeded"` + - `type: optional "lti_platform_created"` - default: magic_link_login_succeeded + default: lti_platform_created - - `ManagedOrganizationSetupCompleted object` + - `LtiPlatformUpdated object` - Managed (AWS Marketplace) organization setup was completed. + Anthropic staff updated an LTI platform integration on behalf of an org. - `actor: object or object or object or 8 more` @@ -49582,6 +49447,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `lti_platform_id: string` + + UUID of the LTI platform + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -49592,6 +49461,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `lti_platform_issuer: optional string or null` + + Platform issuer URL + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -49600,13 +49473,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "managed_organization_setup_completed"` + - `type: optional "lti_platform_updated"` - default: managed_organization_setup_completed + default: lti_platform_updated - - `MarketplaceCreated object` + - `MagicLinkLoginFailed object` - Admin created an organization marketplace. + A magic link sign-in attempt failed. - `actor: object or object or object or 8 more` @@ -49819,10 +49692,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -49841,13 +49710,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_created"` + - `type: optional "magic_link_login_failed"` - default: marketplace_created + default: magic_link_login_failed - - `MarketplaceDeleted object` + - `MagicLinkLoginInitiated object` - Admin deleted an organization marketplace. + A user requested a magic link sign-in email. - `actor: object or object or object or 8 more` @@ -50060,10 +49929,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -50082,13 +49947,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_deleted"` + - `type: optional "magic_link_login_initiated"` - default: marketplace_deleted + default: magic_link_login_initiated - - `MarketplaceUpdated object` + - `MagicLinkLoginSucceeded object` - Admin updated an organization marketplace. + A user successfully signed in with a magic link email. - `actor: object or object or object or 8 more` @@ -50301,20 +50166,32 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `auth_method: optional "magic_link" or "unspecified" or null` + + The method the user used to authenticate. May be absent on activities recorded before this field was introduced. + + - `"magic_link"` + + - `"unspecified"` + - `created_at: optional string` When this activity occurred. format: date-time + - `mfa_method: optional "not_used" or "unspecified" or null` + + The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. + + - `"not_used"` + + - `"unspecified"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -50323,13 +50200,250 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_updated"` + - `type: optional "magic_link_login_succeeded"` - default: marketplace_updated + default: magic_link_login_succeeded - - `MarketplaceWebhookDeleted object` + - `ManagedOrganizationSetupCompleted object` - Admin removed the GitHub push webhook for a marketplace. + Managed (AWS Marketplace) organization setup was completed. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "managed_organization_setup_completed"` + + default: managed_organization_setup_completed + + - `MarketplaceCreated object` + + Admin created an organization marketplace. - `actor: object or object or object or 8 more` @@ -50564,13 +50678,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_webhook_deleted"` + - `type: optional "marketplace_created"` - default: marketplace_webhook_deleted + default: marketplace_created - - `MarketplaceWebhookProvisioned object` + - `MarketplaceDeleted object` - Admin provisioned a GitHub push webhook for a marketplace. + Admin deleted an organization marketplace. - `actor: object or object or object or 8 more` @@ -50797,10 +50911,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_webhook_id: optional number or null` - - GitHub-assigned webhook ID returned by the hooks API - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -50809,13 +50919,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_webhook_provisioned"` + - `type: optional "marketplace_deleted"` - default: marketplace_webhook_provisioned + default: marketplace_deleted - - `McpDirectoryServerPublished object` + - `MarketplaceUpdated object` - The organization published its approved MCP directory listing. + Admin updated an organization marketplace. - `actor: object or object or object or 8 more` @@ -51028,13 +51138,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_directory_server_id: string` - - Tagged ID of the MCP directory listing - - - `mcp_directory_server_name: string` + - `marketplace_id: string` - Display name of the MCP directory listing + Tagged ID of the marketplace - `id: optional string` @@ -51054,13 +51160,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_directory_server_published"` + - `type: optional "marketplace_updated"` - default: mcp_directory_server_published + default: marketplace_updated - - `McpServerCreated object` + - `MarketplaceWebhookDeleted object` - An MCP server was added to the organization. + Admin removed the GitHub push webhook for a marketplace. - `actor: object or object or object or 8 more` @@ -51273,13 +51379,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_server_id: string` - - Tagged ID of the MCP server - - - `mcp_server_name: string` + - `marketplace_id: string` - Display name of the MCP server + Tagged ID of the marketplace - `id: optional string` @@ -51299,13 +51401,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_created"` + - `type: optional "marketplace_webhook_deleted"` - default: mcp_server_created + default: marketplace_webhook_deleted - - `McpServerDeleted object` + - `MarketplaceWebhookProvisioned object` - An MCP server was removed from the organization. + Admin provisioned a GitHub push webhook for a marketplace. - `actor: object or object or object or 8 more` @@ -51518,13 +51620,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_server_id: string` - - Tagged ID of the MCP server - - - `mcp_server_name: string` + - `marketplace_id: string` - Display name of the MCP server + Tagged ID of the marketplace - `id: optional string` @@ -51536,6 +51634,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_webhook_id: optional number or null` + + GitHub-assigned webhook ID returned by the hooks API + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -51544,13 +51646,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_deleted"` + - `type: optional "marketplace_webhook_provisioned"` - default: mcp_server_deleted + default: marketplace_webhook_provisioned - - `McpServerManagedAuthTokenExchanged object` + - `McpDirectoryServerPublished object` - A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests denied by organization policy before a token exchange is attempted are not reported, with the exception of the "connector_scope_not_granted" failures described under error_type. + The organization published its approved MCP directory listing. - `actor: object or object or object or 8 more` @@ -51763,48 +51865,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `managed_auth_mode: string` + - `mcp_directory_server_id: string` - The managed-authorization mode used for the exchange ("claude" or "sso"). + Tagged ID of the MCP directory listing - - `mcp_server_id: string` + - `mcp_directory_server_name: string` - The MCP server the exchange was attempted for, e.g. "mcpsrv_01Ab...". + Display name of the MCP directory listing - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `assertion_jti: optional string or null` - - The JWT ID of the identity assertion presented to the authorization server, when one was minted, for cross-reference with the identity provider's own logs. - - - `authorization_server_issuer: optional string or null` - - The issuer identifier of the authorization server the exchange was attempted against. - - - `correlation_id: optional string or null` - - An opaque identifier customers can quote when contacting Anthropic support about this exchange. - - `created_at: optional string` When this activity occurred. format: date-time - - `error_subtype: optional string or null` - - A more specific classification of the failure, when available. For authorization-server rejections this is the OAuth error code the server returned (for example "invalid_grant"); for identity-provider rejections this is the error code the identity provider returned. Values may be added over time; treat an unrecognized value as a generic failure. - - - `error_type: optional string or null` - - A short classification of why the exchange failed, when outcome is "failure". Values include "authorization_server_rejected", "authorization_server_unavailable", "identity_provider_rejected", "sso_session_invalid", "sso_connection_unsupported", and "connector_scope_not_granted" (the organization's role configuration grants no scopes on this connector, so the request was denied before a token exchange was attempted). Values may be added over time; treat an unrecognized value as a generic failure. - - - `mcp_server_name: optional string or null` - - The MCP server's display name at the time of the exchange, when available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -51813,17 +51891,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `outcome: optional string or null` - - Whether the token exchange succeeded ("success") or was rejected ("failure"). - - - `type: optional "mcp_server_managed_auth_token_exchanged"` + - `type: optional "mcp_directory_server_published"` - default: mcp_server_managed_auth_token_exchanged + default: mcp_directory_server_published - - `McpServerManagedAuthUpdated object` + - `McpServerCreated object` - An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server). + An MCP server was added to the organization. - `actor: object or object or object or 8 more` @@ -52048,36 +52122,12 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `allowed_scopes: optional string or null` - - The OAuth scopes managed authorization may request for the server after the change, as a space-delimited list. Null when no scope restriction is configured (or the server has no managed authorization settings); an empty string when the restriction permits no scopes. - - - `built_in_roles_included: optional boolean or null` - - Whether, after the change, managed authorization extends to members who hold one of the organization's built-in roles (such as User, Admin, or Owner) rather than a custom role, in addition to members whose custom role grants it. This describes whom managed authorization reaches and is reported on every change, independent of how built-in role access is configured. - - `created_at: optional string` When this activity occurred. format: date-time - - `individual_auth_enabled: optional boolean or null` - - Whether members may authorize the server individually, through their own sign-in and consent, after the change. - - - `managed_auth_enabled: optional boolean or null` - - Whether managed authorization is enabled for the server after the change, so that members whose role permits it are authorized through the organization's identity provider. - - - `managed_auth_mode: optional string or null` - - The managed-authorization mode after the change ("claude" or "sso"): how the identity assertion presented on members' behalf is issued. Recorded whenever managed authorization settings exist, whether or not managed authorization is enabled; null when the server has no managed authorization settings after the change. - - - `mcp_server_url: optional string or null` - - Base URL (scheme, host, port, and path only) of the MCP server at the time of the change; null when not available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -52086,29 +52136,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_allowed_scopes: optional string or null` - - The OAuth scope restriction before the change, as a space-delimited list; null when no scope restriction was configured. - - - `previous_built_in_roles_included: optional boolean or null` - - Whether managed authorization extended to members holding one of the organization's built-in roles before the change. - - - `previous_individual_auth_enabled: optional boolean or null` - - Whether members could authorize the server individually before the change. - - - `previous_managed_auth_enabled: optional boolean or null` - - Whether managed authorization was enabled for the server before the change. - - - `type: optional "mcp_server_managed_auth_updated"` + - `type: optional "mcp_server_created"` - default: mcp_server_managed_auth_updated + default: mcp_server_created - - `McpServerUpdated object` + - `McpServerDeleted object` - An MCP server's configuration was updated. + An MCP server was removed from the organization. - `actor: object or object or object or 8 more` @@ -52347,13 +52381,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_updated"` + - `type: optional "mcp_server_deleted"` - default: mcp_server_updated + default: mcp_server_deleted - - `McpToolPolicyUpdated object` + - `McpServerManagedAuthTokenExchanged object` - The permission restriction for an MCP tool was set or cleared. + A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests denied by organization policy before a token exchange is attempted are not reported, with the exception of the "connector_scope_not_granted" failures described under error_type. - `actor: object or object or object or 8 more` @@ -52566,21 +52600,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `managed_auth_mode: string` + + The managed-authorization mode used for the exchange ("claude" or "sso"). + - `mcp_server_id: string` - Tagged ID of the MCP server + The MCP server the exchange was attempted for, e.g. "mcpsrv_01Ab...". - - `mcp_server_name: string` + - `id: optional string` - Display name of the MCP server + Unique identifier for the activity e.g. 'activity_abcd1234' - - `tool_name: string` + - `assertion_jti: optional string or null` - Tool name (or '*' for the MCP-server-wide default) + The JWT ID of the identity assertion presented to the authorization server, when one was minted, for cross-reference with the identity provider's own logs. - - `id: optional string` + - `authorization_server_issuer: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The issuer identifier of the authorization server the exchange was attempted against. + + - `correlation_id: optional string or null` + + An opaque identifier customers can quote when contacting Anthropic support about this exchange. - `created_at: optional string` @@ -52588,9 +52630,17 @@ compliance activities that can be filtered by various criteria. format: date-time - - `max_permission: optional string or null` + - `error_subtype: optional string or null` - New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + A more specific classification of the failure, when available. For authorization-server rejections this is the OAuth error code the server returned (for example "invalid_grant"); for identity-provider rejections this is the error code the identity provider returned. Values may be added over time; treat an unrecognized value as a generic failure. + + - `error_type: optional string or null` + + A short classification of why the exchange failed, when outcome is "failure". Values include "authorization_server_rejected", "authorization_server_unavailable", "identity_provider_rejected", "sso_session_invalid", "sso_connection_unsupported", and "connector_scope_not_granted" (the organization's role configuration grants no scopes on this connector, so the request was denied before a token exchange was attempted). Values may be added over time; treat an unrecognized value as a generic failure. + + - `mcp_server_name: optional string or null` + + The MCP server's display name at the time of the exchange, when available. - `organization_id: optional string or null` @@ -52600,13 +52650,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_tool_policy_updated"` + - `outcome: optional string or null` - default: mcp_tool_policy_updated + Whether the token exchange succeeded ("success") or was rejected ("failure"). - - `OrgAnalyticsAPICapabilityUpdated object` + - `type: optional "mcp_server_managed_auth_token_exchanged"` - Organization analytics_api capability was enabled or disabled. + default: mcp_server_managed_auth_token_exchanged + + - `McpServerManagedAuthUpdated object` + + An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server). - `actor: object or object or object or 8 more` @@ -52819,19 +52873,47 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `mcp_server_id: string` + + Tagged ID of the MCP server + + - `mcp_server_name: string` + + Display name of the MCP server + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `allowed_scopes: optional string or null` + + The OAuth scopes managed authorization may request for the server after the change, as a space-delimited list. Null when no scope restriction is configured (or the server has no managed authorization settings); an empty string when the restriction permits no scopes. + + - `built_in_roles_included: optional boolean or null` + + Whether, after the change, managed authorization extends to members who hold one of the organization's built-in roles (such as User, Admin, or Owner) rather than a custom role, in addition to members whose custom role grants it. This describes whom managed authorization reaches and is reported on every change, independent of how built-in role access is configured. + - `created_at: optional string` When this activity occurred. format: date-time - - `current_value: optional boolean or null` + - `individual_auth_enabled: optional boolean or null` - Whether the analytics API capability is enabled immediately after this change + Whether members may authorize the server individually, through their own sign-in and consent, after the change. + + - `managed_auth_enabled: optional boolean or null` + + Whether managed authorization is enabled for the server after the change, so that members whose role permits it are authorized through the organization's identity provider. + + - `managed_auth_mode: optional string or null` + + The managed-authorization mode after the change ("claude" or "sso"): how the identity assertion presented on members' behalf is issued. Recorded whenever managed authorization settings exist, whether or not managed authorization is enabled; null when the server has no managed authorization settings after the change. + + - `mcp_server_url: optional string or null` + + Base URL (scheme, host, port, and path only) of the MCP server at the time of the change; null when not available. - `organization_id: optional string or null` @@ -52841,17 +52923,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` + - `previous_allowed_scopes: optional string or null` - Whether the analytics API capability was enabled immediately before this change + The OAuth scope restriction before the change, as a space-delimited list; null when no scope restriction was configured. - - `type: optional "org_analytics_api_capability_updated"` + - `previous_built_in_roles_included: optional boolean or null` - default: org_analytics_api_capability_updated + Whether managed authorization extended to members holding one of the organization's built-in roles before the change. - - `OrgBulkDeleteInitiated object` + - `previous_individual_auth_enabled: optional boolean or null` - Organization bulk deletion was initiated. + Whether members could authorize the server individually before the change. + + - `previous_managed_auth_enabled: optional boolean or null` + + Whether managed authorization was enabled for the server before the change. + + - `type: optional "mcp_server_managed_auth_updated"` + + default: mcp_server_managed_auth_updated + + - `McpServerUpdated object` + + An MCP server's configuration was updated. - `actor: object or object or object or 8 more` @@ -53064,6 +53158,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `mcp_server_id: string` + + Tagged ID of the MCP server + + - `mcp_server_name: string` + + Display name of the MCP server + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -53082,13 +53184,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_bulk_delete_initiated"` + - `type: optional "mcp_server_updated"` - default: org_bulk_delete_initiated + default: mcp_server_updated - - `OrgCapabilityGrantAdded object` + - `McpToolPolicyUpdated object` - A capability grant was added to a workspace or role. + The permission restriction for an MCP tool was set or cleared. - `actor: object or object or object or 8 more` @@ -53301,23 +53403,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `grant_type: string` - - The type of capability grant that was added. - - - `principal_id: string` - - Tagged ID of the principal the grant was added to. + - `mcp_server_id: string` - - `principal_type: "rbac_role" or "unspecified" or "workspace"` + Tagged ID of the MCP server - The kind of principal the grant was added to. + - `mcp_server_name: string` - - `"rbac_role"` + Display name of the MCP server - - `"unspecified"` + - `tool_name: string` - - `"workspace"` + Tool name (or '*' for the MCP-server-wide default) - `id: optional string` @@ -53329,6 +53425,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `max_permission: optional string or null` + + New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53337,13 +53437,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_capability_grant_added"` + - `type: optional "mcp_tool_policy_updated"` - default: org_capability_grant_added + default: mcp_tool_policy_updated - - `OrgCapabilityGrantRemoved object` + - `OrgAnalyticsAPICapabilityUpdated object` - A capability grant was removed from a workspace or role. + Organization analytics_api capability was enabled or disabled. - `actor: object or object or object or 8 more` @@ -53556,24 +53656,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `grant_type: string` - - The type of capability grant that was removed. - - - `principal_id: string` - - Tagged ID of the principal the grant was removed from. - - - `principal_type: "rbac_role" or "unspecified" or "workspace"` - - The kind of principal the grant was removed from. - - - `"rbac_role"` - - - `"unspecified"` - - - `"workspace"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -53584,6 +53666,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Whether the analytics API capability is enabled immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53592,13 +53678,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_capability_grant_removed"` + - `previous_value: optional boolean or null` - default: org_capability_grant_removed + Whether the analytics API capability was enabled immediately before this change - - `OrgClaudeCodeDataSharingDisabled object` + - `type: optional "org_analytics_api_capability_updated"` - Organization Claude Code data sharing was disabled. + default: org_analytics_api_capability_updated + + - `OrgBulkDeleteInitiated object` + + Organization bulk deletion was initiated. - `actor: object or object or object or 8 more` @@ -53821,10 +53911,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53833,17 +53919,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_data_sharing_disabled"` + - `type: optional "org_bulk_delete_initiated"` - default: org_claude_code_data_sharing_disabled + default: org_bulk_delete_initiated - - `OrgClaudeCodeDataSharingEnabled object` + - `OrgCapabilityGrantAdded object` - Organization Claude Code data sharing was enabled. + A capability grant was added to a workspace or role. - `actor: object or object or object or 8 more` @@ -54056,6 +54138,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `grant_type: string` + + The type of capability grant that was added. + + - `principal_id: string` + + Tagged ID of the principal the grant was added to. + + - `principal_type: "rbac_role" or "unspecified" or "workspace"` + + The kind of principal the grant was added to. + + - `"rbac_role"` + + - `"unspecified"` + + - `"workspace"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -54066,10 +54166,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54078,17 +54174,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_data_sharing_enabled"` + - `type: optional "org_capability_grant_added"` - default: org_claude_code_data_sharing_enabled + default: org_capability_grant_added - - `OrgClaudeCodeDesktopDisabled object` + - `OrgCapabilityGrantRemoved object` - Organization Claude Code Desktop was disabled. + A capability grant was removed from a workspace or role. - `actor: object or object or object or 8 more` @@ -54301,6 +54393,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `grant_type: string` + + The type of capability grant that was removed. + + - `principal_id: string` + + Tagged ID of the principal the grant was removed from. + + - `principal_type: "rbac_role" or "unspecified" or "workspace"` + + The kind of principal the grant was removed from. + + - `"rbac_role"` + + - `"unspecified"` + + - `"workspace"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -54311,10 +54421,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54323,17 +54429,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_desktop_disabled"` + - `type: optional "org_capability_grant_removed"` - default: org_claude_code_desktop_disabled + default: org_capability_grant_removed - - `OrgClaudeCodeDesktopEnabled object` + - `OrgClaudeCodeDataSharingDisabled object` - Organization Claude Code Desktop was enabled. + Organization Claude Code data sharing was disabled. - `actor: object or object or object or 8 more` @@ -54572,15 +54674,13 @@ compliance activities that can be filtered by various criteria. Setting value immediately before this change - - `type: optional "org_claude_code_desktop_enabled"` + - `type: optional "org_claude_code_data_sharing_disabled"` - default: org_claude_code_desktop_enabled + default: org_claude_code_data_sharing_disabled - - `OrgClaudeCodeZeroDataRetentionDisabled object` + - `OrgClaudeCodeDataSharingEnabled object` - A primary owner disabled zero data retention for Claude Code, so Claude - Code content is retained according to the organization's data retention - settings. + Organization Claude Code data sharing was enabled. - `actor: object or object or object or 8 more` @@ -54803,6 +54903,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54811,13 +54915,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_claude_code_zero_data_retention_disabled"` + - `previous_value: optional boolean or null` - default: org_claude_code_zero_data_retention_disabled + Setting value immediately before this change - - `OrgComplianceAPISettingsUpdated object` + - `type: optional "org_claude_code_data_sharing_enabled"` - Organization compliance API settings were updated. + default: org_claude_code_data_sharing_enabled + + - `OrgClaudeCodeDesktopDisabled object` + + Organization Claude Code Desktop was disabled. - `actor: object or object or object or 8 more` @@ -55034,20 +55142,16 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `compliance_api_enabled: optional boolean or null` - - Whether the compliance API is enabled for the organization after this change. - - - `compliance_api_logging_enabled: optional boolean or null` - - Whether compliance activity logging is enabled for the organization after this change. - - `created_at: optional string` When this activity occurred. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -55056,13 +55160,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_compliance_api_settings_updated"` + - `previous_value: optional boolean or null` - default: org_compliance_api_settings_updated + Setting value immediately before this change - - `OrgConnectorDomainGuardUpdated object` + - `type: optional "org_claude_code_desktop_disabled"` - Enterprise admin changed whether connectors are restricted to verified domains. + default: org_claude_code_desktop_disabled + + - `OrgClaudeCodeDesktopEnabled object` + + Organization Claude Code Desktop was enabled. - `actor: object or object or object or 8 more` @@ -55275,8 +55383,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enforced: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -55287,6 +55393,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -55295,13 +55405,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_connector_domain_guard_updated"` + - `previous_value: optional boolean or null` - default: org_connector_domain_guard_updated + Setting value immediately before this change - - `OrgCoworkActWithoutAskingModeDisabled object` + - `type: optional "org_claude_code_desktop_enabled"` - The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval. + default: org_claude_code_desktop_enabled + + - `OrgClaudeCodeZeroDataRetentionDisabled object` + + A primary owner disabled zero data retention for Claude Code, so Claude + Code content is retained according to the organization's data retention + settings. - `actor: object or object or object or 8 more` @@ -55532,13 +55648,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_act_without_asking_mode_disabled"` + - `type: optional "org_claude_code_zero_data_retention_disabled"` - default: org_cowork_act_without_asking_mode_disabled + default: org_claude_code_zero_data_retention_disabled - - `OrgCoworkActWithoutAskingModeEnabled object` + - `OrgComplianceAPISettingsUpdated object` - The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval. + Organization compliance API settings were updated. - `actor: object or object or object or 8 more` @@ -55755,6 +55871,14 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `compliance_api_enabled: optional boolean or null` + + Whether the compliance API is enabled for the organization after this change. + + - `compliance_api_logging_enabled: optional boolean or null` + + Whether compliance activity logging is enabled for the organization after this change. + - `created_at: optional string` When this activity occurred. @@ -55769,13 +55893,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_act_without_asking_mode_enabled"` + - `type: optional "org_compliance_api_settings_updated"` - default: org_cowork_act_without_asking_mode_enabled + default: org_compliance_api_settings_updated - - `OrgCoworkAgentDisabled object` + - `OrgConnectorDomainGuardUpdated object` - Organization Cowork Agent was disabled. + Enterprise admin changed whether connectors are restricted to verified domains. - `actor: object or object or object or 8 more` @@ -55988,6 +56112,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enforced: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -55998,10 +56124,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56010,17 +56132,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_agent_disabled"` + - `type: optional "org_connector_domain_guard_updated"` - default: org_cowork_agent_disabled + default: org_connector_domain_guard_updated - - `OrgCoworkAgentEnabled object` + - `OrgCoworkActWithoutAskingModeDisabled object` - Organization Cowork Agent was enabled. + The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval. - `actor: object or object or object or 8 more` @@ -56243,10 +56361,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56255,17 +56369,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_agent_enabled"` + - `type: optional "org_cowork_act_without_asking_mode_disabled"` - default: org_cowork_agent_enabled + default: org_cowork_act_without_asking_mode_disabled - - `OrgCoworkAutoModeDisabled object` + - `OrgCoworkActWithoutAskingModeEnabled object` - The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check. + The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval. - `actor: object or object or object or 8 more` @@ -56496,13 +56606,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_auto_mode_disabled"` + - `type: optional "org_cowork_act_without_asking_mode_enabled"` - default: org_cowork_auto_mode_disabled + default: org_cowork_act_without_asking_mode_enabled - - `OrgCoworkAutoModeEnabled object` + - `OrgCoworkAgentDisabled object` - The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check. + Organization Cowork Agent was disabled. - `actor: object or object or object or 8 more` @@ -56725,6 +56835,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56733,13 +56847,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_auto_mode_enabled"` + - `previous_value: optional boolean or null` - default: org_cowork_auto_mode_enabled + Setting value immediately before this change - - `OrgCoworkDisabled object` + - `type: optional "org_cowork_agent_disabled"` - Organization cowork was disabled. + default: org_cowork_agent_disabled + + - `OrgCoworkAgentEnabled object` + + Organization Cowork Agent was enabled. - `actor: object or object or object or 8 more` @@ -56978,13 +57096,13 @@ compliance activities that can be filtered by various criteria. Setting value immediately before this change - - `type: optional "org_cowork_disabled"` + - `type: optional "org_cowork_agent_enabled"` - default: org_cowork_disabled + default: org_cowork_agent_enabled - - `OrgCoworkEnabled object` + - `OrgCoworkAutoModeDisabled object` - Organization cowork was enabled. + The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check. - `actor: object or object or object or 8 more` @@ -57207,10 +57325,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -57219,17 +57333,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_enabled"` + - `type: optional "org_cowork_auto_mode_disabled"` - default: org_cowork_enabled + default: org_cowork_auto_mode_disabled - - `OrgCoworkMcpAlwaysAllowDisabled object` + - `OrgCoworkAutoModeEnabled object` - The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting. + The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check. - `actor: object or object or object or 8 more` @@ -57460,13 +57570,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_mcp_always_allow_disabled"` + - `type: optional "org_cowork_auto_mode_enabled"` - default: org_cowork_mcp_always_allow_disabled + default: org_cowork_auto_mode_enabled - - `OrgCoworkMcpAlwaysAllowEnabled object` + - `OrgCoworkDisabled object` - The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting. + Organization cowork was disabled. - `actor: object or object or object or 8 more` @@ -57689,6 +57799,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -57697,13 +57811,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_mcp_always_allow_enabled"` + - `previous_value: optional boolean or null` - default: org_cowork_mcp_always_allow_enabled + Setting value immediately before this change - - `OrgCoworkOtlpSettingsUpdated object` + - `type: optional "org_cowork_disabled"` - The organization's Cowork OpenTelemetry monitoring export settings were updated. + default: org_cowork_disabled + + - `OrgCoworkEnabled object` + + Organization cowork was enabled. - `actor: object or object or object or 8 more` @@ -57926,21 +58044,9 @@ compliance activities that can be filtered by various criteria. format: date-time - - `new_otlp_content_capture: optional array of string or null` - - The organization's content-capture settings after the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings are not set or were not modified by this update. - - - `new_otlp_endpoint: optional string or null` - - The OpenTelemetry export endpoint after the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint is unset or was not itself modified by this update. - - - `new_otlp_protocol: optional string or null` - - The OpenTelemetry export protocol after the change. Null if the protocol is unset or was not itself modified by this update. - - - `new_otlp_resource_attributes: optional string or null` + - `current_value: optional boolean or null` - The OpenTelemetry resource attributes after the change. Null if the attributes are unset or were not themselves modified by this update. + Setting value immediately after this change - `organization_id: optional string or null` @@ -57950,37 +58056,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `otlp_headers_change: optional "cleared" or "set" or null` - - Whether the OpenTelemetry export headers were set or cleared. 'set' is recorded for any non-empty submission, including resubmission of an unchanged value. Header values are never included. - - - `"cleared"` - - - `"set"` - - - `previous_otlp_content_capture: optional array of string or null` - - The organization's content-capture settings before the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings were not previously set or were not modified by this update. - - - `previous_otlp_endpoint: optional string or null` - - The OpenTelemetry export endpoint before the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint was previously unset or was not itself modified by this update. - - - `previous_otlp_protocol: optional string or null` - - The OpenTelemetry export protocol before the change. Null if the protocol was previously unset or was not itself modified by this update. - - - `previous_otlp_resource_attributes: optional string or null` + - `previous_value: optional boolean or null` - The OpenTelemetry resource attributes before the change. Null if the attributes were previously unset or were not themselves modified by this update. + Setting value immediately before this change - - `type: optional "org_cowork_otlp_settings_updated"` + - `type: optional "org_cowork_enabled"` - default: org_cowork_otlp_settings_updated + default: org_cowork_enabled - - `OrgCoworkRemoteDisabled object` + - `OrgCoworkMcpAlwaysAllowDisabled object` - Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments. + The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting. - `actor: object or object or object or 8 more` @@ -58211,13 +58297,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_remote_disabled"` + - `type: optional "org_cowork_mcp_always_allow_disabled"` - default: org_cowork_remote_disabled + default: org_cowork_mcp_always_allow_disabled - - `OrgCoworkRemoteEnabled object` + - `OrgCoworkMcpAlwaysAllowEnabled object` - Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments. + The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting. - `actor: object or object or object or 8 more` @@ -58448,13 +58534,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_remote_enabled"` + - `type: optional "org_cowork_mcp_always_allow_enabled"` - default: org_cowork_remote_enabled + default: org_cowork_mcp_always_allow_enabled - - `OrgCreationBlocked object` + - `OrgCoworkOtlpSettingsUpdated object` - Organization creation was blocked. + The organization's Cowork OpenTelemetry monitoring export settings were updated. - `actor: object or object or object or 8 more` @@ -58677,6 +58763,22 @@ compliance activities that can be filtered by various criteria. format: date-time + - `new_otlp_content_capture: optional array of string or null` + + The organization's content-capture settings after the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings are not set or were not modified by this update. + + - `new_otlp_endpoint: optional string or null` + + The OpenTelemetry export endpoint after the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint is unset or was not itself modified by this update. + + - `new_otlp_protocol: optional string or null` + + The OpenTelemetry export protocol after the change. Null if the protocol is unset or was not itself modified by this update. + + - `new_otlp_resource_attributes: optional string or null` + + The OpenTelemetry resource attributes after the change. Null if the attributes are unset or were not themselves modified by this update. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -58685,15 +58787,37 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reason: optional string or null` + - `otlp_headers_change: optional "cleared" or "set" or null` - - `type: optional "org_creation_blocked"` + Whether the OpenTelemetry export headers were set or cleared. 'set' is recorded for any non-empty submission, including resubmission of an unchanged value. Header values are never included. - default: org_creation_blocked + - `"cleared"` - - `OrgDataExportAccessed object` + - `"set"` - Organization data export file was accessed/downloaded via signed URL. + - `previous_otlp_content_capture: optional array of string or null` + + The organization's content-capture settings before the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings were not previously set or were not modified by this update. + + - `previous_otlp_endpoint: optional string or null` + + The OpenTelemetry export endpoint before the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint was previously unset or was not itself modified by this update. + + - `previous_otlp_protocol: optional string or null` + + The OpenTelemetry export protocol before the change. Null if the protocol was previously unset or was not itself modified by this update. + + - `previous_otlp_resource_attributes: optional string or null` + + The OpenTelemetry resource attributes before the change. Null if the attributes were previously unset or were not themselves modified by this update. + + - `type: optional "org_cowork_otlp_settings_updated"` + + default: org_cowork_otlp_settings_updated + + - `OrgCoworkRemoteDisabled object` + + Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments. - `actor: object or object or object or 8 more` @@ -58916,14 +59040,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was downloaded. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -58932,13 +59048,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_export_accessed"` + - `type: optional "org_cowork_remote_disabled"` - default: org_data_export_accessed + default: org_cowork_remote_disabled - - `OrgDataExportCompleted object` + - `OrgCoworkRemoteEnabled object` - Organization data export was completed. + Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments. - `actor: object or object or object or 8 more` @@ -59161,14 +59277,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was exported. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59177,13 +59285,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_export_completed"` + - `type: optional "org_cowork_remote_enabled"` - default: org_data_export_completed + default: org_cowork_remote_enabled - - `OrgDataExportStarted object` + - `OrgCreationBlocked object` - Organization data export was started. + Organization creation was blocked. - `actor: object or object or object or 8 more` @@ -59406,14 +59514,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was exported. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59422,21 +59522,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scope: optional "member_own_data" or "organization" or null` - - Breadth of the export — the whole organization, or only the requesting member's own data. Absent on records written before this field was introduced. - - - `"member_own_data"` - - - `"organization"` + - `reason: optional string or null` - - `type: optional "org_data_export_started"` + - `type: optional "org_creation_blocked"` - default: org_data_export_started + default: org_creation_blocked - - `OrgDataResidencyUpdated object` + - `OrgDataExportAccessed object` - The organization's inference data residency settings were updated. + Organization data export file was accessed/downloaded via signed URL. - `actor: object or object or object or 8 more` @@ -59649,22 +59743,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `updates: array of object` - - - `current_value: string or null` - - Setting value immediately after this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. - - - `previous_value: string or null` - - Setting value immediately before this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. - - - `type: "allowed_inference_geos" or "default_inference_geo"` - - - `"allowed_inference_geos"` - - - `"default_inference_geo"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -59675,6 +59753,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was downloaded. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59683,13 +59769,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_residency_updated"` + - `type: optional "org_data_export_accessed"` - default: org_data_residency_updated + default: org_data_export_accessed - - `OrgDeletedViaBulk object` + - `OrgDataExportCompleted object` - Organization was deleted via bulk operation. + Organization data export was completed. - `actor: object or object or object or 8 more` @@ -59912,6 +59998,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was exported. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59920,13 +60014,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_deleted_via_bulk"` + - `type: optional "org_data_export_completed"` - default: org_deleted_via_bulk + default: org_data_export_completed - - `OrgDeletionRequested object` + - `OrgDataExportStarted object` - Organization deletion was requested. + Organization data export was started. - `actor: object or object or object or 8 more` @@ -60149,6 +60243,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was exported. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -60157,13 +60259,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_deletion_requested"` + - `scope: optional "member_own_data" or "organization" or null` - default: org_deletion_requested + Breadth of the export — the whole organization, or only the requesting member's own data. Absent on records written before this field was introduced. - - `OrgDirectoryResyncCompleted object` + - `"member_own_data"` - Organization directory resync completed successfully. + - `"organization"` + + - `type: optional "org_data_export_started"` + + default: org_data_export_started + + - `OrgDataResidencyUpdated object` + + The organization's inference data residency settings were updated. - `actor: object or object or object or 8 more` @@ -60376,7 +60486,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` + - `updates: array of object` + + - `current_value: string or null` + + Setting value immediately after this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. + + - `previous_value: string or null` + + Setting value immediately before this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. + + - `type: "allowed_inference_geos" or "default_inference_geo"` + + - `"allowed_inference_geos"` + + - `"default_inference_geo"` - `id: optional string` @@ -60396,13 +60520,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_completed"` + - `type: optional "org_data_residency_updated"` - default: org_directory_resync_completed + default: org_data_residency_updated - - `OrgDirectoryResyncFailed object` + - `OrgDeletedViaBulk object` - Organization directory resync failed. + Organization was deleted via bulk operation. - `actor: object or object or object or 8 more` @@ -60615,8 +60739,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -60635,13 +60757,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_failed"` + - `type: optional "org_deleted_via_bulk"` - default: org_directory_resync_failed + default: org_deleted_via_bulk - - `OrgDirectoryResyncStarted object` + - `OrgDeletionRequested object` - Organization directory resync was started asynchronously. + Organization deletion was requested. - `actor: object or object or object or 8 more` @@ -60854,10 +60976,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` - - - `sync_destinations: array of string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -60876,13 +60994,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_started"` + - `type: optional "org_deletion_requested"` - default: org_directory_resync_started + default: org_deletion_requested - - `OrgDirectorySyncActivated object` + - `OrgDirectoryResyncCompleted object` - Organization directory sync was activated. + Organization directory resync completed successfully. - `actor: object or object or object or 8 more` @@ -61095,6 +61213,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61113,13 +61233,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_activated"` + - `type: optional "org_directory_resync_completed"` - default: org_directory_sync_activated + default: org_directory_resync_completed - - `OrgDirectorySyncAddInitiated object` + - `OrgDirectoryResyncFailed object` - Organization directory sync setup was initiated. + Organization directory resync failed. - `actor: object or object or object or 8 more` @@ -61332,6 +61452,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61350,13 +61472,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_add_initiated"` + - `type: optional "org_directory_resync_failed"` - default: org_directory_sync_add_initiated + default: org_directory_resync_failed - - `OrgDirectorySyncDeleted object` + - `OrgDirectoryResyncStarted object` - Organization directory sync was deleted. + Organization directory resync was started asynchronously. - `actor: object or object or object or 8 more` @@ -61569,6 +61691,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + + - `sync_destinations: array of string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61587,13 +61713,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_deleted"` + - `type: optional "org_directory_resync_started"` - default: org_directory_sync_deleted + default: org_directory_resync_started - - `OrgDiscoverabilityDisabled object` + - `OrgDirectorySyncActivated object` - Admin disabled organization discoverability. + Organization directory sync was activated. - `actor: object or object or object or 8 more` @@ -61824,13 +61950,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_disabled"` + - `type: optional "org_directory_sync_activated"` - default: org_discoverability_disabled + default: org_directory_sync_activated - - `OrgDiscoverabilityEnabled object` + - `OrgDirectorySyncAddInitiated object` - Admin enabled organization discoverability. + Organization directory sync setup was initiated. - `actor: object or object or object or 8 more` @@ -62061,13 +62187,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_enabled"` + - `type: optional "org_directory_sync_add_initiated"` - default: org_discoverability_enabled + default: org_directory_sync_add_initiated - - `OrgDiscoverabilitySettingsUpdated object` + - `OrgDirectorySyncDeleted object` - Admin updated organization discoverability settings. + Organization directory sync was deleted. - `actor: object or object or object or 8 more` @@ -62298,13 +62424,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_settings_updated"` + - `type: optional "org_directory_sync_deleted"` - default: org_discoverability_settings_updated + default: org_directory_sync_deleted - - `OrgDomainAddInitiated object` + - `OrgDiscoverabilityDisabled object` - Organization domain verification was initiated. + Admin disabled organization discoverability. - `actor: object or object or object or 8 more` @@ -62535,13 +62661,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_add_initiated"` + - `type: optional "org_discoverability_disabled"` - default: org_domain_add_initiated + default: org_discoverability_disabled - - `OrgDomainRemoved object` + - `OrgDiscoverabilityEnabled object` - Organization domain was removed. + Admin enabled organization discoverability. - `actor: object or object or object or 8 more` @@ -62764,8 +62890,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `domain: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -62774,13 +62898,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_removed"` + - `type: optional "org_discoverability_enabled"` - default: org_domain_removed + default: org_discoverability_enabled - - `OrgDomainVerified object` + - `OrgDiscoverabilitySettingsUpdated object` - Organization domain was verified. + Admin updated organization discoverability settings. - `actor: object or object or object or 8 more` @@ -63003,8 +63127,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `domain: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63013,13 +63135,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_verified"` + - `type: optional "org_discoverability_settings_updated"` - default: org_domain_verified + default: org_discoverability_settings_updated - - `OrgExternalKeyCreated object` + - `OrgDomainAddInitiated object` - A CMEK external key config was created. + Organization domain verification was initiated. - `actor: object or object or object or 8 more` @@ -63232,22 +63354,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the created external key config - - - `provider: "aws" or "azure" or "gcp" or "unspecified"` - - KMS provider backing the key - - - `"aws"` - - - `"azure"` - - - `"gcp"` - - - `"unspecified"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63266,13 +63372,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_created"` + - `type: optional "org_domain_add_initiated"` - default: org_external_key_created + default: org_domain_add_initiated - - `OrgExternalKeyDeleted object` + - `OrgDomainRemoved object` - A CMEK external key config was deleted. + Organization domain was removed. - `actor: object or object or object or 8 more` @@ -63485,10 +63591,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the deleted external key config - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63499,6 +63601,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `domain: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63507,13 +63611,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_deleted"` + - `type: optional "org_domain_removed"` - default: org_external_key_deleted + default: org_domain_removed - - `OrgExternalKeyUpdated object` + - `OrgDomainVerified object` - A CMEK external key config was updated. + Organization domain was verified. - `actor: object or object or object or 8 more` @@ -63726,10 +63830,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the updated external key config - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63740,6 +63840,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `domain: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63748,37 +63850,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_updated"` - - default: org_external_key_updated - - - `updates: optional array of object` - - The field-level changes applied in this update - - - `current_value: string` - - Field value immediately after this change - - - `previous_value: string` - - Field value immediately before this change - - - `type: "display_name" or "geo" or "provider_config" or "unspecified"` - - The external key config field that changed - - - `"display_name"` - - - `"geo"` - - - `"provider_config"` + - `type: optional "org_domain_verified"` - - `"unspecified"` + default: org_domain_verified - - `OrgExternalKeyValidated object` + - `OrgExternalKeyCreated object` - A CMEK external key config was validated against the customer's KMS. + A CMEK external key config was created. - `actor: object or object or object or 8 more` @@ -63993,15 +64071,17 @@ compliance activities that can be filtered by various criteria. - `external_key_id: string` - Tagged ID of the validated external key config + Tagged ID of the created external key config - - `validation_result: "failure" or "success" or "unspecified"` + - `provider: "aws" or "azure" or "gcp" or "unspecified"` - Outcome of the encrypt/decrypt roundtrip + KMS provider backing the key - - `"failure"` + - `"aws"` - - `"success"` + - `"azure"` + + - `"gcp"` - `"unspecified"` @@ -64023,14 +64103,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_validated"` + - `type: optional "org_external_key_created"` - default: org_external_key_validated + default: org_external_key_created - - `OrgHipaaSelfServeEnabled object` + - `OrgExternalKeyDeleted object` - A primary owner click-accepted the BAA and enabled HIPAA protections - for the organization via the self-serve flow. + A CMEK external key config was deleted. - `actor: object or object or object or 8 more` @@ -64243,11 +64322,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `baa_content_hash: string` - - - `baa_version_label: string` + - `external_key_id: string` - - `setup_guide_content_hash: string` + Tagged ID of the deleted external key config - `id: optional string` @@ -64267,13 +64344,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_hipaa_self_serve_enabled"` + - `type: optional "org_external_key_deleted"` - default: org_hipaa_self_serve_enabled + default: org_external_key_deleted - - `OrgIPRestrictionCreated object` + - `OrgExternalKeyUpdated object` - Organization IP restriction was created. + A CMEK external key config was updated. - `actor: object or object or object or 8 more` @@ -64486,6 +64563,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `external_key_id: string` + + Tagged ID of the updated external key config + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64504,13 +64585,37 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_created"` + - `type: optional "org_external_key_updated"` - default: org_ip_restriction_created + default: org_external_key_updated - - `OrgIPRestrictionDeleted object` + - `updates: optional array of object` - Organization IP restriction was deleted. + The field-level changes applied in this update + + - `current_value: string` + + Field value immediately after this change + + - `previous_value: string` + + Field value immediately before this change + + - `type: "display_name" or "geo" or "provider_config" or "unspecified"` + + The external key config field that changed + + - `"display_name"` + + - `"geo"` + + - `"provider_config"` + + - `"unspecified"` + + - `OrgExternalKeyValidated object` + + A CMEK external key config was validated against the customer's KMS. - `actor: object or object or object or 8 more` @@ -64723,6 +64828,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `external_key_id: string` + + Tagged ID of the validated external key config + + - `validation_result: "failure" or "success" or "unspecified"` + + Outcome of the encrypt/decrypt roundtrip + + - `"failure"` + + - `"success"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64741,13 +64860,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_deleted"` + - `type: optional "org_external_key_validated"` - default: org_ip_restriction_deleted + default: org_external_key_validated - - `OrgIPRestrictionUpdated object` + - `OrgHipaaSelfServeEnabled object` - Organization IP restriction was updated. + A primary owner click-accepted the BAA and enabled HIPAA protections + for the organization via the self-serve flow. - `actor: object or object or object or 8 more` @@ -64960,6 +65080,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `baa_content_hash: string` + + - `baa_version_label: string` + + - `setup_guide_content_hash: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64978,13 +65104,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_updated"` + - `type: optional "org_hipaa_self_serve_enabled"` - default: org_ip_restriction_updated + default: org_hipaa_self_serve_enabled - - `OrgInviteLinkDisabled object` + - `OrgIPRestrictionCreated object` - Organization invite link was disabled. + Organization IP restriction was created. - `actor: object or object or object or 8 more` @@ -65215,13 +65341,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_disabled"` + - `type: optional "org_ip_restriction_created"` - default: org_invite_link_disabled + default: org_ip_restriction_created - - `OrgInviteLinkGenerated object` + - `OrgIPRestrictionDeleted object` - Organization invite link was generated. + Organization IP restriction was deleted. - `actor: object or object or object or 8 more` @@ -65452,13 +65578,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_generated"` + - `type: optional "org_ip_restriction_deleted"` - default: org_invite_link_generated + default: org_ip_restriction_deleted - - `OrgInviteLinkRegenerated object` + - `OrgIPRestrictionUpdated object` - Organization invite link was regenerated (previous link invalidated). + Organization IP restriction was updated. - `actor: object or object or object or 8 more` @@ -65689,13 +65815,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_regenerated"` + - `type: optional "org_ip_restriction_updated"` - default: org_invite_link_regenerated + default: org_ip_restriction_updated - - `OrgInviteViewed object` + - `OrgInviteLinkDisabled object` - An organization invite was viewed. + Organization invite link was disabled. - `actor: object or object or object or 8 more` @@ -65908,10 +66034,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invite_id: string` - - Tagged ID of the viewed invite - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -65930,13 +66052,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_viewed"` + - `type: optional "org_invite_link_disabled"` - default: org_invite_viewed + default: org_invite_link_disabled - - `OrgInvitesListed object` + - `OrgInviteLinkGenerated object` - Organization invites were listed. + Organization invite link was generated. - `actor: object or object or object or 8 more` @@ -66167,13 +66289,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invites_listed"` + - `type: optional "org_invite_link_generated"` - default: org_invites_listed + default: org_invite_link_generated - - `OrgJoinProposalDecided object` + - `OrgInviteLinkRegenerated object` - Approve or reject decision on a parent-org join proposal. + Organization invite link was regenerated (previous link invalidated). - `actor: object or object or object or 8 more` @@ -66386,8 +66508,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `approved: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -66406,13 +66526,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_proposal_decided"` + - `type: optional "org_invite_link_regenerated"` - default: org_join_proposal_decided + default: org_invite_link_regenerated - - `OrgJoinRequestApproved object` + - `OrgInviteViewed object` - Admin approved a join request. + An organization invite was viewed. - `actor: object or object or object or 8 more` @@ -66625,6 +66745,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invite_id: string` + + Tagged ID of the viewed invite + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -66643,13 +66767,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_approved"` + - `type: optional "org_invite_viewed"` - default: org_join_request_approved + default: org_invite_viewed - - `OrgJoinRequestCreated object` + - `OrgInvitesListed object` - User requested to join an organization. + Organization invites were listed. - `actor: object or object or object or 8 more` @@ -66880,13 +67004,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_created"` + - `type: optional "org_invites_listed"` - default: org_join_request_created + default: org_invites_listed - - `OrgJoinRequestDismissed object` + - `OrgJoinProposalDecided object` - Admin dismissed a join request. + Approve or reject decision on a parent-org join proposal. - `actor: object or object or object or 8 more` @@ -67099,6 +67223,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `approved: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -67117,13 +67243,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_dismissed"` + - `type: optional "org_join_proposal_decided"` - default: org_join_request_dismissed + default: org_join_proposal_decided - - `OrgJoinRequestInstantApproved object` + - `OrgJoinRequestApproved object` - Join request was instantly approved. + Admin approved a join request. - `actor: object or object or object or 8 more` @@ -67354,13 +67480,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_instant_approved"` + - `type: optional "org_join_request_approved"` - default: org_join_request_instant_approved + default: org_join_request_approved - - `OrgJoinRequestsBulkDismissed object` + - `OrgJoinRequestCreated object` - Admin bulk-dismissed join requests. + User requested to join an organization. - `actor: object or object or object or 8 more` @@ -67591,13 +67717,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_requests_bulk_dismissed"` + - `type: optional "org_join_request_created"` - default: org_join_requests_bulk_dismissed + default: org_join_request_created - - `OrgMagicLinkSecondFactorToggled object` + - `OrgJoinRequestDismissed object` - Organization magic link second factor was toggled. + Admin dismissed a join request. - `actor: object or object or object or 8 more` @@ -67810,8 +67936,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -67830,13 +67954,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_magic_link_second_factor_toggled"` + - `type: optional "org_join_request_dismissed"` - default: org_magic_link_second_factor_toggled + default: org_join_request_dismissed - - `OrgMemberInvitesDisabled object` + - `OrgJoinRequestInstantApproved object` - Admin disabled member invites for the organization. + Join request was instantly approved. - `actor: object or object or object or 8 more` @@ -68067,13 +68191,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_member_invites_disabled"` + - `type: optional "org_join_request_instant_approved"` - default: org_member_invites_disabled + default: org_join_request_instant_approved - - `OrgMemberInvitesEnabled object` + - `OrgJoinRequestsBulkDismissed object` - Admin enabled member invites for the organization. + Admin bulk-dismissed join requests. - `actor: object or object or object or 8 more` @@ -68304,13 +68428,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_member_invites_enabled"` + - `type: optional "org_join_requests_bulk_dismissed"` - default: org_member_invites_enabled + default: org_join_requests_bulk_dismissed - - `OrgMembersExported object` + - `OrgMagicLinkSecondFactorToggled object` - Organization members list was exported as CSV. + Organization magic link second factor was toggled. - `actor: object or object or object or 8 more` @@ -68523,6 +68647,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -68541,23 +68667,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_members_exported"` - - default: org_members_exported - - - `OrgModelDefaultUpdated object` - - An organization or role default model setting was changed by an administrator. - - - `action: "cleared" or "set" or "unspecified"` - - Whether the default model was set or cleared + - `type: optional "org_magic_link_second_factor_toggled"` - - `"cleared"` + default: org_magic_link_second_factor_toggled - - `"set"` + - `OrgMemberInvitesDisabled object` - - `"unspecified"` + Admin disabled member invites for the organization. - `actor: object or object or object or 8 more` @@ -68770,24 +68886,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `override_user_selection: boolean` - - Whether the default is enforced as a fixed default, resetting members' own model selections at the start of each new conversation - - - `principal_id: string` - - Tagged ID of the organization or role the default applies to - - - `principal_type: "org" or "rbac_role" or "unspecified"` - - Whether the default applies to the whole organization or to a single role - - - `"org"` - - - `"rbac_role"` - - - `"unspecified"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -68798,26 +68896,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_model: optional string or null` - - The model set as the default, when the action is set - - - `model_access: optional array of object` - - The per-model access overrides set for this principal; absent when no overrides are configured - - - `api_name: string` - - The model the decision applies to - - - `enabled: boolean` - - Whether members with this principal may select the model - - - `max_effort_level: optional string or null` - - The highest effort level members may select for this model, when capped - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -68826,13 +68904,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_model_default_updated"` + - `type: optional "org_member_invites_disabled"` - default: org_model_default_updated + default: org_member_invites_disabled - - `OrgParentJoinProposalCreated object` + - `OrgMemberInvitesEnabled object` - Organization parent join proposal was created. + Admin enabled member invites for the organization. - `actor: object or object or object or 8 more` @@ -69063,13 +69141,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_parent_join_proposal_created"` + - `type: optional "org_member_invites_enabled"` - default: org_parent_join_proposal_created + default: org_member_invites_enabled - - `OrgParentSearchPerformed object` + - `OrgMembersExported object` - Organization parent search was performed. + Organization members list was exported as CSV. - `actor: object or object or object or 8 more` @@ -69300,13 +69378,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_parent_search_performed"` + - `type: optional "org_members_exported"` - default: org_parent_search_performed + default: org_members_exported - - `OrgSSOAddInitiated object` + - `OrgModelDefaultUpdated object` - Organization SSO setup was initiated. + An organization or role default model setting was changed by an administrator. + + - `action: "cleared" or "set" or "unspecified"` + + Whether the default model was set or cleared + + - `"cleared"` + + - `"set"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -69519,6 +69607,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `override_user_selection: boolean` + + Whether the default is enforced as a fixed default, resetting members' own model selections at the start of each new conversation + + - `principal_id: string` + + Tagged ID of the organization or role the default applies to + + - `principal_type: "org" or "rbac_role" or "unspecified"` + + Whether the default applies to the whole organization or to a single role + + - `"org"` + + - `"rbac_role"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -69529,6 +69635,26 @@ compliance activities that can be filtered by various criteria. format: date-time + - `default_model: optional string or null` + + The model set as the default, when the action is set + + - `model_access: optional array of object` + + The per-model access overrides set for this principal; absent when no overrides are configured + + - `api_name: string` + + The model the decision applies to + + - `enabled: boolean` + + Whether members with this principal may select the model + + - `max_effort_level: optional string or null` + + The highest effort level members may select for this model, when capped + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -69537,13 +69663,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_add_initiated"` + - `type: optional "org_model_default_updated"` - default: org_sso_add_initiated + default: org_model_default_updated - - `OrgSSOConnectionActivated object` + - `OrgParentJoinProposalCreated object` - Organization SSO connection was activated. + Organization parent join proposal was created. - `actor: object or object or object or 8 more` @@ -69760,10 +69886,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - - `connection_type: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -69778,13 +69900,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_activated"` + - `type: optional "org_parent_join_proposal_created"` - default: org_sso_connection_activated + default: org_parent_join_proposal_created - - `OrgSSOConnectionDeactivated object` + - `OrgParentSearchPerformed object` - Organization SSO connection was deactivated. + Organization parent search was performed. - `actor: object or object or object or 8 more` @@ -70001,8 +70123,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -70017,13 +70137,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_deactivated"` + - `type: optional "org_parent_search_performed"` - default: org_sso_connection_deactivated + default: org_parent_search_performed - - `OrgSSOConnectionDeleted object` + - `OrgSSOAddInitiated object` - Organization SSO connection was deleted. + Organization SSO setup was initiated. - `actor: object or object or object or 8 more` @@ -70240,8 +70360,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -70256,13 +70374,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_deleted"` + - `type: optional "org_sso_add_initiated"` - default: org_sso_connection_deleted + default: org_sso_add_initiated - - `OrgSSOGroupRoleMappingsUpdated object` + - `OrgSSOConnectionActivated object` - Organization SSO group role mappings were updated. + Organization SSO connection was activated. - `actor: object or object or object or 8 more` @@ -70479,6 +70597,10 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + + - `connection_type: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -70493,13 +70615,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_group_role_mappings_updated"` + - `type: optional "org_sso_connection_activated"` - default: org_sso_group_role_mappings_updated + default: org_sso_connection_activated - - `OrgSSOProvisioningModeChanged object` + - `OrgSSOConnectionDeactivated object` - Organization SSO provisioning mode was changed. + Organization SSO connection was deactivated. - `actor: object or object or object or 8 more` @@ -70716,14 +70838,14 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + - `created_at: optional string` When this activity occurred. format: date-time - - `new_mode: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -70732,15 +70854,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mode: optional string or null` - - - `type: optional "org_sso_provisioning_mode_changed"` + - `type: optional "org_sso_connection_deactivated"` - default: org_sso_provisioning_mode_changed + default: org_sso_connection_deactivated - - `OrgSSOScimWelcomeEmailToggled object` + - `OrgSSOConnectionDeleted object` - Organization SCIM-provisioned welcome email was toggled. + Organization SSO connection was deleted. - `actor: object or object or object or 8 more` @@ -70953,12 +71073,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -70973,17 +71093,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether the SCIM welcome email was enabled before this change. - - - `type: optional "org_sso_scim_welcome_email_toggled"` + - `type: optional "org_sso_connection_deleted"` - default: org_sso_scim_welcome_email_toggled + default: org_sso_connection_deleted - - `OrgSSOSeatTierAssignmentToggled object` + - `OrgSSOGroupRoleMappingsUpdated object` - Organization SSO seat tier assignment was toggled. + Organization SSO group role mappings were updated. - `actor: object or object or object or 8 more` @@ -71196,8 +71312,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -71216,17 +71330,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether SSO seat tier assignment was enabled before this change. - - - `type: optional "org_sso_seat_tier_assignment_toggled"` + - `type: optional "org_sso_group_role_mappings_updated"` - default: org_sso_seat_tier_assignment_toggled + default: org_sso_group_role_mappings_updated - - `OrgSSOSeatTierMappingsUpdated object` + - `OrgSSOProvisioningModeChanged object` - Organization SSO seat tier mappings were updated. + Organization SSO provisioning mode was changed. - `actor: object or object or object or 8 more` @@ -71449,17 +71559,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_mappings: optional array of object or null` - - Identity provider group to seat tier mappings after this change. - - - `idp_group_name: string` - - Name of the identity provider group. - - - `seat_tier: optional string or null` - - Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `new_mode: optional string or null` - `organization_id: optional string or null` @@ -71469,25 +71569,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mappings: optional array of object or null` - - Identity provider group to seat tier mappings before this change. - - - `idp_group_name: string` - - Name of the identity provider group. - - - `seat_tier: optional string or null` - - Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `previous_mode: optional string or null` - - `type: optional "org_sso_seat_tier_mappings_updated"` + - `type: optional "org_sso_provisioning_mode_changed"` - default: org_sso_seat_tier_mappings_updated + default: org_sso_provisioning_mode_changed - - `OrgSSOToggled object` + - `OrgSSOScimWelcomeEmailToggled object` - Organization SSO was toggled on or off. + Organization SCIM-provisioned welcome email was toggled. - `actor: object or object or object or 8 more` @@ -71720,13 +71810,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_toggled"` + - `previous_enabled: optional boolean or null` - default: org_sso_toggled + Whether the SCIM welcome email was enabled before this change. - - `OrgSyncDeletingSynchronizedFilesStarted object` + - `type: optional "org_sso_scim_welcome_email_toggled"` - Organization started deleting synchronized files. + default: org_sso_scim_welcome_email_toggled + + - `OrgSSOSeatTierAssignmentToggled object` + + Organization SSO seat tier assignment was toggled. - `actor: object or object or object or 8 more` @@ -71939,6 +72033,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -71957,13 +72053,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sync_deleting_synchronized_files_started"` + - `previous_enabled: optional boolean or null` - default: org_sync_deleting_synchronized_files_started + Whether SSO seat tier assignment was enabled before this change. - - `OrgSyncSynchronizedFilesDeleted object` + - `type: optional "org_sso_seat_tier_assignment_toggled"` - Organization synchronized files were deleted. + default: org_sso_seat_tier_assignment_toggled + + - `OrgSSOSeatTierMappingsUpdated object` + + Organization SSO seat tier mappings were updated. - `actor: object or object or object or 8 more` @@ -72186,6 +72286,18 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_mappings: optional array of object or null` + + Identity provider group to seat tier mappings after this change. + + - `idp_group_name: string` + + Name of the identity provider group. + + - `seat_tier: optional string or null` + + Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -72194,13 +72306,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sync_synchronized_files_deleted"` + - `previous_mappings: optional array of object or null` - default: org_sync_synchronized_files_deleted + Identity provider group to seat tier mappings before this change. - - `OrgTaintAdded object` + - `idp_group_name: string` - A taint was added to an organization. + Name of the identity provider group. + + - `seat_tier: optional string or null` + + Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + + - `type: optional "org_sso_seat_tier_mappings_updated"` + + default: org_sso_seat_tier_mappings_updated + + - `OrgSSOToggled object` + + Organization SSO was toggled on or off. - `actor: object or object or object or 8 more` @@ -72413,6 +72537,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -72431,19 +72557,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `taint: optional string or null` - - - `type: optional "org_taint_added"` - - default: org_taint_added - - - `workspace_id: optional string or null` + - `type: optional "org_sso_toggled"` - Tagged ID of the workspace the taint was applied to. Unset when applied at organization scope. + default: org_sso_toggled - - `OrgTaintRemoved object` + - `OrgSyncDeletingSynchronizedFilesStarted object` - A taint was removed from an organization. + Organization started deleting synchronized files. - `actor: object or object or object or 8 more` @@ -72674,15 +72794,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `taint: optional string or null` - - - `type: optional "org_taint_removed"` + - `type: optional "org_sync_deleting_synchronized_files_started"` - default: org_taint_removed + default: org_sync_deleting_synchronized_files_started - - `OrgUserDeleted object` + - `OrgSyncSynchronizedFilesDeleted object` - User was removed from organization. + Organization synchronized files were deleted. - `actor: object or object or object or 8 more` @@ -72905,10 +73023,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `deleted_user_email: optional string or null` - - - `deleted_user_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -72917,13 +73031,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_deleted"` + - `type: optional "org_sync_synchronized_files_deleted"` - default: org_user_deleted + default: org_sync_synchronized_files_deleted - - `OrgUserInviteAccepted object` + - `OrgTaintAdded object` - Organization user invite was accepted. + A taint was added to an organization. - `actor: object or object or object or 8 more` @@ -73146,8 +73260,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invite_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -73156,17 +73268,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `rbac_group_ids: optional array of string or null` + - `taint: optional string or null` - RBAC group IDs the user was added to on acceptance, as confirmed by the group service (absent on rows written before this was recorded, and when the invite carried no groups) + - `type: optional "org_taint_added"` - - `type: optional "org_user_invite_accepted"` + default: org_taint_added - default: org_user_invite_accepted + - `workspace_id: optional string or null` - - `OrgUserInviteDeleted object` + Tagged ID of the workspace the taint was applied to. Unset when applied at organization scope. - Organization user invite was deleted. + - `OrgTaintRemoved object` + + A taint was removed from an organization. - `actor: object or object or object or 8 more` @@ -73389,8 +73503,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invite_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -73399,13 +73511,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_deleted"` + - `taint: optional string or null` - default: org_user_invite_deleted + - `type: optional "org_taint_removed"` - - `OrgUserInviteReSent object` + default: org_taint_removed - Organization user invite was re-sent. + - `OrgUserDeleted object` + + User was removed from organization. - `actor: object or object or object or 8 more` @@ -73628,15 +73742,9 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invited_email: optional string or null` - - - `invited_role: optional string or null` - - Role the invited user will receive on joining - - - `invited_seat_tier: optional string or null` + - `deleted_user_email: optional string or null` - Seat tier the invited user will receive on joining + - `deleted_user_id: optional string or null` - `organization_id: optional string or null` @@ -73646,13 +73754,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_re_sent"` + - `type: optional "org_user_deleted"` - default: org_user_invite_re_sent + default: org_user_deleted - - `OrgUserInviteRejected object` + - `OrgUserInviteAccepted object` - Organization user invite was rejected. + Organization user invite was accepted. - `actor: object or object or object or 8 more` @@ -73885,13 +73993,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_rejected"` + - `rbac_group_ids: optional array of string or null` - default: org_user_invite_rejected + RBAC group IDs the user was added to on acceptance, as confirmed by the group service (absent on rows written before this was recorded, and when the invite carried no groups) - - `OrgUserInviteSent object` + - `type: optional "org_user_invite_accepted"` - Organization user invite was sent. + default: org_user_invite_accepted + + - `OrgUserInviteDeleted object` + + Organization user invite was deleted. - `actor: object or object or object or 8 more` @@ -74114,17 +74226,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invited_email: optional string or null` - - - `invited_rbac_group_ids: optional array of string or null` - - RBAC group IDs the invited user will be added to on joining - - - `invited_role: optional string or null` - - - `invited_seat_tier: optional string or null` - - Seat tier the invited user will receive on joining + - `invite_id: optional string or null` - `organization_id: optional string or null` @@ -74134,13 +74236,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_sent"` + - `type: optional "org_user_invite_deleted"` - default: org_user_invite_sent + default: org_user_invite_deleted - - `OrgUserLeft object` + - `OrgUserInviteReSent object` - User removed themselves from organization. + Organization user invite was re-sent. - `actor: object or object or object or 8 more` @@ -74363,6 +74465,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invited_email: optional string or null` + + - `invited_role: optional string or null` + + Role the invited user will receive on joining + + - `invited_seat_tier: optional string or null` + + Seat tier the invited user will receive on joining + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74371,15 +74483,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_role: optional string or null` - - - `type: optional "org_user_left"` + - `type: optional "org_user_invite_re_sent"` - default: org_user_left + default: org_user_invite_re_sent - - `OrgUserTrustedDevicesRevoked object` + - `OrgUserInviteRejected object` - An organization admin revoked a member's trusted devices and signed the member out of all active sessions. + Organization user invite was rejected. - `actor: object or object or object or 8 more` @@ -74592,22 +74702,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `completed: boolean` - - Whether the operation completed fully. False records an attempt that revoked the counted credentials but failed before finishing. - - - `devices_revoked_count: number` - - Number of trusted devices revoked - - - `sessions_revoked_count: number` - - Number of active sessions the member was signed out of - - - `user_id: string` - - Tagged ID of the member whose trusted devices were revoked - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -74618,6 +74712,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invite_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74626,13 +74722,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_trusted_devices_revoked"` + - `type: optional "org_user_invite_rejected"` - default: org_user_trusted_devices_revoked + default: org_user_invite_rejected - - `OrgUserViewed object` + - `OrgUserInviteSent object` - An organization user was viewed. + Organization user invite was sent. - `actor: object or object or object or 8 more` @@ -74845,10 +74941,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` - - Tagged ID of the viewed user - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -74859,6 +74951,18 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invited_email: optional string or null` + + - `invited_rbac_group_ids: optional array of string or null` + + RBAC group IDs the invited user will be added to on joining + + - `invited_role: optional string or null` + + - `invited_seat_tier: optional string or null` + + Seat tier the invited user will receive on joining + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74867,13 +74971,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_viewed"` + - `type: optional "org_user_invite_sent"` - default: org_user_viewed + default: org_user_invite_sent - - `OrgUsersListed object` + - `OrgUserLeft object` - Organization users were listed. + User removed themselves from organization. - `actor: object or object or object or 8 more` @@ -75104,13 +75208,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_users_listed"` + - `previous_role: optional string or null` - default: org_users_listed + - `type: optional "org_user_left"` - - `OrgWorkAcrossAppsDisabled object` + default: org_user_left - Organization Work Across Apps was disabled. + - `OrgUserTrustedDevicesRevoked object` + + An organization admin revoked a member's trusted devices and signed the member out of all active sessions. - `actor: object or object or object or 8 more` @@ -75323,6 +75429,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `completed: boolean` + + Whether the operation completed fully. False records an attempt that revoked the counted credentials but failed before finishing. + + - `devices_revoked_count: number` + + Number of trusted devices revoked + + - `sessions_revoked_count: number` + + Number of active sessions the member was signed out of + + - `user_id: string` + + Tagged ID of the member whose trusted devices were revoked + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -75333,10 +75455,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -75345,17 +75463,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_work_across_apps_disabled"` + - `type: optional "org_user_trusted_devices_revoked"` - default: org_work_across_apps_disabled + default: org_user_trusted_devices_revoked - - `OrgWorkAcrossAppsEnabled object` + - `OrgUserViewed object` - Organization Work Across Apps was enabled. + An organization user was viewed. - `actor: object or object or object or 8 more` @@ -75568,6 +75682,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + + Tagged ID of the viewed user + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -75578,10 +75696,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -75590,17 +75704,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_work_across_apps_enabled"` + - `type: optional "org_user_viewed"` - default: org_work_across_apps_enabled + default: org_user_viewed - - `OrganizationAddressUpdated object` + - `OrgUsersListed object` - The organization's billing or shipping address was updated. + Organization users were listed. - `actor: object or object or object or 8 more` @@ -75817,14 +75927,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `billing_address_updated: optional boolean` - - default: false - - - `billing_name_updated: optional boolean` - - default: false - - `created_at: optional string` When this activity occurred. @@ -75839,21 +75941,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `shipping_address_updated: optional boolean` - - default: false - - - `shipping_name_updated: optional boolean` - - default: false + - `type: optional "org_users_listed"` - - `type: optional "organization_address_updated"` + default: org_users_listed - default: organization_address_updated + - `OrgWorkAcrossAppsDisabled object` - - `OrganizationIconDeleted object` - - Organization's custom icon deleted. + The organization's "Let Claude work across apps" setting was turned off. - `actor: object or object or object or 8 more` @@ -76076,6 +76170,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -76084,13 +76182,752 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "organization_icon_deleted"` + - `previous_value: optional boolean or null` - default: organization_icon_deleted + Setting value immediately before this change - - `OrganizationIconUpdated object` + - `type: optional "org_work_across_apps_disabled"` - Organization's custom icon uploaded or replaced. + default: org_work_across_apps_disabled + + - `OrgWorkAcrossAppsEnabled object` + + The organization's "Let Claude work across apps" setting was turned on. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "org_work_across_apps_enabled"` + + default: org_work_across_apps_enabled + + - `OrganizationAddressUpdated object` + + The organization's billing or shipping address was updated. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `billing_address_updated: optional boolean` + + default: false + + - `billing_name_updated: optional boolean` + + default: false + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `shipping_address_updated: optional boolean` + + default: false + + - `shipping_name_updated: optional boolean` + + default: false + + - `type: optional "organization_address_updated"` + + default: organization_address_updated + + - `OrganizationIconDeleted object` + + Organization's custom icon deleted. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "organization_icon_deleted"` + + default: organization_icon_deleted + + - `OrganizationIconUpdated object` + + Organization's custom icon uploaded or replaced. - `actor: object or object or object or 8 more` @@ -76542,15 +77379,15 @@ compliance activities that can be filtered by various criteria. - `updates: array of object or object or object or 84 more` - - `OrganizationName object` + - `Name object` The organization name setting was changed. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change @@ -76558,15 +77395,15 @@ compliance activities that can be filtered by various criteria. default: name - - `OrganizationCapabilities object` + - `Capabilities object` The organization capabilities setting was changed. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -76574,15 +77411,15 @@ compliance activities that can be filtered by various criteria. default: capabilities - - `OrganizationRedactContent object` + - `RedactContent object` The organization content-redaction setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76594,11 +77431,11 @@ compliance activities that can be filtered by various criteria. The public projects setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76610,11 +77447,11 @@ compliance activities that can be filtered by various criteria. The web search setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76626,11 +77463,11 @@ compliance activities that can be filtered by various criteria. The geolocation setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76638,15 +77475,15 @@ compliance activities that can be filtered by various criteria. default: geolocation_enabled - - `OrgMemoryEnabledSetting object` + - `EnabledSaffron object` The memory setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76658,7 +77495,7 @@ compliance activities that can be filtered by various criteria. The data retention periods setting was changed for the organization. - - `current_value: array of object or null` + - `current_value: optional array of object or null` Setting value immediately after this change @@ -76686,7 +77523,7 @@ compliance activities that can be filtered by various criteria. - `"month"` - - `previous_value: array of object or null` + - `previous_value: optional array of object or null` Setting value immediately before this change @@ -76722,11 +77559,11 @@ compliance activities that can be filtered by various criteria. The members limit setting was changed for the organization. - - `current_value: number or null` + - `current_value: optional number or null` Setting value immediately after this change - - `previous_value: number or null` + - `previous_value: optional number or null` Setting value immediately before this change @@ -76738,11 +77575,11 @@ compliance activities that can be filtered by various criteria. The Claude API in Artifacts setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76754,7 +77591,7 @@ compliance activities that can be filtered by various criteria. The support contact routing mode setting was changed for the organization. - - `current_value: "ai_support_only" or "human_support_restricted" or null` + - `current_value: optional "ai_support_only" or "human_support_restricted" or "unspecified" or null` Setting value immediately after this change @@ -76762,7 +77599,9 @@ compliance activities that can be filtered by various criteria. - `"human_support_restricted"` - - `previous_value: "ai_support_only" or "human_support_restricted" or null` + - `"unspecified"` + + - `previous_value: optional "ai_support_only" or "human_support_restricted" or "unspecified" or null` Setting value immediately before this change @@ -76770,6 +77609,8 @@ compliance activities that can be filtered by various criteria. - `"human_support_restricted"` + - `"unspecified"` + - `type: optional "support_contact_mode"` default: support_contact_mode @@ -76778,11 +77619,11 @@ compliance activities that can be filtered by various criteria. The support contact always-include-admins-owners setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76794,11 +77635,11 @@ compliance activities that can be filtered by various criteria. The support contact designated groups setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -76810,11 +77651,11 @@ compliance activities that can be filtered by various criteria. The organization's subscription seat quotas were changed. - - `current_value: map[number] or null` + - `current_value: optional map[number] or null` Seat-type to quantity mapping immediately after this change. A null quantity means the item is unlimited/unmetered. - - `previous_value: map[number] or null` + - `previous_value: optional map[number] or null` Seat-type to quantity mapping immediately before this change. A null quantity means the item was unlimited/unmetered. @@ -76826,7 +77667,7 @@ compliance activities that can be filtered by various criteria. All organization members were assigned the specified seat tier. - - `current_value: string or null` + - `current_value: optional string or null` The seat tier every member was assigned to @@ -76846,11 +77687,11 @@ compliance activities that can be filtered by various criteria. The Claude Code on the web setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76862,11 +77703,11 @@ compliance activities that can be filtered by various criteria. The Claude Code Desktop bypass-permissions mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76878,11 +77719,11 @@ compliance activities that can be filtered by various criteria. The Claude Code Desktop auto-permissions mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76894,11 +77735,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai skills setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76910,11 +77751,11 @@ compliance activities that can be filtered by various criteria. The Workbench completion feedback setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76926,11 +77767,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai completion feedback setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76942,11 +77783,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai integration sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76958,11 +77799,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai chat sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76970,15 +77811,15 @@ compliance activities that can be filtered by various criteria. default: claude_ai_chat_sharing_enabled - - `ClaudeAiccrSharingEnabled object` + - `ClaudeAICcrSharingEnabled object` The Claude.ai remote Claude Code session sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -76986,15 +77827,15 @@ compliance activities that can be filtered by various criteria. default: claude_ai_ccr_sharing_enabled - - `ClaudeAiccrSupportSharingEnabled object` + - `ClaudeAICcrSupportSharingEnabled object` The Anthropic support access setting for Claude Code sessions was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77006,7 +77847,7 @@ compliance activities that can be filtered by various criteria. The batches download UI visibility setting was changed for the organization. - - `current_value: "all" or "none" or "selected" or null` + - `current_value: optional "all" or "none" or "selected" or "unspecified" or null` Setting value immediately after this change @@ -77016,7 +77857,9 @@ compliance activities that can be filtered by various criteria. - `"selected"` - - `previous_value: "all" or "none" or "selected" or null` + - `"unspecified"` + + - `previous_value: optional "all" or "none" or "selected" or "unspecified" or null` Setting value immediately before this change @@ -77026,6 +77869,8 @@ compliance activities that can be filtered by various criteria. - `"selected"` + - `"unspecified"` + - `type: optional "batches_download_ui_visibility"` default: batches_download_ui_visibility @@ -77034,11 +77879,11 @@ compliance activities that can be filtered by various criteria. The allowed invite domains setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -77046,11 +77891,11 @@ compliance activities that can be filtered by various criteria. default: allowed_invite_domains - - `WebSearchAPISettingsChanged object` + - `WebSearchAPISettings object` The web search API setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -77064,7 +77909,7 @@ compliance activities that can be filtered by various criteria. - `is_enabled: boolean` - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -77082,11 +77927,11 @@ compliance activities that can be filtered by various criteria. default: web_search_api_settings - - `WebFetchAPISettingsChanged object` + - `WebFetchAPISettings object` The web fetch API setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -77100,7 +77945,7 @@ compliance activities that can be filtered by various criteria. - `is_enabled: boolean` - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -77122,7 +77967,7 @@ compliance activities that can be filtered by various criteria. The default workspace setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -77130,7 +77975,7 @@ compliance activities that can be filtered by various criteria. default: true - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -77146,11 +77991,11 @@ compliance activities that can be filtered by various criteria. The batches download UI enabled workspace IDs setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -77183,11 +78028,11 @@ compliance activities that can be filtered by various criteria. Tracks changes to the enterprise account session duration setting (in seconds). - - `current_value: number or null` + - `current_value: optional number or null` Setting value immediately after this change - - `previous_value: number or null` + - `previous_value: optional number or null` Setting value immediately before this change @@ -77199,7 +78044,7 @@ compliance activities that can be filtered by various criteria. Tracks changes to VCS (GitHub, etc.) organization connections. - - `current_value: array of object or null` + - `current_value: optional array of object or null` Setting value immediately after this change @@ -77213,7 +78058,7 @@ compliance activities that can be filtered by various criteria. - `org_id: optional string or null` - - `previous_value: array of object or null` + - `previous_value: optional array of object or null` Setting value immediately before this change @@ -77235,11 +78080,11 @@ compliance activities that can be filtered by various criteria. Tracks changes to which admin request types are disabled. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -77251,11 +78096,11 @@ compliance activities that can be filtered by various criteria. The member usage dashboard visibility setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77267,11 +78112,11 @@ compliance activities that can be filtered by various criteria. The code execution network egress setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77283,11 +78128,11 @@ compliance activities that can be filtered by various criteria. The code execution domain allowlist setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -77299,7 +78144,7 @@ compliance activities that can be filtered by various criteria. The code execution domain allowlist template setting was changed for the organization. - - `current_value: "custom" or "full_egress" or "package_managers" or null` + - `current_value: optional "custom" or "full_egress" or "package_managers" or "unspecified" or null` Setting value immediately after this change @@ -77309,7 +78154,9 @@ compliance activities that can be filtered by various criteria. - `"package_managers"` - - `previous_value: "custom" or "full_egress" or "package_managers" or null` + - `"unspecified"` + + - `previous_value: optional "custom" or "full_egress" or "package_managers" or "unspecified" or null` Setting value immediately before this change @@ -77319,6 +78166,8 @@ compliance activities that can be filtered by various criteria. - `"package_managers"` + - `"unspecified"` + - `type: optional "code_execution_domain_allowlist_template_changed"` default: code_execution_domain_allowlist_template_changed @@ -77327,11 +78176,11 @@ compliance activities that can be filtered by various criteria. The chat setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77343,11 +78192,11 @@ compliance activities that can be filtered by various criteria. The Claude Code quick web setup setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77359,7 +78208,7 @@ compliance activities that can be filtered by various criteria. The Claude Code team memory mode setting was changed for the organization. - - `current_value: "all_org_members" or "github_repo" or "off" or "specific_groups" or null` + - `current_value: optional "all_org_members" or "github_repo" or "off" or 2 more or null` Setting value immediately after this change @@ -77371,7 +78220,9 @@ compliance activities that can be filtered by various criteria. - `"specific_groups"` - - `previous_value: "all_org_members" or "github_repo" or "off" or "specific_groups" or null` + - `"unspecified"` + + - `previous_value: optional "all_org_members" or "github_repo" or "off" or 2 more or null` Setting value immediately before this change @@ -77383,19 +78234,21 @@ compliance activities that can be filtered by various criteria. - `"specific_groups"` + - `"unspecified"` + - `type: optional "claude_code_team_memory_mode"` default: claude_code_team_memory_mode - - `BrowserExtensionSettingsUpdated object` + - `BrowserExtensionSettings object` The browser extension setting was changed for the organization. - - `current_value: map[unknown] or null` + - `current_value: optional map[unknown] or null` Setting value immediately after this change - - `previous_value: map[unknown] or null` + - `previous_value: optional map[unknown] or null` Setting value immediately before this change @@ -77403,15 +78256,15 @@ compliance activities that can be filtered by various criteria. default: browser_extension_settings - - `DesktopExtensionAllowlistEnabled object` + - `IsDesktopExtensionAllowlistEnabled object` The desktop extension allowlist setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77423,11 +78276,11 @@ compliance activities that can be filtered by various criteria. The per-member self-serve data export setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77435,15 +78288,15 @@ compliance activities that can be filtered by various criteria. default: allow_member_data_export - - `ClaudeDesignEnabled object` + - `ClaudeAIDesignEnabled object` The Claude Design setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77455,11 +78308,11 @@ compliance activities that can be filtered by various criteria. The setting that turns Claude Science on or off for the organization was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77471,11 +78324,11 @@ compliance activities that can be filtered by various criteria. The Claude Science memory setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77487,11 +78340,11 @@ compliance activities that can be filtered by various criteria. The Claude Science custom connectors setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77503,11 +78356,11 @@ compliance activities that can be filtered by various criteria. The Claude Science custom skills setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77519,11 +78372,11 @@ compliance activities that can be filtered by various criteria. The Claude Science setting that puts the network allowlist under the organization's management, instead of each member managing their own, was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77535,11 +78388,11 @@ compliance activities that can be filtered by various criteria. The Claude Science SSH hosts setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77551,11 +78404,11 @@ compliance activities that can be filtered by various criteria. The Claude Science setting that lets members connect Modal cloud compute was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77567,11 +78420,11 @@ compliance activities that can be filtered by various criteria. The Claude Science scientific model endpoints setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77583,11 +78436,11 @@ compliance activities that can be filtered by various criteria. The hostnames on the organization's Claude Science network allowlist, which applies to members while the organization manages the allowlist, were changed. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list is saved (this change reset it), so Claude Science's built-in allowlist applies; an empty list means a list with no domains on it is saved. - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list was saved at that point (never saved, or since reset), so Claude Science's built-in allowlist applied; an empty list means a list with no domains on it had been saved. @@ -77599,11 +78452,11 @@ compliance activities that can be filtered by various criteria. The Claude Science Modal cloud compute workspace allowlist setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change: the Modal workspace names members can connect to. Null or an empty list means any workspace is allowed. - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change: the Modal workspace names members could connect to. Null or an empty list means any workspace was allowed. @@ -77615,11 +78468,11 @@ compliance activities that can be filtered by various criteria. The Claude Science package mirror setting for the conda channel was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. @@ -77631,11 +78484,11 @@ compliance activities that can be filtered by various criteria. The Claude Science package mirror setting for the Python package index was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. @@ -77643,15 +78496,15 @@ compliance activities that can be filtered by various criteria. default: claude_science_package_mirror_pip_index_changed - - `SkillPluginsScanningEnabled object` + - `ClaudeAISkillPluginsScanningEnabled object` The skill and plugin security scanning setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77663,11 +78516,11 @@ compliance activities that can be filtered by various criteria. The Artifact publishing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77679,11 +78532,11 @@ compliance activities that can be filtered by various criteria. The Artifact external sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77695,11 +78548,11 @@ compliance activities that can be filtered by various criteria. The Artifact presence setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77711,11 +78564,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai skill sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77727,11 +78580,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai organization-wide skill sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77743,11 +78596,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai group-based skill sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77759,7 +78612,7 @@ compliance activities that can be filtered by various criteria. The Claude.ai organization skill publish policy was changed for the organization. - - `current_value: "off" or "open" or "review" or null` + - `current_value: optional "off" or "open" or "review" or "unspecified" or null` Setting value immediately after this change @@ -77769,7 +78622,9 @@ compliance activities that can be filtered by various criteria. - `"review"` - - `previous_value: "off" or "open" or "review" or null` + - `"unspecified"` + + - `previous_value: optional "off" or "open" or "review" or "unspecified" or null` Setting value immediately before this change @@ -77779,6 +78634,8 @@ compliance activities that can be filtered by various criteria. - `"review"` + - `"unspecified"` + - `type: optional "claude_ai_skill_publish_policy"` default: claude_ai_skill_publish_policy @@ -77787,11 +78644,11 @@ compliance activities that can be filtered by various criteria. The Claude Code remote control setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77803,11 +78660,11 @@ compliance activities that can be filtered by various criteria. The Claude Code remote control auto-enable default was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77819,11 +78676,11 @@ compliance activities that can be filtered by various criteria. The Claude Code routines setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77835,11 +78692,11 @@ compliance activities that can be filtered by various criteria. The Claude Code Workflows setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77851,11 +78708,11 @@ compliance activities that can be filtered by various criteria. The frontier services data use setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77867,11 +78724,11 @@ compliance activities that can be filtered by various criteria. The LTI course projects setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77883,11 +78740,11 @@ compliance activities that can be filtered by various criteria. The Claude.ai skill creation setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77899,11 +78756,11 @@ compliance activities that can be filtered by various criteria. The Claude Code GitHub analytics setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77915,11 +78772,11 @@ compliance activities that can be filtered by various criteria. The Claude Code hide managed environments setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77931,11 +78788,11 @@ compliance activities that can be filtered by various criteria. The Claude Code allow session pool moves setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77947,11 +78804,11 @@ compliance activities that can be filtered by various criteria. The Claude Code disable Anthropic compute setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77963,11 +78820,11 @@ compliance activities that can be filtered by various criteria. The Claude Code metrics logging setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77979,11 +78836,11 @@ compliance activities that can be filtered by various criteria. The Claude Code fast mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -77995,11 +78852,11 @@ compliance activities that can be filtered by various criteria. The Claude Code trusted devices setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -78011,11 +78868,11 @@ compliance activities that can be filtered by various criteria. The Cowork trusted devices enforcement setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -78027,11 +78884,11 @@ compliance activities that can be filtered by various criteria. The inline visualizations setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -78039,15 +78896,15 @@ compliance activities that can be filtered by various criteria. default: inline_visualizations_enabled - - `OrganizationBannerSettingsUpdated object` + - `OrganizationBannerSettings object` The organization banner setting was changed. - - `current_value: map[unknown] or null` + - `current_value: optional map[unknown] or null` Setting value immediately after this change - - `previous_value: map[unknown] or null` + - `previous_value: optional map[unknown] or null` Setting value immediately before this change @@ -78055,15 +78912,15 @@ compliance activities that can be filtered by various criteria. default: organization_banner_settings - - `ClaudeInSlackSettingsUpdated object` + - `ClaudeInSlackSettings object` The Claude in Slack setting was changed for the organization. - - `current_value: map[unknown] or null` + - `current_value: optional map[unknown] or null` Setting value immediately after this change - - `previous_value: map[unknown] or null` + - `previous_value: optional map[unknown] or null` Setting value immediately before this change @@ -78075,11 +78932,11 @@ compliance activities that can be filtered by various criteria. The Claude Code default worker environment setting was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change @@ -78091,11 +78948,11 @@ compliance activities that can be filtered by various criteria. The Claude Code default worker pool setting was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change @@ -78107,11 +78964,11 @@ compliance activities that can be filtered by various criteria. The managed agents setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -78374,15 +79231,1718 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "owned_projects_access_restored"` + - `type: optional "owned_projects_access_restored"` + + default: owned_projects_access_restored + + - `user_id: optional string or null` + + - `PaymentMethodUpdated object` + + The organization's default payment method was updated. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "payment_method_updated"` + + default: payment_method_updated + + - `PendingShareCreated object` + + A pending share of a project or skill was created for an email address that is not yet an organization member. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `invitee_email: string` + + Email address the share was created for. + + - `resource_id: string` + + Tagged ID of the resource being shared. + + - `resource_type: string` + + The type of resource being shared. + + - `role: string` + + The role that will be granted when the invitee joins the organization. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "pending_share_created"` + + default: pending_share_created + + - `PendingShareRevoked object` + + A pending share of a project or skill was revoked before the invitee joined the organization. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `invitee_email: string` + + Email address the share had been created for. + + - `resource_id: string` + + Tagged ID of the resource that was shared. + + - `resource_type: string` + + The type of resource that was shared. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "pending_share_revoked"` + + default: pending_share_revoked + + - `PhoneCodeSent object` + + User requested a phone verification code. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "phone_code_sent"` + + default: phone_code_sent + + - `PhoneCodeVerified object` + + User successfully verified their phone code. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "phone_code_verified"` + + default: phone_code_verified + + - `PlatformAgentArchived object` + + An agent was archived on the API platform. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `agent_id: string` + + The agent that was archived, e.g. "agent_01HX...". + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "platform_agent_archived"` + + default: platform_agent_archived + + - `workspace_id: optional string or null` + + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentCreated object` + + An agent was created on the API platform. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `agent_id: string` + + The agent that was created, e.g. "agent_01HX...". + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "platform_agent_created"` - default: owned_projects_access_restored + default: platform_agent_created - - `user_id: optional string or null` + - `workspace_id: optional string or null` - - `PaymentMethodUpdated object` + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - The organization's default payment method was updated. + - `PlatformAgentDeleted object` + + An agent was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -78595,6 +81155,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `agent_id: string` + + The agent that was deleted, e.g. "agent_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -78613,13 +81177,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "payment_method_updated"` + - `type: optional "platform_agent_deleted"` - default: payment_method_updated + default: platform_agent_deleted - - `PendingShareCreated object` + - `workspace_id: optional string or null` - A pending share of a project or skill was created for an email address that is not yet an organization member. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeploymentArchived object` + + An agent deployment was archived on the API platform. - `actor: object or object or object or 8 more` @@ -78832,21 +81400,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` - - Email address the share was created for. - - - `resource_id: string` - - Tagged ID of the resource being shared. - - - `resource_type: string` - - The type of resource being shared. - - - `role: string` + - `deployment_id: string` - The role that will be granted when the invitee joins the organization. + The agent deployment that was archived, e.g. "depl_01HX...". - `id: optional string` @@ -78866,13 +81422,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "pending_share_created"` + - `type: optional "platform_agent_deployment_archived"` - default: pending_share_created + default: platform_agent_deployment_archived - - `PendingShareRevoked object` + - `workspace_id: optional string or null` - A pending share of a project or skill was revoked before the invitee joined the organization. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeploymentCreated object` + + An agent deployment was created on the API platform. - `actor: object or object or object or 8 more` @@ -79085,17 +81645,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` - - Email address the share had been created for. - - - `resource_id: string` - - Tagged ID of the resource that was shared. - - - `resource_type: string` + - `deployment_id: string` - The type of resource that was shared. + The agent deployment that was created, e.g. "depl_01HX...". - `id: optional string` @@ -79115,13 +81667,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "pending_share_revoked"` + - `type: optional "platform_agent_deployment_created"` - default: pending_share_revoked + default: platform_agent_deployment_created - - `PhoneCodeSent object` + - `workspace_id: optional string or null` - User requested a phone verification code. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeploymentDeleted object` + + An agent deployment was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -79334,6 +81890,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `deployment_id: string` + + The agent deployment that was deleted, e.g. "depl_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -79352,13 +81912,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "phone_code_sent"` + - `type: optional "platform_agent_deployment_deleted"` - default: phone_code_sent + default: platform_agent_deployment_deleted - - `PhoneCodeVerified object` + - `workspace_id: optional string or null` - User successfully verified their phone code. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeploymentPaused object` + + An agent deployment was paused on the API platform. - `actor: object or object or object or 8 more` @@ -79571,6 +82135,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `deployment_id: string` + + The agent deployment that was paused, e.g. "depl_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -79589,13 +82157,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "phone_code_verified"` + - `type: optional "platform_agent_deployment_paused"` - default: phone_code_verified + default: platform_agent_deployment_paused - - `PlatformAgentArchived object` + - `workspace_id: optional string or null` - An agent was archived on the API platform. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeploymentRunTriggered object` + + An agent deployment was run on demand on the API platform. - `actor: object or object or object or 8 more` @@ -79808,9 +82380,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was archived, e.g. "agent_01HX...". + The agent deployment that was run, e.g. "depl_01HX...". - `id: optional string` @@ -79830,17 +82402,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_archived"` + - `type: optional "platform_agent_deployment_run_triggered"` - default: platform_agent_archived + default: platform_agent_deployment_run_triggered - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentCreated object` + - `PlatformAgentDeploymentUnpaused object` - An agent was created on the API platform. + An agent deployment was resumed on the API platform. - `actor: object or object or object or 8 more` @@ -80053,9 +82625,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was created, e.g. "agent_01HX...". + The agent deployment that was resumed, e.g. "depl_01HX...". - `id: optional string` @@ -80075,17 +82647,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_created"` + - `type: optional "platform_agent_deployment_unpaused"` - default: platform_agent_created + default: platform_agent_deployment_unpaused - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeleted object` + - `PlatformAgentDeploymentUpdated object` - An agent was deleted from the API platform. + An agent deployment was updated on the API platform. - `actor: object or object or object or 8 more` @@ -80298,9 +82870,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was deleted, e.g. "agent_01HX...". + The agent deployment that was updated, e.g. "depl_01HX...". - `id: optional string` @@ -80320,17 +82892,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deleted"` + - `type: optional "platform_agent_deployment_updated"` - default: platform_agent_deleted + default: platform_agent_deployment_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentArchived object` + - `PlatformAgentSessionArchived object` - An agent deployment was archived on the API platform. + An agent session was archived on the API platform. - `actor: object or object or object or 8 more` @@ -80543,9 +83115,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was archived, e.g. "depl_01HX...". + The agent session that was archived, e.g. "session_01HX...". - `id: optional string` @@ -80565,17 +83137,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_archived"` + - `type: optional "platform_agent_session_archived"` - default: platform_agent_deployment_archived + default: platform_agent_session_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentCreated object` + - `PlatformAgentSessionCreated object` - An agent deployment was created on the API platform. + An agent session was created on the API platform. - `actor: object or object or object or 8 more` @@ -80788,9 +83360,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was created, e.g. "depl_01HX...". + The agent session that was created, e.g. "session_01HX...". - `id: optional string` @@ -80810,17 +83382,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_created"` + - `type: optional "platform_agent_session_created"` - default: platform_agent_deployment_created + default: platform_agent_session_created - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentDeleted object` + - `PlatformAgentSessionDeleted object` - An agent deployment was deleted from the API platform. + An agent session was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -81033,9 +83605,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was deleted, e.g. "depl_01HX...". + The agent session that was deleted, e.g. "session_01HX...". - `id: optional string` @@ -81055,17 +83627,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_deleted"` + - `type: optional "platform_agent_session_deleted"` - default: platform_agent_deployment_deleted + default: platform_agent_session_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentPaused object` + - `PlatformAgentSessionResourceAdded object` - An agent deployment was paused on the API platform. + A resource was attached to an agent session. - `actor: object or object or object or 8 more` @@ -81278,9 +83850,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `resource_id: string` - The agent deployment that was paused, e.g. "depl_01HX...". + The resource that was attached, e.g. "resource_01HX...". + + - `session_id: string` + + The agent session the resource was attached to, e.g. "session_01HX...". - `id: optional string` @@ -81300,17 +83876,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_paused"` + - `type: optional "platform_agent_session_resource_added"` - default: platform_agent_deployment_paused + default: platform_agent_session_resource_added - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentRunTriggered object` + - `PlatformAgentSessionResourceDeleted object` - An agent deployment was run on demand on the API platform. + A resource attached to an agent session was removed. - `actor: object or object or object or 8 more` @@ -81523,9 +84099,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `resource_id: string` - The agent deployment that was run, e.g. "depl_01HX...". + The resource that was removed, e.g. "resource_01HX...". + + - `session_id: string` + + The agent session the resource belonged to, e.g. "session_01HX...". - `id: optional string` @@ -81545,17 +84125,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_run_triggered"` + - `type: optional "platform_agent_session_resource_deleted"` - default: platform_agent_deployment_run_triggered + default: platform_agent_session_resource_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentUnpaused object` + - `PlatformAgentSessionResourceUpdated object` - An agent deployment was resumed on the API platform. + A resource attached to an agent session was updated. - `actor: object or object or object or 8 more` @@ -81768,9 +84348,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `resource_id: string` - The agent deployment that was resumed, e.g. "depl_01HX...". + The resource that was updated, e.g. "resource_01HX...". + + - `session_id: string` + + The agent session the resource belongs to, e.g. "session_01HX...". - `id: optional string` @@ -81790,17 +84374,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_unpaused"` + - `type: optional "platform_agent_session_resource_updated"` - default: platform_agent_deployment_unpaused + default: platform_agent_session_resource_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentUpdated object` + - `PlatformAgentSessionThreadArchived object` - An agent deployment was updated on the API platform. + A thread within an agent session was archived. - `actor: object or object or object or 8 more` @@ -82013,9 +84597,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was updated, e.g. "depl_01HX...". + The agent session the thread belongs to, e.g. "session_01HX...". + + - `thread_id: string` + + The thread that was archived, e.g. "thread_01HX...". - `id: optional string` @@ -82035,17 +84623,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_updated"` + - `type: optional "platform_agent_session_thread_archived"` - default: platform_agent_deployment_updated + default: platform_agent_session_thread_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionArchived object` + - `PlatformAgentSessionUpdated object` - An agent session was archived on the API platform. + An agent session was updated on the API platform. - `actor: object or object or object or 8 more` @@ -82260,7 +84848,7 @@ compliance activities that can be filtered by various criteria. - `session_id: string` - The agent session that was archived, e.g. "session_01HX...". + The agent session that was updated, e.g. "session_01HX...". - `id: optional string` @@ -82280,17 +84868,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_archived"` + - `type: optional "platform_agent_session_updated"` - default: platform_agent_session_archived + default: platform_agent_session_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionCreated object` + - `PlatformAgentUpdated object` - An agent session was created on the API platform. + An agent was updated on the API platform. - `actor: object or object or object or 8 more` @@ -82503,9 +85091,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `agent_id: string` - The agent session that was created, e.g. "session_01HX...". + The agent that was updated, e.g. "agent_01HX...". - `id: optional string` @@ -82525,17 +85113,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_created"` + - `type: optional "platform_agent_updated"` - default: platform_agent_session_created + default: platform_agent_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionDeleted object` + - `PlatformAPIKeyCreated object` - An agent session was deleted from the API platform. + An API key was created. - `actor: object or object or object or 8 more` @@ -82748,9 +85336,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `api_key_id: string` - The agent session that was deleted, e.g. "session_01HX...". + Tagged ID of the created API key - `id: optional string` @@ -82770,17 +85358,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_deleted"` - - default: platform_agent_session_deleted - - - `workspace_id: optional string or null` + - `type: optional "platform_api_key_created"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_api_key_created - - `PlatformAgentSessionResourceAdded object` + - `PlatformAPIKeyUpdated object` - A resource was attached to an agent session. + An API key was updated. - `actor: object or object or object or 8 more` @@ -82993,13 +85577,23 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` + - `api_key_id: string` - The resource that was attached, e.g. "resource_01HX...". + Tagged ID of the updated API key - - `session_id: string` + - `updates: array of object` - The agent session the resource was attached to, e.g. "session_01HX...". + - `current_value: string` + + - `previous_value: string` + + - `type: "name" or "status" or "workspace"` + + - `"name"` + + - `"status"` + + - `"workspace"` - `id: optional string` @@ -83019,17 +85613,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_added"` - - default: platform_agent_session_resource_added - - - `workspace_id: optional string or null` + - `type: optional "platform_api_key_updated"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_api_key_updated - - `PlatformAgentSessionResourceDeleted object` + - `PlatformAppAttestAuthentication object` - A resource attached to an agent session was removed. + An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials. - `actor: object or object or object or 8 more` @@ -83242,14 +85832,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` - - The resource that was removed, e.g. "resource_01HX...". - - - `session_id: string` - - The agent session the resource belonged to, e.g. "session_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -83260,6 +85842,22 @@ compliance activities that can be filtered by various criteria. format: date-time + - `event_data: optional object or null` + + A nested object within a compliance activity payload. + + - `external_client_id: optional string or null` + + The registered external client the device presented, e.g. "clid_01HXZ4J2N8K5P7R9T3V6W1Y4M0". + + - `kid_hash: optional string or null` + + A truncated hash of the device's attested key identifier. + + - `workspace_id: optional string or null` + + The tagged ID of the workspace the minted token is bound to. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -83268,17 +85866,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_deleted"` + - `request_id: optional string or null` - default: platform_agent_session_resource_deleted + The Anthropic API request identifier for correlation. - - `workspace_id: optional string or null` + - `status: optional object or null` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + A nested object within a compliance activity payload. - - `PlatformAgentSessionResourceUpdated object` + - `outcome: string` - A resource attached to an agent session was updated. + Whether the token exchange succeeded or was denied. + + - `reason: optional string or null` + + A short reason code when the exchange did not succeed. + + - `type: optional "platform_app_attest_authentication"` + + default: platform_app_attest_authentication + + - `PlatformBillingUpgradedToPrepaid object` + + The organization's API billing was upgraded to the prepaid plan. - `actor: object or object or object or 8 more` @@ -83491,13 +86101,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` - - The resource that was updated, e.g. "resource_01HX...". - - - `session_id: string` + - `previous_billing_type: string` - The agent session the resource belongs to, e.g. "session_01HX...". + The organization's billing type before this upgrade, for example "api_evaluation". - `id: optional string` @@ -83517,17 +86123,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_updated"` - - default: platform_agent_session_resource_updated - - - `workspace_id: optional string or null` + - `type: optional "platform_billing_upgraded_to_prepaid"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_billing_upgraded_to_prepaid - - `PlatformAgentSessionThreadArchived object` + - `PlatformClearanceWorkspaceProgramRequestCleared object` - A thread within an agent session was archived. + A workspace's clearance program assignment was removed. - `actor: object or object or object or 8 more` @@ -83740,13 +86342,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `program_slug: string` - The agent session the thread belongs to, e.g. "session_01HX...". + The clearance program's identifier - - `thread_id: string` + - `workspace_id: string` - The thread that was archived, e.g. "thread_01HX...". + Tagged ID of the workspace - `id: optional string` @@ -83766,17 +86368,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_thread_archived"` - - default: platform_agent_session_thread_archived - - - `workspace_id: optional string or null` + - `type: optional "platform_clearance_workspace_program_request_cleared"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_clearance_workspace_program_request_cleared - - `PlatformAgentSessionUpdated object` + - `PlatformClearanceWorkspaceProgramRequestSet object` - An agent session was updated on the API platform. + A workspace's clearance program assignment was created or updated. - `actor: object or object or object or 8 more` @@ -83989,9 +86587,23 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `opt_decision: "opt_in" or "opt_out" or "unspecified"` - The agent session that was updated, e.g. "session_01HX...". + Whether the workspace is opted in or out of the program + + - `"opt_in"` + + - `"opt_out"` + + - `"unspecified"` + + - `program_slug: string` + + The clearance program's identifier + + - `workspace_id: string` + + Tagged ID of the workspace - `id: optional string` @@ -84011,17 +86623,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_updated"` - - default: platform_agent_session_updated - - - `workspace_id: optional string or null` + - `type: optional "platform_clearance_workspace_program_request_set"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_clearance_workspace_program_request_set - - `PlatformAgentUpdated object` + - `PlatformCostReportViewed object` - An agent was updated on the API platform. + The cost report was viewed. - `actor: object or object or object or 8 more` @@ -84234,10 +86842,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was updated, e.g. "agent_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -84256,17 +86860,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_updated"` - - default: platform_agent_updated - - - `workspace_id: optional string or null` + - `type: optional "platform_cost_report_viewed"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_cost_report_viewed - - `PlatformAPIKeyCreated object` + - `PlatformDreamArchived object` - An API key was created. + A Dream (asynchronous memory-consolidation job) was archived. - `actor: object or object or object or 8 more` @@ -84479,9 +87079,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `api_key_id: string` + - `dream_id: string` - Tagged ID of the created API key + Tagged dream ID, e.g. "drm_01HX...". - `id: optional string` @@ -84501,13 +87101,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_api_key_created"` + - `type: optional "platform_dream_archived"` - default: platform_api_key_created + default: platform_dream_archived - - `PlatformAPIKeyUpdated object` + - `workspace_id: optional string or null` - An API key was updated. + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. + + - `PlatformDreamCancelled object` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. - `actor: object or object or object or 8 more` @@ -84720,23 +87324,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `api_key_id: string` + - `dream_id: string` - Tagged ID of the updated API key - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "name" or "status" or "workspace"` - - - `"name"` - - - `"status"` - - - `"workspace"` + Tagged dream ID, e.g. "drm_01HX...". - `id: optional string` @@ -84756,13 +87346,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_api_key_updated"` + - `type: optional "platform_dream_cancelled"` - default: platform_api_key_updated + default: platform_dream_cancelled - - `PlatformAppAttestAuthentication object` + - `workspace_id: optional string or null` - An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials. + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. + + - `PlatformDreamCreated object` + + A Dream (asynchronous memory-consolidation job) was created. - `actor: object or object or object or 8 more` @@ -84975,6 +87569,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `dream_id: string` + + Tagged dream ID, e.g. "drm_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -84985,22 +87583,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `event_data: optional object or null` - - A nested object within a compliance activity payload. - - - `external_client_id: optional string or null` - - The registered external client the device presented, e.g. "clid_01HXZ4J2N8K5P7R9T3V6W1Y4M0". - - - `kid_hash: optional string or null` - - A truncated hash of the device's attested key identifier. - - - `workspace_id: optional string or null` - - The tagged ID of the workspace the minted token is bound to. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -85009,29 +87591,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `request_id: optional string or null` - - The Anthropic API request identifier for correlation. - - - `status: optional object or null` - - A nested object within a compliance activity payload. - - - `outcome: string` - - Whether the token exchange succeeded or was denied. - - - `reason: optional string or null` + - `type: optional "platform_dream_created"` - A short reason code when the exchange did not succeed. + default: platform_dream_created - - `type: optional "platform_app_attest_authentication"` + - `workspace_id: optional string or null` - default: platform_app_attest_authentication + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. - - `PlatformBillingUpgradedToPrepaid object` + - `PlatformFederatedAuthentication object` - The organization's API billing was upgraded to the prepaid plan. + A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials. - `actor: object or object or object or 8 more` @@ -85244,10 +87814,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `previous_billing_type: string` - - The organization's billing type before this upgrade, for example "api_evaluation". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -85258,6 +87824,34 @@ compliance activities that can be filtered by various criteria. format: date-time + - `event_data: optional object or null` + + A nested object within a compliance activity payload. + + - `federation_rule_id: optional string or null` + + The federation rule that matched the request, e.g. "fdrl_01HXZ4J2N8K5P7R9T3V6W1Y4M0". + + - `issuer_id: optional string or null` + + The registered identity issuer for the request, e.g. "fdis_01HXZ4H5M3K8P1R7T9V2W6Y4N0". + + - `oidc_token: optional object or null` + + A nested object within a compliance activity payload. + + - `claims: optional map[unknown] or null` + + The verified claims from the presented OIDC token. + + - `jti: optional string or null` + + The presented token's unique identifier (its `jti` claim). + + - `requested_service_account_id: optional string or null` + + The service account the caller requested to authenticate as, e.g. "svac_01HXZ4...". + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -85266,13 +87860,45 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_billing_upgraded_to_prepaid"` + - `request_id: optional string or null` - default: platform_billing_upgraded_to_prepaid + The Anthropic API request identifier for correlation, e.g. "req_01HXZ4K7M9P2QR5T8V6W3Y1N0B". - - `PlatformClearanceWorkspaceProgramRequestCleared object` + - `resources: optional array of object` - A workspace's clearance program assignment was removed. + The resources involved in the exchange. + + - `id: string` + + The identifier of the resource involved in the exchange. + + - `type: string` + + The kind of resource involved in the exchange. + + - `status: optional object or null` + + A nested object within a compliance activity payload. + + - `outcome: string` + + Whether the token exchange succeeded or was denied. + + - `detail: optional string or null` + + A human-readable explanation when the exchange did not succeed. May contain values copied verbatim from the presented token's header (e.g. kid, alg) and error text; treat as caller-supplied free text. + + - `reason: optional string or null` + + A short reason code when the exchange did not succeed. + + - `type: optional "platform_federated_authentication"` + + default: platform_federated_authentication + + - `PlatformFederationIssuerArchived object` + + An OIDC federation issuer was archived. - `actor: object or object or object or 8 more` @@ -85485,13 +88111,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `program_slug: string` - - The clearance program's identifier - - - `workspace_id: string` + - `federation_issuer_id: string` - Tagged ID of the workspace + Tagged ID of the archived issuer - `id: optional string` @@ -85511,13 +88133,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_clearance_workspace_program_request_cleared"` + - `type: optional "platform_federation_issuer_archived"` - default: platform_clearance_workspace_program_request_cleared + default: platform_federation_issuer_archived - - `PlatformClearanceWorkspaceProgramRequestSet object` + - `PlatformFederationIssuerUpdated object` - A workspace's clearance program assignment was created or updated. + An OIDC federation issuer was updated. - `actor: object or object or object or 8 more` @@ -85730,23 +88352,37 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `opt_decision: "opt_in" or "opt_out" or "unspecified"` + - `federation_issuer_id: string` - Whether the workspace is opted in or out of the program + Tagged ID of the updated issuer - - `"opt_in"` + - `updates: array of object` - - `"opt_out"` + - `current_value: string` - - `"unspecified"` + - `previous_value: string` - - `program_slug: string` + - `type: "ca_cert_pem_sha256" or "check_jti" or "discovery_base" or 7 more` - The clearance program's identifier + - `"ca_cert_pem_sha256"` - - `workspace_id: string` + - `"check_jti"` - Tagged ID of the workspace + - `"discovery_base"` + + - `"issuer_url"` + + - `"jwks_keys_sha256"` + + - `"jwks_polling_disabled_at"` + + - `"jwks_source"` + + - `"jwks_url"` + + - `"max_jwt_lifetime_seconds"` + + - `"name"` - `id: optional string` @@ -85766,13 +88402,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_clearance_workspace_program_request_set"` + - `type: optional "platform_federation_issuer_updated"` - default: platform_clearance_workspace_program_request_set + default: platform_federation_issuer_updated - - `PlatformCostReportViewed object` + - `PlatformFederationRuleArchived object` - The cost report was viewed. + An OIDC federation rule was archived. - `actor: object or object or object or 8 more` @@ -85985,6 +88621,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `federation_rule_id: string` + + Tagged ID of the archived rule + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -86003,13 +88643,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_cost_report_viewed"` + - `type: optional "platform_federation_rule_archived"` - default: platform_cost_report_viewed + default: platform_federation_rule_archived - - `PlatformFederatedAuthentication object` + - `PlatformFederationRuleUpdated object` - A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials. + An OIDC federation rule was updated. - `actor: object or object or object or 8 more` @@ -86222,91 +88862,71 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `event_data: optional object or null` - - A nested object within a compliance activity payload. - - - `federation_rule_id: optional string or null` - - The federation rule that matched the request, e.g. "fdrl_01HXZ4J2N8K5P7R9T3V6W1Y4M0". - - - `issuer_id: optional string or null` - - The registered identity issuer for the request, e.g. "fdis_01HXZ4H5M3K8P1R7T9V2W6Y4N0". + - `federation_rule_id: string` - - `oidc_token: optional object or null` + Tagged ID of the updated rule - A nested object within a compliance activity payload. + - `updates: array of object` - - `claims: optional map[unknown] or null` + - `current_value: string` - The verified claims from the presented OIDC token. + - `previous_value: string` - - `jti: optional string or null` + - `type: "applies_to_all_workspaces" or "attributes" or "description" or 11 more` - The presented token's unique identifier (its `jti` claim). + - `"applies_to_all_workspaces"` - - `requested_service_account_id: optional string or null` + - `"attributes"` - The service account the caller requested to authenticate as, e.g. "svac_01HXZ4...". + - `"description"` - - `organization_id: optional string or null` + - `"match_audience"` - Organization ID this activity is associated with + - `"match_claims"` - - `organization_uuid: optional string or null` + - `"match_condition"` - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `"match_subject_prefix"` - - `request_id: optional string or null` + - `"name"` - The Anthropic API request identifier for correlation, e.g. "req_01HXZ4K7M9P2QR5T8V6W3Y1N0B". + - `"oauth_scope"` - - `resources: optional array of object` + - `"target_id"` - The resources involved in the exchange. + - `"target_lookup_attr"` - - `id: string` + - `"target_type"` - The identifier of the resource involved in the exchange. + - `"token_lifetime_seconds"` - - `type: string` + - `"workspace_id"` - The kind of resource involved in the exchange. + - `id: optional string` - - `status: optional object or null` + Unique identifier for the activity e.g. 'activity_abcd1234' - A nested object within a compliance activity payload. + - `created_at: optional string` - - `outcome: string` + When this activity occurred. - Whether the token exchange succeeded or was denied. + format: date-time - - `detail: optional string or null` + - `organization_id: optional string or null` - A human-readable explanation when the exchange did not succeed. May contain values copied verbatim from the presented token's header (e.g. kid, alg) and error text; treat as caller-supplied free text. + Organization ID this activity is associated with - - `reason: optional string or null` + - `organization_uuid: optional string or null` - A short reason code when the exchange did not succeed. + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_federated_authentication"` + - `type: optional "platform_federation_rule_updated"` - default: platform_federated_authentication + default: platform_federation_rule_updated - - `PlatformFederationIssuerArchived object` + - `PlatformFederationRuleWorkspaceAdded object` - An OIDC federation issuer was archived. + A federation rule was enabled for a workspace. - `actor: object or object or object or 8 more` @@ -86519,9 +89139,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `federation_issuer_id: string` + - `federation_rule_id: string` - Tagged ID of the archived issuer + Tagged ID of the federation rule + + - `workspace_id: string` + + Tagged ID of the workspace the rule was enabled for - `id: optional string` @@ -86541,13 +89165,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_federation_issuer_archived"` + - `type: optional "platform_federation_rule_workspace_added"` - default: platform_federation_issuer_archived + default: platform_federation_rule_workspace_added - - `PlatformFederationIssuerUpdated object` + - `PlatformFederationRuleWorkspaceRemoved object` - An OIDC federation issuer was updated. + A federation rule was disabled for a workspace. - `actor: object or object or object or 8 more` @@ -86760,37 +89384,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `federation_issuer_id: string` - - Tagged ID of the updated issuer - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "ca_cert_pem_sha256" or "check_jti" or "discovery_base" or 7 more` - - - `"ca_cert_pem_sha256"` - - - `"check_jti"` - - - `"discovery_base"` - - - `"issuer_url"` - - - `"jwks_keys_sha256"` - - - `"jwks_polling_disabled_at"` - - - `"jwks_source"` + - `federation_rule_id: string` - - `"jwks_url"` + Tagged ID of the federation rule - - `"max_jwt_lifetime_seconds"` + - `workspace_id: string` - - `"name"` + Tagged ID of the workspace the rule was disabled for - `id: optional string` @@ -86810,13 +89410,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_federation_issuer_updated"` + - `type: optional "platform_federation_rule_workspace_removed"` - default: platform_federation_issuer_updated + default: platform_federation_rule_workspace_removed - - `PlatformFederationRuleArchived object` + - `PlatformFileContentDownloaded object` - An OIDC federation rule was archived. + Activity logged when file content is downloaded via GET /v1/files/{file_id}/content. - `actor: object or object or object or 8 more` @@ -87029,9 +89629,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `federation_rule_id: string` + - `file_id: string` - Tagged ID of the archived rule + The tagged ID of the downloaded file - `id: optional string` @@ -87051,13 +89651,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_federation_rule_archived"` + - `type: optional "platform_file_content_downloaded"` - default: platform_federation_rule_archived + default: platform_file_content_downloaded - - `PlatformFederationRuleUpdated object` + - `PlatformFileDeleted object` - An OIDC federation rule was updated. + Activity logged when a file is deleted via DELETE /v1/files/{file_id}. - `actor: object or object or object or 8 more` @@ -87270,45 +89870,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `federation_rule_id: string` - - Tagged ID of the updated rule - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "applies_to_all_workspaces" or "attributes" or "description" or 11 more` - - - `"applies_to_all_workspaces"` - - - `"attributes"` - - - `"description"` - - - `"match_audience"` - - - `"match_claims"` - - - `"match_condition"` - - - `"match_subject_prefix"` - - - `"name"` - - - `"oauth_scope"` - - - `"target_id"` - - - `"target_lookup_attr"` - - - `"target_type"` - - - `"token_lifetime_seconds"` + - `file_id: string` - - `"workspace_id"` + The tagged ID of the deleted file - `id: optional string` @@ -87328,13 +89892,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_federation_rule_updated"` + - `type: optional "platform_file_deleted"` - default: platform_federation_rule_updated + default: platform_file_deleted - - `PlatformFederationRuleWorkspaceAdded object` + - `PlatformFileUploaded object` - A federation rule was enabled for a workspace. + Activity logged when a file is uploaded via POST /v1/files. - `actor: object or object or object or 8 more` @@ -87547,13 +90111,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `federation_rule_id: string` - - Tagged ID of the federation rule - - - `workspace_id: string` + - `file_id: string` - Tagged ID of the workspace the rule was enabled for + The tagged ID of the uploaded file - `id: optional string` @@ -87573,13 +90133,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_federation_rule_workspace_added"` + - `session_id: optional string or null` - default: platform_federation_rule_workspace_added + The tagged session ID (agent-api only) - - `PlatformFederationRuleWorkspaceRemoved object` + - `type: optional "platform_file_uploaded"` - A federation rule was disabled for a workspace. + default: platform_file_uploaded + + - `PlatformMemoryCreated object` + + An agent memory document was created. - `actor: object or object or object or 8 more` @@ -87792,13 +90356,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `federation_rule_id: string` + - `memory_id: string` - Tagged ID of the federation rule + Tagged memory ID, e.g. "mem_01HX...". - - `workspace_id: string` + - `memory_store_id: string` - Tagged ID of the workspace the rule was disabled for + Tagged ID of the memory store the memory belongs to, e.g. "memstore_01HX...". - `id: optional string` @@ -87810,6 +90374,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `memory_version_id: optional string or null` + + Tagged ID of the memory version produced by this change, e.g. "memver_01HX...". Links this event to the version history. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -87818,13 +90386,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_federation_rule_workspace_removed"` + - `type: optional "platform_memory_created"` - default: platform_federation_rule_workspace_removed + default: platform_memory_created - - `PlatformFileContentDownloaded object` + - `workspace_id: optional string or null` - Activity logged when file content is downloaded via GET /v1/files/{file_id}/content. + Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. + + - `PlatformMemoryDeleted object` + + An agent memory document was deleted. - `actor: object or object or object or 8 more` @@ -88037,9 +90609,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `file_id: string` + - `memory_id: string` - The tagged ID of the downloaded file + Tagged memory ID, e.g. "mem_01HX...". + + - `memory_store_id: string` + + Tagged ID of the memory store the memory belongs to, e.g. "memstore_01HX...". - `id: optional string` @@ -88051,6 +90627,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `memory_version_id: optional string or null` + + Tagged ID of the memory version produced by this change — the deletion tombstone, e.g. "memver_01HX...". Links this event to the version history. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -88059,13 +90639,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_file_content_downloaded"` + - `type: optional "platform_memory_deleted"` - default: platform_file_content_downloaded + default: platform_memory_deleted - - `PlatformFileDeleted object` + - `workspace_id: optional string or null` - Activity logged when a file is deleted via DELETE /v1/files/{file_id}. + Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. + + - `PlatformMemoryStoreArchived object` + + An agent memory store was archived. Archived stores reject new memory writes and cannot be attached to new sessions; deletion and redaction remain permitted for privacy scrubbing. - `actor: object or object or object or 8 more` @@ -88278,9 +90862,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `file_id: string` + - `memory_store_id: string` - The tagged ID of the deleted file + Tagged memory store ID, e.g. "memstore_01HX...". - `id: optional string` @@ -88300,13 +90884,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_file_deleted"` + - `type: optional "platform_memory_store_archived"` - default: platform_file_deleted + default: platform_memory_store_archived - - `PlatformFileUploaded object` + - `workspace_id: optional string or null` - Activity logged when a file is uploaded via POST /v1/files. + Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. + + - `PlatformMemoryStoreCreated object` + + An agent memory store was created. - `actor: object or object or object or 8 more` @@ -88519,9 +91107,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `file_id: string` + - `memory_store_id: string` - The tagged ID of the uploaded file + Tagged memory store ID, e.g. "memstore_01HX...". - `id: optional string` @@ -88541,17 +91129,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `session_id: optional string or null` + - `type: optional "platform_memory_store_created"` - The tagged session ID (agent-api only) + default: platform_memory_store_created - - `type: optional "platform_file_uploaded"` + - `workspace_id: optional string or null` - default: platform_file_uploaded + Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. - - `PlatformMemoryCreated object` + - `PlatformMemoryStoreDeleted object` - An agent memory document was created. + An agent memory store was deleted. Memory content removal may complete asynchronously for very large stores. - `actor: object or object or object or 8 more` @@ -88764,13 +91352,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `memory_id: string` - - Tagged memory ID, e.g. "mem_01HX...". - - `memory_store_id: string` - Tagged ID of the memory store the memory belongs to, e.g. "memstore_01HX...". + Tagged memory store ID, e.g. "memstore_01HX...". - `id: optional string` @@ -88782,10 +91366,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `memory_version_id: optional string or null` - - Tagged ID of the memory version produced by this change, e.g. "memver_01HX...". Links this event to the version history. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -88794,17 +91374,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_memory_created"` + - `type: optional "platform_memory_store_deleted"` - default: platform_memory_created + default: platform_memory_store_deleted - `workspace_id: optional string or null` Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. - - `PlatformMemoryDeleted object` + - `PlatformMemoryStoreUpdated object` - An agent memory document was deleted. + An agent memory store's name, description, or metadata was updated. - `actor: object or object or object or 8 more` @@ -89017,13 +91597,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `memory_id: string` - - Tagged memory ID, e.g. "mem_01HX...". - - `memory_store_id: string` - Tagged ID of the memory store the memory belongs to, e.g. "memstore_01HX...". + Tagged memory store ID, e.g. "memstore_01HX...". - `id: optional string` @@ -89035,10 +91611,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `memory_version_id: optional string or null` - - Tagged ID of the memory version produced by this change — the deletion tombstone, e.g. "memver_01HX...". Links this event to the version history. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -89047,17 +91619,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_memory_deleted"` + - `type: optional "platform_memory_store_updated"` - default: platform_memory_deleted + default: platform_memory_store_updated - `workspace_id: optional string or null` Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. - - `PlatformMemoryStoreArchived object` + - `PlatformMemoryUpdated object` - An agent memory store was archived. Archived stores reject new memory writes and cannot be attached to new sessions; deletion and redaction remain permitted for privacy scrubbing. + An agent memory document's content or path was updated. - `actor: object or object or object or 8 more` @@ -89270,9 +91842,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `memory_id: string` + + Tagged memory ID, e.g. "mem_01HX...". + - `memory_store_id: string` - Tagged memory store ID, e.g. "memstore_01HX...". + Tagged ID of the memory store the memory belongs to, e.g. "memstore_01HX...". - `id: optional string` @@ -89284,6 +91860,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `memory_version_id: optional string or null` + + Tagged ID of the memory version produced by this change, e.g. "memver_01HX...". Links this event to the version history. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -89292,17 +91872,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_memory_store_archived"` + - `type: optional "platform_memory_updated"` - default: platform_memory_store_archived + default: platform_memory_updated - `workspace_id: optional string or null` Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. - - `PlatformMemoryStoreCreated object` + - `PlatformMemoryVersionRedacted object` - An agent memory store was created. + A historical version of an agent memory document was redacted. Redaction scrubs the stored content of a specific version while preserving the version's existence in the history. - `actor: object or object or object or 8 more` @@ -89515,9 +92095,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `memory_id: string` + + Tagged ID of the memory the version belongs to, e.g. "mem_01HX...". + - `memory_store_id: string` - Tagged memory store ID, e.g. "memstore_01HX...". + Tagged ID of the memory store the memory belongs to, e.g. "memstore_01HX...". + + - `memory_version_id: string` + + Tagged memory version ID, e.g. "memver_01HX...". - `id: optional string` @@ -89537,17 +92125,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_memory_store_created"` + - `type: optional "platform_memory_version_redacted"` - default: platform_memory_store_created + default: platform_memory_version_redacted - `workspace_id: optional string or null` Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. - - `PlatformMemoryStoreDeleted object` + - `PlatformOAuthAppCreated object` - An agent memory store was deleted. Memory content removal may complete asynchronously for very large stores. + An OAuth app was created. - `actor: object or object or object or 8 more` @@ -89760,9 +92348,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `memory_store_id: string` + - `oauth_app_id: string` - Tagged memory store ID, e.g. "memstore_01HX...". + Tagged ID of the created app + + - `workspace_id: string` + + Tagged ID of the workspace the app is scoped to - `id: optional string` @@ -89782,17 +92374,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_memory_store_deleted"` - - default: platform_memory_store_deleted - - - `workspace_id: optional string or null` + - `type: optional "platform_oauth_app_created"` - Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. + default: platform_oauth_app_created - - `PlatformMemoryStoreUpdated object` + - `PlatformOAuthAppRevoked object` - An agent memory store's name, description, or metadata was updated. + An OAuth app was revoked. - `actor: object or object or object or 8 more` @@ -90005,9 +92593,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `memory_store_id: string` + - `oauth_app_id: string` - Tagged memory store ID, e.g. "memstore_01HX...". + Tagged ID of the revoked app - `id: optional string` @@ -90027,17 +92615,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_memory_store_updated"` - - default: platform_memory_store_updated - - - `workspace_id: optional string or null` + - `type: optional "platform_oauth_app_revoked"` - Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. + default: platform_oauth_app_revoked - - `PlatformMemoryUpdated object` + - `PlatformOAuthAppUpdated object` - An agent memory document's content or path was updated. + An OAuth app was updated. - `actor: object or object or object or 8 more` @@ -90250,13 +92834,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `memory_id: string` + - `oauth_app_id: string` - Tagged memory ID, e.g. "mem_01HX...". + Tagged ID of the updated app - - `memory_store_id: string` + - `updates: array of object` - Tagged ID of the memory store the memory belongs to, e.g. "memstore_01HX...". + - `current_value: string` + + - `previous_value: string` + + - `type: "apple_ios_attestation_environment" or "apple_ios_bundles" or "name" or "status"` + + - `"apple_ios_attestation_environment"` + + - `"apple_ios_bundles"` + + - `"name"` + + - `"status"` - `id: optional string` @@ -90268,10 +92864,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `memory_version_id: optional string or null` - - Tagged ID of the memory version produced by this change, e.g. "memver_01HX...". Links this event to the version history. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -90280,17 +92872,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_memory_updated"` - - default: platform_memory_updated - - - `workspace_id: optional string or null` + - `type: optional "platform_oauth_app_updated"` - Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. + default: platform_oauth_app_updated - - `PlatformMemoryVersionRedacted object` + - `PlatformPluginDirectorySubmissionCreated object` - A historical version of an agent memory document was redacted. Redaction scrubs the stored content of a specific version while preserving the version's existence in the history. + A plugin directory submission was created on the API platform. A plugin directory submission is a request to list a plugin in the public plugin directory. - `actor: object or object or object or 8 more` @@ -90503,17 +93091,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `memory_id: string` - - Tagged ID of the memory the version belongs to, e.g. "mem_01HX...". - - - `memory_store_id: string` + - `plugin_name: string` - Tagged ID of the memory store the memory belongs to, e.g. "memstore_01HX...". + The name of the plugin being submitted. - - `memory_version_id: string` + - `submission_id: string` - Tagged memory version ID, e.g. "memver_01HX...". + The submission that was created, e.g. "psub_01HX...". - `id: optional string` @@ -90533,17 +93117,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_memory_version_redacted"` - - default: platform_memory_version_redacted - - - `workspace_id: optional string or null` + - `type: optional "platform_plugin_directory_submission_created"` - Tagged ID of the workspace the request was scoped to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. May differ from the workspace the store was created in when the store is account-scoped. + default: platform_plugin_directory_submission_created - - `PlatformOAuthAppCreated object` + - `PlatformPluginDirectorySubmissionDeleted object` - An OAuth app was created. + A plugin directory submission was deleted on the API platform. - `actor: object or object or object or 8 more` @@ -90756,13 +93336,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `oauth_app_id: string` - - Tagged ID of the created app - - - `workspace_id: string` + - `submission_id: string` - Tagged ID of the workspace the app is scoped to + The submission that was deleted, e.g. "psub_01HX...". - `id: optional string` @@ -90782,13 +93358,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_oauth_app_created"` + - `type: optional "platform_plugin_directory_submission_deleted"` - default: platform_oauth_app_created + default: platform_plugin_directory_submission_deleted - - `PlatformOAuthAppRevoked object` + - `PlatformPluginDirectorySubmissionUpdated object` - An OAuth app was revoked. + A plugin directory submission was updated on the API platform. - `actor: object or object or object or 8 more` @@ -91001,9 +93577,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `oauth_app_id: string` + - `status: string` - Tagged ID of the revoked app + The submission's status after the update. + + - `submission_id: string` + + The submission that was updated, e.g. "psub_01HX...". - `id: optional string` @@ -91023,13 +93603,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_oauth_app_revoked"` + - `type: optional "platform_plugin_directory_submission_updated"` - default: platform_oauth_app_revoked + default: platform_plugin_directory_submission_updated - - `PlatformOAuthAppUpdated object` + - `PlatformServiceAccountArchived object` - An OAuth app was updated. + A service account was archived. - `actor: object or object or object or 8 more` @@ -91242,25 +93822,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `oauth_app_id: string` - - Tagged ID of the updated app - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "apple_ios_attestation_environment" or "apple_ios_bundles" or "name" or "status"` - - - `"apple_ios_attestation_environment"` - - - `"apple_ios_bundles"` - - - `"name"` + - `service_account_id: string` - - `"status"` + Tagged ID of the archived service account - `id: optional string` @@ -91280,13 +93844,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_oauth_app_updated"` + - `type: optional "platform_service_account_archived"` - default: platform_oauth_app_updated + default: platform_service_account_archived - - `PlatformPluginDirectorySubmissionCreated object` + - `PlatformServiceAccountUpdated object` - A plugin directory submission was created on the API platform. A plugin directory submission is a request to list a plugin in the public plugin directory. + A service account was updated. - `actor: object or object or object or 8 more` @@ -91499,13 +94063,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `plugin_name: string` + - `service_account_id: string` - The name of the plugin being submitted. + Tagged ID of the updated service account - - `submission_id: string` + - `updates: array of object` - The submission that was created, e.g. "psub_01HX...". + - `current_value: string` + + - `previous_value: string` + + - `type: "description" or "organization_role"` + + - `"description"` + + - `"organization_role"` - `id: optional string` @@ -91525,13 +94097,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_plugin_directory_submission_created"` + - `type: optional "platform_service_account_updated"` - default: platform_plugin_directory_submission_created + default: platform_service_account_updated - - `PlatformPluginDirectorySubmissionDeleted object` + - `PlatformServiceAccountWorkspaceMemberAdded object` - A plugin directory submission was deleted on the API platform. + A service account was added as a member of a workspace. - `actor: object or object or object or 8 more` @@ -91744,9 +94316,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `submission_id: string` + - `service_account_id: string` - The submission that was deleted, e.g. "psub_01HX...". + Tagged ID of the service account + + - `workspace_id: string` + + Tagged ID of the workspace - `id: optional string` @@ -91766,13 +94342,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_plugin_directory_submission_deleted"` + - `type: optional "platform_service_account_workspace_member_added"` - default: platform_plugin_directory_submission_deleted + default: platform_service_account_workspace_member_added - - `PlatformPluginDirectorySubmissionUpdated object` + - `PlatformServiceAccountWorkspaceMemberRemoved object` - A plugin directory submission was updated on the API platform. + A service account was removed from a workspace. - `actor: object or object or object or 8 more` @@ -91985,13 +94561,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `status: string` + - `service_account_id: string` - The submission's status after the update. + Tagged ID of the service account - - `submission_id: string` + - `workspace_id: string` - The submission that was updated, e.g. "psub_01HX...". + Tagged ID of the workspace - `id: optional string` @@ -92011,13 +94587,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_plugin_directory_submission_updated"` + - `type: optional "platform_service_account_workspace_member_removed"` - default: platform_plugin_directory_submission_updated + default: platform_service_account_workspace_member_removed - - `PlatformServiceAccountArchived object` + - `PlatformServiceAccountWorkspaceMemberUpdated object` - A service account was archived. + A service account's workspace membership role was updated. - `actor: object or object or object or 8 more` @@ -92232,7 +94808,19 @@ compliance activities that can be filtered by various criteria. - `service_account_id: string` - Tagged ID of the archived service account + Tagged ID of the service account + + - `updates: array of object` + + - `current_value: string` + + - `previous_value: string` + + - `type: "workspace_role"` + + - `workspace_id: string` + + Tagged ID of the workspace - `id: optional string` @@ -92252,13 +94840,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_service_account_archived"` + - `type: optional "platform_service_account_workspace_member_updated"` - default: platform_service_account_archived + default: platform_service_account_workspace_member_updated - - `PlatformServiceAccountUpdated object` + - `PlatformSigningKeyCreated object` - A service account was updated. + Activity logged when a new request-signing key is registered for the org. - `actor: object or object or object or 8 more` @@ -92471,21 +95059,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `service_account_id: string` + - `algorithm: string` - Tagged ID of the updated service account + The signing algorithm (e.g. ecdsa-p256-sha256) - - `updates: array of object` + - `key_backing_type: string` - - `current_value: string` + The backing type of the key (IN_MEMORY or CLOUD_KMS) - - `previous_value: string` + - `signing_key_id: string` - - `type: "description" or "organization_role"` + The tagged ID of the created signing key - - `"description"` + - `status: string` - - `"organization_role"` + The initial status of the key (ACTIVE or PENDING) - `id: optional string` @@ -92505,13 +95093,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_service_account_updated"` + - `type: optional "platform_signing_key_created"` - default: platform_service_account_updated + default: platform_signing_key_created - - `PlatformServiceAccountWorkspaceMemberAdded object` + - `PlatformSigningKeyDeleted object` - A service account was added as a member of a workspace. + Activity logged when a signing key is permanently deleted. - `actor: object or object or object or 8 more` @@ -92724,13 +95312,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `service_account_id: string` + - `algorithm: string` - Tagged ID of the service account + The algorithm of the deleted key - - `workspace_id: string` + - `key_backing_type: string` - Tagged ID of the workspace + The backing type of the deleted key (IN_MEMORY or CLOUD_KMS) + + - `key_name: string` + + The name of the deleted key + + - `signing_key_id: string` + + The tagged ID of the deleted signing key - `id: optional string` @@ -92750,13 +95346,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_service_account_workspace_member_added"` + - `type: optional "platform_signing_key_deleted"` - default: platform_service_account_workspace_member_added + default: platform_signing_key_deleted - - `PlatformServiceAccountWorkspaceMemberRemoved object` + - `PlatformSigningKeyRotated object` - A service account was removed from a workspace. + Activity logged when an in-memory signing key is rotated. - `actor: object or object or object or 8 more` @@ -92969,13 +95565,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `service_account_id: string` + - `algorithm: string` - Tagged ID of the service account + The algorithm of the new key - - `workspace_id: string` + - `key_group_identifier: string` - Tagged ID of the workspace + The key group identifier linking old and new keys + + - `new_signing_key_id: string` + + The tagged ID of the newly created key + + - `old_signing_key_id: string` + + The tagged ID of the expired old key - `id: optional string` @@ -92995,13 +95599,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_service_account_workspace_member_removed"` + - `type: optional "platform_signing_key_rotated"` - default: platform_service_account_workspace_member_removed + default: platform_signing_key_rotated - - `PlatformServiceAccountWorkspaceMemberUpdated object` + - `PlatformSkillVersionCreated object` - A service account's workspace membership role was updated. + Activity logged when a skill version is created via POST /v1/skills/{skill_id}/versions. - `actor: object or object or object or 8 more` @@ -93214,21 +95818,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `service_account_id: string` - - Tagged ID of the service account - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` + - `skill_id: string` - - `type: "workspace_role"` + The tagged ID of the skill - - `workspace_id: string` + - `version: string` - Tagged ID of the workspace + The version number of the created version - `id: optional string` @@ -93248,13 +95844,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_service_account_workspace_member_updated"` + - `type: optional "platform_skill_version_created"` - default: platform_service_account_workspace_member_updated + default: platform_skill_version_created - - `PlatformSigningKeyCreated object` + - `PlatformSkillVersionDeleted object` - Activity logged when a new request-signing key is registered for the org. + Activity logged when a skill version is deleted via DELETE /v1/skills/{skill_id}/versions/{version}. - `actor: object or object or object or 8 more` @@ -93467,21 +96063,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `algorithm: string` - - The signing algorithm (e.g. ecdsa-p256-sha256) - - - `key_backing_type: string` - - The backing type of the key (IN_MEMORY or CLOUD_KMS) - - - `signing_key_id: string` + - `skill_id: string` - The tagged ID of the created signing key + The tagged ID of the skill - - `status: string` + - `version: string` - The initial status of the key (ACTIVE or PENDING) + The version number of the deleted version - `id: optional string` @@ -93501,13 +96089,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_signing_key_created"` + - `type: optional "platform_skill_version_deleted"` - default: platform_signing_key_created + default: platform_skill_version_deleted - - `PlatformSigningKeyDeleted object` + - `PlatformSpendLimitAlertEmailsUpdated object` - Activity logged when a signing key is permanently deleted. + Spend limit alert email addresses and role targets were updated for an org. - `actor: object or object or object or 8 more` @@ -93720,25 +96308,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `algorithm: string` - - The algorithm of the deleted key - - - `key_backing_type: string` - - The backing type of the deleted key (IN_MEMORY or CLOUD_KMS) - - - `key_name: string` + - `id: optional string` - The name of the deleted key + Unique identifier for the activity e.g. 'activity_abcd1234' - - `signing_key_id: string` + - `alert_emails: optional array of string or null` - The tagged ID of the deleted signing key + Updated list of alert email addresses. - - `id: optional string` + - `alerted_roles: optional array of string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + Updated list of alerted roles. - `created_at: optional string` @@ -93754,13 +96334,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_signing_key_deleted"` + - `type: optional "platform_spend_limit_alert_emails_updated"` - default: platform_signing_key_deleted + default: platform_spend_limit_alert_emails_updated - - `PlatformSigningKeyRotated object` + - `PlatformSpendLimitCreated object` - Activity logged when an in-memory signing key is rotated. + An org-level fixed-dollar spend limit was created. - `actor: object or object or object or 8 more` @@ -93973,22 +96553,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `algorithm: string` - - The algorithm of the new key - - - `key_group_identifier: string` - - The key group identifier linking old and new keys - - - `new_signing_key_id: string` - - The tagged ID of the newly created key - - - `old_signing_key_id: string` - - The tagged ID of the expired old key - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -93999,6 +96563,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `limit_action: optional string or null` + + The action taken when the limit is reached (notify_only or notify_and_pause). + + - `limit_usd: optional number or null` + + The spend limit threshold in USD cents. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -94007,13 +96579,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_signing_key_rotated"` + - `type: optional "platform_spend_limit_created"` - default: platform_signing_key_rotated + default: platform_spend_limit_created - - `PlatformSkillVersionCreated object` + - `PlatformSpendLimitDeleted object` - Activity logged when a skill version is created via POST /v1/skills/{skill_id}/versions. + An org-level spend limit was removed. - `actor: object or object or object or 8 more` @@ -94226,14 +96798,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `skill_id: string` - - The tagged ID of the skill - - - `version: string` - - The version number of the created version - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -94252,13 +96816,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_skill_version_created"` + - `spend_limit_id: optional string or null` - default: platform_skill_version_created + UUID of the deleted spend limit. - - `PlatformSkillVersionDeleted object` + - `type: optional "platform_spend_limit_deleted"` - Activity logged when a skill version is deleted via DELETE /v1/skills/{skill_id}/versions/{version}. + default: platform_spend_limit_deleted + + - `PlatformSpendLimitUpdated object` + + An org-level spend limit snooze/ignore state was changed. - `actor: object or object or object or 8 more` @@ -94471,14 +97039,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `skill_id: string` - - The tagged ID of the skill - - - `version: string` - - The version number of the deleted version - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -94489,6 +97049,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `ignore: optional boolean or null` + + Whether the limit is being snoozed (ignored). + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -94497,13 +97061,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_skill_version_deleted"` + - `spend_limit_id: optional string or null` - default: platform_skill_version_deleted + UUID of the spend limit. - - `PlatformSpendLimitAlertEmailsUpdated object` + - `type: optional "platform_spend_limit_updated"` - Spend limit alert email addresses and role targets were updated for an org. + default: platform_spend_limit_updated + + - `PlatformUsageReportClaudeCodeViewed object` + + The Claude Code usage report was viewed. - `actor: object or object or object or 8 more` @@ -94720,14 +97288,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `alert_emails: optional array of string or null` - - Updated list of alert email addresses. - - - `alerted_roles: optional array of string or null` - - Updated list of alerted roles. - - `created_at: optional string` When this activity occurred. @@ -94742,13 +97302,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_spend_limit_alert_emails_updated"` + - `type: optional "platform_usage_report_claude_code_viewed"` - default: platform_spend_limit_alert_emails_updated + default: platform_usage_report_claude_code_viewed - - `PlatformSpendLimitCreated object` + - `PlatformUsageReportMessagesViewed object` - An org-level fixed-dollar spend limit was created. + The messages usage report was viewed. - `actor: object or object or object or 8 more` @@ -94971,14 +97531,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `limit_action: optional string or null` - - The action taken when the limit is reached (notify_only or notify_and_pause). - - - `limit_usd: optional number or null` - - The spend limit threshold in USD cents. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -94987,13 +97539,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_spend_limit_created"` + - `type: optional "platform_usage_report_messages_viewed"` - default: platform_spend_limit_created + default: platform_usage_report_messages_viewed - - `PlatformSpendLimitDeleted object` + - `PlatformWorkspaceArchived object` - An org-level spend limit was removed. + A workspace was archived. - `actor: object or object or object or 8 more` @@ -95206,6 +97758,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `workspace_id: string` + + Tagged ID of the archived workspace + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -95224,17 +97780,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - UUID of the deleted spend limit. - - - `type: optional "platform_spend_limit_deleted"` + - `type: optional "platform_workspace_archived"` - default: platform_spend_limit_deleted + default: platform_workspace_archived - - `PlatformSpendLimitUpdated object` + - `PlatformWorkspaceCreated object` - An org-level spend limit snooze/ignore state was changed. + A workspace was created. - `actor: object or object or object or 8 more` @@ -95447,6 +97999,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `workspace_id: string` + + Tagged ID of the created workspace + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -95457,10 +98013,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `ignore: optional boolean or null` - - Whether the limit is being snoozed (ignored). - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -95469,17 +98021,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - UUID of the spend limit. - - - `type: optional "platform_spend_limit_updated"` + - `type: optional "platform_workspace_created"` - default: platform_spend_limit_updated + default: platform_workspace_created - - `PlatformUsageReportClaudeCodeViewed object` + - `PlatformWorkspaceInferenceDataRetentionDisabled object` - The Claude Code usage report was viewed. + The zero data retention override was disabled for a workspace. - `actor: object or object or object or 8 more` @@ -95692,6 +98240,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `workspace_id: string` + + Tagged ID of the workspace + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -95710,13 +98262,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_usage_report_claude_code_viewed"` + - `previous_value: optional boolean or null` - default: platform_usage_report_claude_code_viewed + Override state immediately before this change - - `PlatformUsageReportMessagesViewed object` + - `type: optional "platform_workspace_inference_data_retention_disabled"` - The messages usage report was viewed. + default: platform_workspace_inference_data_retention_disabled + + - `PlatformWorkspaceInferenceDataRetentionEnabled object` + + The zero data retention override was enabled for a workspace. - `actor: object or object or object or 8 more` @@ -95929,6 +98485,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `workspace_id: string` + + Tagged ID of the workspace + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -95947,13 +98507,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_usage_report_messages_viewed"` + - `previous_value: optional boolean or null` - default: platform_usage_report_messages_viewed + Override state immediately before this change - - `PlatformWorkspaceArchived object` + - `type: optional "platform_workspace_inference_data_retention_enabled"` - A workspace was archived. + default: platform_workspace_inference_data_retention_enabled + + - `PlatformWorkspaceMemberAdded object` + + A member was added to a workspace. - `actor: object or object or object or 8 more` @@ -96166,9 +98730,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + + Tagged ID of the added member + - `workspace_id: string` - Tagged ID of the archived workspace + Tagged ID of the workspace - `id: optional string` @@ -96188,13 +98756,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_archived"` + - `type: optional "platform_workspace_member_added"` - default: platform_workspace_archived + default: platform_workspace_member_added - - `PlatformWorkspaceCreated object` + - `PlatformWorkspaceMemberRemoved object` - A workspace was created. + A member was removed from a workspace. - `actor: object or object or object or 8 more` @@ -96407,9 +98975,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + + Tagged ID of the removed member + - `workspace_id: string` - Tagged ID of the created workspace + Tagged ID of the workspace - `id: optional string` @@ -96429,13 +99001,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_created"` + - `type: optional "platform_workspace_member_removed"` - default: platform_workspace_created + default: platform_workspace_member_removed - - `PlatformWorkspaceInferenceDataRetentionDisabled object` + - `PlatformWorkspaceMemberUpdated object` - The zero data retention override was disabled for a workspace. + A workspace member was updated. - `actor: object or object or object or 8 more` @@ -96648,6 +99220,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `updates: array of object` + + - `current_value: string` + + - `previous_value: string` + + - `type: "workspace_role"` + + - `user_id: string` + + Tagged ID of the updated member + - `workspace_id: string` Tagged ID of the workspace @@ -96670,17 +99254,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Override state immediately before this change - - - `type: optional "platform_workspace_inference_data_retention_disabled"` + - `type: optional "platform_workspace_member_updated"` - default: platform_workspace_inference_data_retention_disabled + default: platform_workspace_member_updated - - `PlatformWorkspaceInferenceDataRetentionEnabled object` + - `PlatformWorkspaceMemberViewed object` - The zero data retention override was enabled for a workspace. + A workspace member was viewed. - `actor: object or object or object or 8 more` @@ -96893,6 +99473,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + + Tagged ID of the viewed member + - `workspace_id: string` Tagged ID of the workspace @@ -96915,17 +99499,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Override state immediately before this change - - - `type: optional "platform_workspace_inference_data_retention_enabled"` + - `type: optional "platform_workspace_member_viewed"` - default: platform_workspace_inference_data_retention_enabled + default: platform_workspace_member_viewed - - `PlatformWorkspaceMemberAdded object` + - `PlatformWorkspaceMembersListed object` - A member was added to a workspace. + Workspace members were listed. - `actor: object or object or object or 8 more` @@ -97138,10 +99718,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` - - Tagged ID of the added member - - `workspace_id: string` Tagged ID of the workspace @@ -97164,13 +99740,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_member_added"` + - `type: optional "platform_workspace_members_listed"` - default: platform_workspace_member_added + default: platform_workspace_members_listed - - `PlatformWorkspaceMemberRemoved object` + - `PlatformWorkspaceRateLimitDeleted object` - A member was removed from a workspace. + A workspace rate limit was deleted. - `actor: object or object or object or 8 more` @@ -97383,9 +99959,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` + - `limiter_type: string` - Tagged ID of the removed member + Type of rate limiter + + - `model_group: string` + + Model group the rate limit applied to - `workspace_id: string` @@ -97409,13 +99989,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_member_removed"` + - `type: optional "platform_workspace_rate_limit_deleted"` - default: platform_workspace_member_removed + default: platform_workspace_rate_limit_deleted - - `PlatformWorkspaceMemberUpdated object` + - `PlatformWorkspaceRateLimitUpdated object` - A workspace member was updated. + A workspace rate limit was created or updated. - `actor: object or object or object or 8 more` @@ -97628,17 +100208,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `updates: array of object` + - `limiter_type: string` - - `current_value: string` + Type of rate limiter - - `previous_value: string` + - `model_group: string` - - `type: "workspace_role"` + Model group the rate limit applies to - - `user_id: string` + - `value: number` - Tagged ID of the updated member + New rate limit value - `workspace_id: string` @@ -97662,13 +100242,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_member_updated"` + - `type: optional "platform_workspace_rate_limit_updated"` - default: platform_workspace_member_updated + default: platform_workspace_rate_limit_updated - - `PlatformWorkspaceMemberViewed object` + - `PlatformWorkspaceUpdated object` - A workspace member was viewed. + A workspace was updated. - `actor: object or object or object or 8 more` @@ -97881,13 +100461,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` - - Tagged ID of the viewed member - - `workspace_id: string` - Tagged ID of the workspace + Tagged ID of the updated workspace - `id: optional string` @@ -97907,13 +100483,43 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_member_viewed"` + - `type: optional "platform_workspace_updated"` - default: platform_workspace_member_viewed + default: platform_workspace_updated - - `PlatformWorkspaceMembersListed object` + - `updates: optional array of object` - Workspace members were listed. + The field-level changes applied in this update + + - `current_value: string` + + Field value immediately after this change + + - `previous_value: string` + + Field value immediately before this change + + - `type: "allowed_inference_geos" or "default_inference_geo" or "display_color" or 4 more` + + The workspace field that changed + + - `"allowed_inference_geos"` + + - `"default_inference_geo"` + + - `"display_color"` + + - `"external_key_config_id"` + + - `"inference_data_retention"` + + - `"name"` + + - `"unspecified"` + + - `ClaudePluginCreated object` + + Plugin was created. - `actor: object or object or object or 8 more` @@ -98126,10 +100732,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `workspace_id: string` - - Tagged ID of the workspace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -98148,13 +100750,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_members_listed"` + - `plugin_id: optional string or null` - default: platform_workspace_members_listed + - `plugin_name: optional string or null` - - `PlatformWorkspaceRateLimitDeleted object` + - `type: optional "claude_plugin_created"` - A workspace rate limit was deleted. + default: claude_plugin_created + + - `ClaudePluginDeleted object` + + Plugin was deleted. - `actor: object or object or object or 8 more` @@ -98367,18 +100973,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `limiter_type: string` - - Type of rate limiter - - - `model_group: string` - - Model group the rate limit applied to - - - `workspace_id: string` - - Tagged ID of the workspace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -98397,13 +100991,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_rate_limit_deleted"` + - `plugin_id: optional string or null` - default: platform_workspace_rate_limit_deleted + - `plugin_name: optional string or null` - - `PlatformWorkspaceRateLimitUpdated object` + - `type: optional "claude_plugin_deleted"` - A workspace rate limit was created or updated. + default: claude_plugin_deleted + + - `ClaudePluginDisabled object` + + User disabled a plugin for their account. - `actor: object or object or object or 8 more` @@ -98616,22 +101214,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `limiter_type: string` - - Type of rate limiter - - - `model_group: string` - - Model group the rate limit applies to - - - `value: number` - - New rate limit value - - - `workspace_id: string` - - Tagged ID of the workspace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -98642,6 +101224,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `marketplace_id: optional string or null` + + Identifier of the marketplace the plugin was installed from. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -98650,13 +101236,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_rate_limit_updated"` + - `plugin_id: optional string or null` - default: platform_workspace_rate_limit_updated + Identifier of the plugin that was disabled. - - `PlatformWorkspaceUpdated object` + - `plugin_name: optional string or null` - A workspace was updated. + Name of the plugin that was disabled. + + - `type: optional "claude_plugin_disabled"` + + default: claude_plugin_disabled + + - `ClaudePluginEnabled object` + + User enabled a plugin for their account. - `actor: object or object or object or 8 more` @@ -98869,10 +101463,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `workspace_id: string` - - Tagged ID of the updated workspace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -98883,6 +101473,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `marketplace_id: optional string or null` + + Identifier of the marketplace the plugin was installed from. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -98891,43 +101485,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_workspace_updated"` - - default: platform_workspace_updated - - - `updates: optional array of object` - - The field-level changes applied in this update - - - `current_value: string` - - Field value immediately after this change - - - `previous_value: string` - - Field value immediately before this change - - - `type: "allowed_inference_geos" or "default_inference_geo" or "display_color" or 4 more` - - The workspace field that changed - - - `"allowed_inference_geos"` - - - `"default_inference_geo"` + - `plugin_id: optional string or null` - - `"display_color"` + Identifier of the plugin that was enabled. - - `"external_key_config_id"` + - `plugin_name: optional string or null` - - `"inference_data_retention"` + Name of the plugin that was enabled. - - `"name"` + - `type: optional "claude_plugin_enabled"` - - `"unspecified"` + default: claude_plugin_enabled - - `ClaudePluginCreated object` + - `PluginInstallationPreferenceUpdated object` - Plugin was created. + An org admin changed the installation preference for a plugin. - `actor: object or object or object or 8 more` @@ -99140,16 +101712,40 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `marketplace_id: string` + + Marketplace ID + + - `plugin_name: string` + + Plugin name + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `action: optional string or null` + + Action taken (e.g. 'deleted' for clearing an override) + - `created_at: optional string` When this activity occurred. format: date-time + - `group_id: optional string or null` + + Tagged group ID for group-level overrides (null for org-level) + + - `group_name: optional string or null` + + Group name for group-level overrides + + - `installation_preference: optional string or null` + + New installation preference value (set only when action is an update; null for delete actions) + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -99158,17 +101754,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plugin_id: optional string or null` - - - `plugin_name: optional string or null` - - - `type: optional "claude_plugin_created"` + - `type: optional "plugin_installation_preference_updated"` - default: claude_plugin_created + default: plugin_installation_preference_updated - - `ClaudePluginDeleted object` + - `ClaudePluginReplaced object` - Plugin was deleted. + Plugin was replaced. - `actor: object or object or object or 8 more` @@ -99403,13 +101995,13 @@ compliance activities that can be filtered by various criteria. - `plugin_name: optional string or null` - - `type: optional "claude_plugin_deleted"` + - `type: optional "claude_plugin_replaced"` - default: claude_plugin_deleted + default: claude_plugin_replaced - - `ClaudePluginDisabled object` + - `ClaudePluginUpdated object` - User disabled a plugin for their account. + Plugin was updated. - `actor: object or object or object or 8 more` @@ -99632,10 +102224,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `marketplace_id: optional string or null` - - Identifier of the marketplace the plugin was installed from. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -99646,19 +102234,15 @@ compliance activities that can be filtered by various criteria. - `plugin_id: optional string or null` - Identifier of the plugin that was disabled. - - `plugin_name: optional string or null` - Name of the plugin that was disabled. - - - `type: optional "claude_plugin_disabled"` + - `type: optional "claude_plugin_updated"` - default: claude_plugin_disabled + default: claude_plugin_updated - - `ClaudePluginEnabled object` + - `PrepaidAutoRechargeDisabled object` - User enabled a plugin for their account. + Auto-recharge was disabled for API prepaid org. - `actor: object or object or object or 8 more` @@ -99881,10 +102465,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `marketplace_id: optional string or null` - - Identifier of the marketplace the plugin was installed from. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -99893,21 +102473,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plugin_id: optional string or null` - - Identifier of the plugin that was enabled. - - - `plugin_name: optional string or null` - - Name of the plugin that was enabled. - - - `type: optional "claude_plugin_enabled"` + - `type: optional "prepaid_auto_recharge_disabled"` - default: claude_plugin_enabled + default: prepaid_auto_recharge_disabled - - `PluginInstallationPreferenceUpdated object` + - `PrepaidAutoRechargeUpdated object` - An org admin changed the installation preference for a plugin. + Auto-recharge settings were updated for API prepaid org. - `actor: object or object or object or 8 more` @@ -100120,40 +102692,16 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Marketplace ID - - - `plugin_name: string` - - Plugin name - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `action: optional string or null` - - Action taken (e.g. 'deleted' for clearing an override) - - `created_at: optional string` When this activity occurred. format: date-time - - `group_id: optional string or null` - - Tagged group ID for group-level overrides (null for org-level) - - - `group_name: optional string or null` - - Group name for group-level overrides - - - `installation_preference: optional string or null` - - New installation preference value (set only when action is an update; null for delete actions) - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -100162,13 +102710,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "plugin_installation_preference_updated"` + - `target_amount: optional number or null` - default: plugin_installation_preference_updated + Target recharge amount in minor units. - - `ClaudePluginReplaced object` + - `threshold_amount: optional number or null` - Plugin was replaced. + Threshold amount to trigger recharge in minor units. + + - `type: optional "prepaid_auto_recharge_updated"` + + default: prepaid_auto_recharge_updated + + - `PrepaidExtraUsageAutoReloadDisabled object` + + Prepaid usage credit auto-reload was disabled. - `actor: object or object or object or 8 more` @@ -100399,17 +102955,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plugin_id: optional string or null` - - - `plugin_name: optional string or null` - - - `type: optional "claude_plugin_replaced"` + - `type: optional "prepaid_extra_usage_auto_reload_disabled"` - default: claude_plugin_replaced + default: prepaid_extra_usage_auto_reload_disabled - - `ClaudePluginUpdated object` + - `PrepaidExtraUsageAutoReloadEnabled object` - Plugin was updated. + Prepaid usage credit auto-reload was enabled. - `actor: object or object or object or 8 more` @@ -100640,17 +103192,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plugin_id: optional string or null` - - - `plugin_name: optional string or null` - - - `type: optional "claude_plugin_updated"` + - `type: optional "prepaid_extra_usage_auto_reload_enabled"` - default: claude_plugin_updated + default: prepaid_extra_usage_auto_reload_enabled - - `PrepaidAutoRechargeDisabled object` + - `PrepaidExtraUsageAutoReloadSettingsUpdated object` - Auto-recharge was disabled for API prepaid org. + Prepaid usage credit auto-reload settings were updated. - `actor: object or object or object or 8 more` @@ -100881,13 +103429,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "prepaid_auto_recharge_disabled"` + - `type: optional "prepaid_extra_usage_auto_reload_settings_updated"` - default: prepaid_auto_recharge_disabled + default: prepaid_extra_usage_auto_reload_settings_updated - - `PrepaidAutoRechargeUpdated object` + - `PrimaryOwnerTransferred object` - Auto-recharge settings were updated for API prepaid org. + Primary owner role was transferred to another org member. - `actor: object or object or object or 8 more` @@ -101100,6 +103648,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `new_owner_id: string` + + - `previous_owner_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -101118,21 +103670,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `target_amount: optional number or null` - - Target recharge amount in minor units. - - - `threshold_amount: optional number or null` - - Threshold amount to trigger recharge in minor units. - - - `type: optional "prepaid_auto_recharge_updated"` + - `type: optional "primary_owner_transferred"` - default: prepaid_auto_recharge_updated + default: primary_owner_transferred - - `PrepaidExtraUsageAutoReloadDisabled object` + - `ClaudeProjectArchived object` - Prepaid usage credit auto-reload was disabled. + A Claude project was archived. - `actor: object or object or object or 8 more` @@ -101345,6 +103889,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_project_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -101363,13 +103909,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "prepaid_extra_usage_auto_reload_disabled"` + - `type: optional "claude_project_archived"` - default: prepaid_extra_usage_auto_reload_disabled + default: claude_project_archived - - `PrepaidExtraUsageAutoReloadEnabled object` + - `ClaudeProjectCreated object` - Prepaid usage credit auto-reload was enabled. + A Claude project was created. - `actor: object or object or object or 8 more` @@ -101582,6 +104128,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_project_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -101600,13 +104148,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "prepaid_extra_usage_auto_reload_enabled"` + - `type: optional "claude_project_created"` - default: prepaid_extra_usage_auto_reload_enabled + default: claude_project_created - - `PrepaidExtraUsageAutoReloadSettingsUpdated object` + - `ClaudeProjectDeleted object` - Prepaid usage credit auto-reload settings were updated. + A Claude project was deleted. - `actor: object or object or object or 8 more` @@ -101819,6 +104367,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_project_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -101837,13 +104387,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "prepaid_extra_usage_auto_reload_settings_updated"` + - `type: optional "claude_project_deleted"` - default: prepaid_extra_usage_auto_reload_settings_updated + default: claude_project_deleted - - `PrimaryOwnerTransferred object` + - `ClaudeProjectDocumentAccessFailed object` - Primary owner role was transferred to another org member. + An attempt to access a document in a Claude project failed. - `actor: object or object or object or 8 more` @@ -102056,9 +104606,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `new_owner_id: string` + - `claude_project_document_id: string or null` - - `previous_owner_id: string` + - `claude_project_id: string` + + - `filename: string or null` - `id: optional string` @@ -102078,13 +104630,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "primary_owner_transferred"` + - `type: optional "claude_project_document_access_failed"` - default: primary_owner_transferred + default: claude_project_document_access_failed - - `ClaudeProjectArchived object` + - `ClaudeProjectDocumentBulkDeletionAuditTruncated object` - A Claude project was archived. + A bulk request to delete documents from a Claude project failed with more documents requested than were individually recorded in the audit log. - `actor: object or object or object or 8 more` @@ -102297,8 +104849,16 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `audited_count: number` + + Number of documents that received an individual audit record. + - `claude_project_id: string` + - `requested_count: number` + + Total number of documents the request asked to delete. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -102317,13 +104877,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_archived"` + - `type: optional "claude_project_document_bulk_deletion_audit_truncated"` - default: claude_project_archived + default: claude_project_document_bulk_deletion_audit_truncated - - `ClaudeProjectCreated object` + - `ClaudeProjectDocumentDeleted object` - A Claude project was created. + A document was deleted from a Claude project. - `actor: object or object or object or 8 more` @@ -102536,8 +105096,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_project_document_id: string` + - `claude_project_id: string` + - `filename: string or null` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -102556,13 +105120,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_created"` + - `type: optional "claude_project_document_deleted"` - default: claude_project_created + default: claude_project_document_deleted - - `ClaudeProjectDeleted object` + - `ClaudeProjectDocumentDeletionFailed object` - A Claude project was deleted. + A request to delete a document from a Claude project failed. - `actor: object or object or object or 8 more` @@ -102775,8 +105339,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_project_document_id: string or null` + - `claude_project_id: string` + - `filename: string or null` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -102795,13 +105363,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_deleted"` + - `type: optional "claude_project_document_deletion_failed"` - default: claude_project_deleted + default: claude_project_document_deletion_failed - - `ClaudeProjectDocumentAccessFailed object` + - `ClaudeProjectDocumentUpdated object` - An attempt to access a document in a Claude project failed. + The content of a document in a Claude project was replaced in place. - `actor: object or object or object or 8 more` @@ -103014,7 +105582,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_document_id: string or null` + - `claude_project_document_id: string` - `claude_project_id: string` @@ -103038,13 +105606,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_document_access_failed"` + - `type: optional "claude_project_document_updated"` - default: claude_project_document_access_failed + default: claude_project_document_updated - - `ClaudeProjectDocumentBulkDeletionAuditTruncated object` + - `ClaudeProjectDocumentUploaded object` - A bulk request to delete documents from a Claude project failed with more documents requested than were individually recorded in the audit log. + A document was uploaded to a Claude project. - `actor: object or object or object or 8 more` @@ -103257,15 +105825,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `audited_count: number` - - Number of documents that received an individual audit record. + - `claude_project_document_id: string` - `claude_project_id: string` - - `requested_count: number` - - Total number of documents the request asked to delete. + - `filename: string or null` - `id: optional string` @@ -103285,13 +105849,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_document_bulk_deletion_audit_truncated"` + - `type: optional "claude_project_document_uploaded"` - default: claude_project_document_bulk_deletion_audit_truncated + default: claude_project_document_uploaded - - `ClaudeProjectDocumentDeleted object` + - `ClaudeProjectDocumentViewed object` - A document was deleted from a Claude project. + A document in a Claude project was viewed. - `actor: object or object or object or 8 more` @@ -103528,13 +106092,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_document_deleted"` + - `type: optional "claude_project_document_viewed"` - default: claude_project_document_deleted + default: claude_project_document_viewed - - `ClaudeProjectDocumentDeletionFailed object` + - `ClaudeProjectFileAccessFailed object` - A request to delete a document from a Claude project failed. + An attempt to access a file in a Claude project failed. - `actor: object or object or object or 8 more` @@ -103747,12 +106311,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_document_id: string or null` + - `claude_file_id: string` - `claude_project_id: string` - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -103771,13 +106333,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_document_deletion_failed"` + - `type: optional "claude_project_file_access_failed"` - default: claude_project_document_deletion_failed + default: claude_project_file_access_failed - - `ClaudeProjectDocumentUpdated object` + - `ClaudeProjectFileBulkDeletionAuditTruncated object` - The content of a document in a Claude project was replaced in place. + A bulk request to delete files from a Claude project failed with more files requested than were individually recorded in the audit log. - `actor: object or object or object or 8 more` @@ -103990,11 +106552,15 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_document_id: string` + - `audited_count: number` + + Number of files that received an individual audit record. - `claude_project_id: string` - - `filename: string or null` + - `requested_count: number` + + Total number of files the request asked to delete. - `id: optional string` @@ -104014,13 +106580,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_document_updated"` + - `type: optional "claude_project_file_bulk_deletion_audit_truncated"` - default: claude_project_document_updated + default: claude_project_file_bulk_deletion_audit_truncated - - `ClaudeProjectDocumentUploaded object` + - `ClaudeProjectFileDeleted object` - A document was uploaded to a Claude project. + A file was deleted from a Claude project. - `actor: object or object or object or 8 more` @@ -104233,12 +106799,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_document_id: string` + - `claude_file_id: string` - `claude_project_id: string` - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -104257,13 +106821,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_document_uploaded"` + - `type: optional "claude_project_file_deleted"` - default: claude_project_document_uploaded + default: claude_project_file_deleted - - `ClaudeProjectDocumentViewed object` + - `ClaudeProjectFileDeletionFailed object` - A document in a Claude project was viewed. + A request to delete a file from a Claude project failed. - `actor: object or object or object or 8 more` @@ -104476,12 +107040,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_document_id: string` + - `claude_file_id: string or null` - `claude_project_id: string` - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -104500,13 +107062,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_document_viewed"` + - `type: optional "claude_project_file_deletion_failed"` - default: claude_project_document_viewed + default: claude_project_file_deletion_failed - - `ClaudeProjectFileAccessFailed object` + - `ClaudeProjectFileUploaded object` - An attempt to access a file in a Claude project failed. + A file was uploaded to a Claude project. - `actor: object or object or object or 8 more` @@ -104723,6 +107285,8 @@ compliance activities that can be filtered by various criteria. - `claude_project_id: string` + - `filename: string or null` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -104741,13 +107305,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_file_access_failed"` + - `type: optional "claude_project_file_uploaded"` - default: claude_project_file_access_failed + default: claude_project_file_uploaded - - `ClaudeProjectFileBulkDeletionAuditTruncated object` + - `ClaudeProjectReported object` - A bulk request to delete files from a Claude project failed with more files requested than were individually recorded in the audit log. + A Claude project was reported. - `actor: object or object or object or 8 more` @@ -104960,16 +107524,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `audited_count: number` - - Number of files that received an individual audit record. - - `claude_project_id: string` - - `requested_count: number` - - Total number of files the request asked to delete. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -104988,13 +107544,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_file_bulk_deletion_audit_truncated"` + - `type: optional "claude_project_reported"` - default: claude_project_file_bulk_deletion_audit_truncated + default: claude_project_reported - - `ClaudeProjectFileDeleted object` + - `ClaudeProjectSharingUpdated object` - A file was deleted from a Claude project. + A Claude project's sharing settings were updated. - `actor: object or object or object or 8 more` @@ -105207,10 +107763,30 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` + - `audience: array of object or object` + + Sharing audience for the project. If empty, it's only visible to the creating user. + + - `Public object` + + Sharing audience: the project is visible to anyone with the link. + + - `type: optional "public"` + + default: public + + - `Organization object` + + Sharing audience: the project is visible to members of the owning organization. + + - `type: optional "organization"` + + default: organization - `claude_project_id: string` + The project's identifier, e.g. "claude_proj_01Ab...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -105229,13 +107805,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_file_deleted"` + - `type: optional "claude_project_sharing_updated"` - default: claude_project_file_deleted + default: claude_project_sharing_updated - - `ClaudeProjectFileDeletionFailed object` + - `ClaudeProjectViewed object` - A request to delete a file from a Claude project failed. + A Claude project was viewed. - `actor: object or object or object or 8 more` @@ -105448,8 +108024,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string or null` - - `claude_project_id: string` - `id: optional string` @@ -105470,13 +108044,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_file_deletion_failed"` + - `preview_only: optional boolean` - default: claude_project_file_deletion_failed + default: false - - `ClaudeProjectFileUploaded object` + - `type: optional "claude_project_viewed"` - A file was uploaded to a Claude project. + default: claude_project_viewed + + - `ClaudePubsecIdentityConfigured object` + + SAML IdP configuration updated for a public sector organization. - `actor: object or object or object or 8 more` @@ -105689,11 +108267,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` - - - `claude_project_id: string` + - `idp_saml_config_updated: boolean` - - `filename: string or null` + - `magic_link_toggled: boolean` - `id: optional string` @@ -105705,6 +108281,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `magic_link_enabled: optional boolean or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -105713,13 +108291,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_file_uploaded"` + - `type: optional "claude_pubsec_identity_configured"` - default: claude_project_file_uploaded + default: claude_pubsec_identity_configured - - `ClaudeProjectReported object` + - `RbacRoleAssigned object` - A Claude project was reported. + Admin assigned an RBAC custom role to a principal. - `actor: object or object or object or 8 more` @@ -105932,7 +108510,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `principal_id: string` + + Tagged ID of the principal + + - `principal_type: string` + + Type of principal: account, group, or service_account + + - `role_id: string` + + Tagged ID of the role - `id: optional string` @@ -105952,13 +108540,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_reported"` + - `type: optional "rbac_role_assigned"` - default: claude_project_reported + default: rbac_role_assigned - - `ClaudeProjectSharingUpdated object` + - `RbacRoleCreated object` - A Claude project's sharing settings were updated. + Admin created an RBAC custom role. - `actor: object or object or object or 8 more` @@ -106171,23 +108759,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `audience: array of object or object` - - Sharing audience for the project. If empty, this it's only visible to the creating user. - - - `ProjectSharingAudiencePublic object` - - - `type: optional "public"` - - default: public - - - `ProjectSharingAudienceOrganization object` + - `role_id: string` - - `type: optional "organization"` + Tagged ID of the created role - default: organization + - `role_name: string` - - `claude_project_id: string` + Name of the created role - `id: optional string` @@ -106207,13 +108785,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_sharing_updated"` + - `type: optional "rbac_role_created"` - default: claude_project_sharing_updated + default: rbac_role_created - - `ClaudeProjectViewed object` + - `RbacRoleDeleted object` - A Claude project was viewed. + Admin deleted an RBAC custom role. - `actor: object or object or object or 8 more` @@ -106426,7 +109004,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `role_id: string` + + Tagged ID of the deleted role - `id: optional string` @@ -106446,17 +109026,20 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `preview_only: optional boolean` + - `type: optional "rbac_role_deleted"` - default: false + default: rbac_role_deleted - - `type: optional "claude_project_viewed"` + - `RbacRolePermissionAdded object` - default: claude_project_viewed + Admin added a permission to an RBAC custom role. - - `ClaudePubsecIdentityConfigured object` + Emitted once per requested permission, including permissions the role + already had, so a retried request still produces a complete audit record. - SAML IdP configuration updated for a public sector organization. + - `action: string` + + Action permitted on the resource - `actor: object or object or object or 8 more` @@ -106669,9 +109252,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `idp_saml_config_updated: boolean` + - `resource_id: string` - - `magic_link_toggled: boolean` + ID of the resource + + - `resource_type: string` + + Type of resource the permission applies to + + - `role_id: string` + + Tagged ID of the role - `id: optional string` @@ -106683,8 +109274,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `magic_link_enabled: optional boolean or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -106693,13 +109282,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_pubsec_identity_configured"` + - `type: optional "rbac_role_permission_added"` - default: claude_pubsec_identity_configured + default: rbac_role_permission_added - - `RbacRoleAssigned object` + - `RbacRolePermissionRemoved object` - Admin assigned an RBAC custom role to a principal. + Admin removed a permission from an RBAC custom role. + + Emitted once per requested permission, including permissions the role + already lacked, so a retried request still produces a complete audit + record. + + - `action: string` + + Action that was permitted on the resource - `actor: object or object or object or 8 more` @@ -106912,13 +109509,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `principal_id: string` + - `resource_id: string` - Tagged ID of the principal + ID of the resource - - `principal_type: string` + - `resource_type: string` - Type of principal: account, group, or service_account + Type of resource the permission applied to - `role_id: string` @@ -106942,13 +109539,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_assigned"` + - `type: optional "rbac_role_permission_removed"` - default: rbac_role_assigned + default: rbac_role_permission_removed - - `RbacRoleCreated object` + - `RbacRoleUnassigned object` - Admin created an RBAC custom role. + Admin unassigned an RBAC custom role from a principal. - `actor: object or object or object or 8 more` @@ -107161,13 +109758,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `role_id: string` + - `principal_id: string` - Tagged ID of the created role + Tagged ID of the principal - - `role_name: string` + - `principal_type: string` - Name of the created role + Type of principal: account, group, or service_account + + - `role_id: string` + + Tagged ID of the role - `id: optional string` @@ -107187,13 +109788,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_created"` + - `type: optional "rbac_role_unassigned"` - default: rbac_role_created + default: rbac_role_unassigned - - `RbacRoleDeleted object` + - `RbacRoleUpdated object` - Admin deleted an RBAC custom role. + Admin updated an RBAC custom role. - `actor: object or object or object or 8 more` @@ -107408,7 +110009,7 @@ compliance activities that can be filtered by various criteria. - `role_id: string` - Tagged ID of the deleted role + Tagged ID of the updated role - `id: optional string` @@ -107428,20 +110029,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_deleted"` - - default: rbac_role_deleted - - - `RbacRolePermissionAdded object` - - Admin added a permission to an RBAC custom role. + - `type: optional "rbac_role_updated"` - Emitted once per requested permission, including permissions the role - already had, so a retried request still produces a complete audit record. + default: rbac_role_updated - - `action: string` + - `RoleAssignmentGranted object` - Action permitted on the resource + Role assignment was granted. - `actor: object or object or object or 8 more` @@ -107654,18 +110248,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` - - ID of the resource - - - `resource_type: string` - - Type of resource the permission applies to - - - `role_id: string` - - Tagged ID of the role - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -107684,21 +110266,33 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_permission_added"` + - `resource_id: optional string or null` - default: rbac_role_permission_added + ID of the resource the role is on. - - `RbacRolePermissionRemoved object` + - `resource_type: optional string or null` - Admin removed a permission from an RBAC custom role. + What kind of resource the role is on, for example "chat_project", "skill", or "plugin". - Emitted once per requested permission, including permissions the role - already lacked, so a retried request still produces a complete audit - record. + - `role: optional string or null` - - `action: string` + The role that was granted, for example "skill:viewer" or "plugin:viewer". - Action that was permitted on the resource + - `target_id: optional string or null` + + ID of the grantee: a user ID for a member, a group ID for a group, the organization ID for an organization-wide grant. + + - `target_type: optional string or null` + + What kind of grantee received the role, for example "organization_member", "group", or "organization". + + - `type: optional "role_assignment_granted"` + + default: role_assignment_granted + + - `RoleAssignmentRevoked object` + + Role assignment was revoked. - `actor: object or object or object or 8 more` @@ -107911,18 +110505,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` - - ID of the resource - - - `resource_type: string` - - Type of resource the permission applied to - - - `role_id: string` - - Tagged ID of the role - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -107941,13 +110523,33 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_permission_removed"` + - `resource_id: optional string or null` - default: rbac_role_permission_removed + ID of the resource the role was on. - - `RbacRoleUnassigned object` + - `resource_type: optional string or null` - Admin unassigned an RBAC custom role from a principal. + What kind of resource the role was on, for example "chat_project", "skill", or "plugin". + + - `role: optional string or null` + + The role that was revoked, for example "skill:viewer" or "plugin:viewer". + + - `target_id: optional string or null` + + ID of the grantee that held the role: a user ID for a member, a group ID for a group, the organization ID for an organization-wide grant. + + - `target_type: optional string or null` + + What kind of grantee held the role, for example "organization_member", "group", or "organization". + + - `type: optional "role_assignment_revoked"` + + default: role_assignment_revoked + + - `SSOLoginFailed object` + + An SSO sign-in attempt failed. - `actor: object or object or object or 8 more` @@ -108160,18 +110762,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `principal_id: string` - - Tagged ID of the principal - - - `principal_type: string` - - Type of principal: account, group, or service_account - - - `role_id: string` - - Tagged ID of the role - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -108190,13 +110780,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_unassigned"` + - `type: optional "sso_login_failed"` - default: rbac_role_unassigned + default: sso_login_failed - - `RbacRoleUpdated object` + - `SSOLoginInitiated object` - Admin updated an RBAC custom role. + A user started an SSO sign-in flow. - `actor: object or object or object or 8 more` @@ -108409,10 +110999,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `role_id: string` - - Tagged ID of the updated role - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -108431,13 +111017,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "rbac_role_updated"` + - `type: optional "sso_login_initiated"` - default: rbac_role_updated + default: sso_login_initiated - - `RoleAssignmentGranted object` + - `SSOLoginSucceeded object` - Role assignment was granted. + A user successfully signed in with SSO. - `actor: object or object or object or 8 more` @@ -108654,12 +111240,22 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `auth_method: optional "sso"` + + The method the user used to authenticate. May be absent on activities recorded before this field was introduced. + + default: sso + - `created_at: optional string` When this activity occurred. format: date-time + - `mfa_method: optional "not_used" or null` + + The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -108668,23 +111264,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_id: optional string or null` - - - `resource_type: optional string or null` - - - `role: optional string or null` - - - `target_id: optional string or null` - - - `target_type: optional string or null` - - - `type: optional "role_assignment_granted"` + - `type: optional "sso_login_succeeded"` - default: role_assignment_granted + default: sso_login_succeeded - - `RoleAssignmentRevoked object` + - `SSOSecondFactorMagicLink object` - Role assignment was revoked. + SSO second factor magic link was used. - `actor: object or object or object or 8 more` @@ -108915,23 +111501,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_id: optional string or null` - - - `resource_type: optional string or null` - - - `role: optional string or null` - - - `target_id: optional string or null` - - - `target_type: optional string or null` - - - `type: optional "role_assignment_revoked"` + - `type: optional "sso_second_factor_magic_link"` - default: role_assignment_revoked + default: sso_second_factor_magic_link - - `SSOLoginFailed object` + - `ScimUserCreated object` - An SSO sign-in attempt failed. + A SCIM user was provisioned. - `actor: object or object or object or 8 more` @@ -109144,6 +111720,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -109162,13 +111740,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "sso_login_failed"` + - `type: optional "scim_user_created"` - default: sso_login_failed + default: scim_user_created - - `SSOLoginInitiated object` + - `ScimUserDeleted object` - A user started an SSO sign-in flow. + A SCIM user was deleted. - `actor: object or object or object or 8 more` @@ -109381,6 +111959,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -109399,13 +111979,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "sso_login_initiated"` + - `type: optional "scim_user_deleted"` - default: sso_login_initiated + default: scim_user_deleted - - `SSOLoginSucceeded object` + - `ScimUserUpdated object` - A user successfully signed in with SSO. + A SCIM user was updated. - `actor: object or object or object or 8 more` @@ -109618,26 +112198,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `auth_method: optional "sso"` - - The method the user used to authenticate. May be absent on activities recorded before this field was introduced. - - default: sso - - `created_at: optional string` When this activity occurred. format: date-time - - `mfa_method: optional "not_used" or null` - - The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -109646,13 +112218,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "sso_login_succeeded"` + - `type: optional "scim_user_updated"` - default: sso_login_succeeded + default: scim_user_updated - - `SSOSecondFactorMagicLink object` + - `ScopedAPIKeyDeleted object` - SSO second factor magic link was used. + A scoped API key was deleted. - `actor: object or object or object or 8 more` @@ -109865,6 +112437,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `api_key_id: string` + + Tagged ID of the deleted scoped API key + + - `api_key_name: string` + + Name of the deleted scoped API key + + - `scopes: array of string` + + Scopes the deleted key had + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -109883,13 +112467,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "sso_second_factor_magic_link"` + - `type: optional "scoped_api_key_deleted"` - default: sso_second_factor_magic_link + default: scoped_api_key_deleted - - `ScimUserCreated object` + - `ScopedAPIKeyUpdated object` - A SCIM user was provisioned. + A scoped API key was renamed or its activation state changed. - `actor: object or object or object or 8 more` @@ -110102,7 +112686,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` + - `api_key_id: string` + + Tagged ID of the updated scoped API key + + - `updates: array of object` + + - `current_value: string` + + - `previous_value: string` + + - `type: "activation_state" or "name"` + + - `"activation_state"` + + - `"name"` - `id: optional string` @@ -110122,13 +112720,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "scim_user_created"` + - `type: optional "scoped_api_key_updated"` - default: scim_user_created + default: scoped_api_key_updated - - `ScimUserDeleted object` + - `SeatTierChangesCancelled object` - A SCIM user was deleted. + Scheduled seat tier downgrades were cancelled. - `actor: object or object or object or 8 more` @@ -110341,8 +112939,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -110361,13 +112957,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "scim_user_deleted"` + - `type: optional "seat_tier_changes_cancelled"` - default: scim_user_deleted + default: seat_tier_changes_cancelled - - `ScimUserUpdated object` + - `SeatTiersPurchased object` - A SCIM user was updated. + Seat tiers were purchased or upgraded on a subscription. - `actor: object or object or object or 8 more` @@ -110580,8 +113176,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -110592,6 +113186,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `item_allocations: optional map[number] or null` + + Desired seat tier allocations (item type to quantity). + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -110600,13 +113198,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "scim_user_updated"` + - `type: optional "seat_tiers_purchased"` - default: scim_user_updated + default: seat_tiers_purchased - - `ScopedAPIKeyDeleted object` + - `ServiceCreated object` - A scoped API key was deleted. + Activity logged when an org service is explicitly created. - `actor: object or object or object or 8 more` @@ -110819,17 +113417,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `api_key_id: string` - - Tagged ID of the deleted scoped API key - - - `api_key_name: string` - - Name of the deleted scoped API key - - - `scopes: array of string` + - `service_name: string` - Scopes the deleted key had + The org service name (e.g., 'external:my-service') - `id: optional string` @@ -110849,13 +113439,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "scoped_api_key_deleted"` + - `type: optional "service_created"` - default: scoped_api_key_deleted + default: service_created - - `ScopedAPIKeyUpdated object` + - `ServiceDeleted object` - A scoped API key was renamed or its activation state changed. + Activity logged when an org service is deleted. - `actor: object or object or object or 8 more` @@ -111068,21 +113658,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `api_key_id: string` - - Tagged ID of the updated scoped API key - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "activation_state" or "name"` - - - `"activation_state"` + - `service_name: string` - - `"name"` + The org service name (e.g., 'external:my-service') - `id: optional string` @@ -111102,13 +113680,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "scoped_api_key_updated"` + - `type: optional "service_deleted"` - default: scoped_api_key_updated + default: service_deleted - - `SeatTierChangesCancelled object` + - `ServiceKeyCreated object` - Scheduled seat tier downgrades were cancelled. + Activity logged when a new org service key is created. - `actor: object or object or object or 8 more` @@ -111321,6 +113899,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `is_service_created: boolean` + + Whether the org service was implicitly created in this request + + - `key_name: string` + + The human-readable name of the key + + - `service_name: string` + + The service name this key belongs to + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -111339,13 +113929,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "seat_tier_changes_cancelled"` + - `scopes: optional array of string` - default: seat_tier_changes_cancelled + The scopes granted to this service key - - `SeatTiersPurchased object` + - `service_key_id: optional string or null` - Seat tiers were purchased or upgraded on a subscription. + The ID of the created service key + + - `type: optional "service_key_created"` + + default: service_key_created + + - `ServiceKeyRevoked object` + + Activity logged when an org service key is revoked. - `actor: object or object or object or 8 more` @@ -111558,6 +114156,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `service_key_id: string` + + The tagged ID of the revoked service key + + - `service_name: string` + + The service name this key belongs to + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -111568,10 +114174,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `item_allocations: optional map[number] or null` - - Desired seat tier allocations (item type to quantity). - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -111580,13 +114182,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "seat_tiers_purchased"` + - `type: optional "service_key_revoked"` - default: seat_tiers_purchased + default: service_key_revoked - - `ServiceCreated object` + - `SessionRevoked object` - Activity logged when an org service is explicitly created. + User revoked a specific session. - `actor: object or object or object or 8 more` @@ -111799,10 +114401,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `service_name: string` - - The org service name (e.g., 'external:my-service') - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -111821,13 +114419,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "service_created"` + - `type: optional "session_revoked"` - default: service_created + default: session_revoked - - `ServiceDeleted object` + - `SessionShareAccessed object` - Activity logged when an org service is deleted. + Session share was accessed. - `actor: object or object or object or 8 more` @@ -112040,10 +114638,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `service_name: string` - - The org service name (e.g., 'external:my-service') - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -112062,13 +114656,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "service_deleted"` + - `share_id: optional string or null` - default: service_deleted + - `type: optional "session_share_accessed"` - - `ServiceKeyCreated object` + default: session_share_accessed - Activity logged when a new org service key is created. + - `SessionShareCreated object` + + Session share was created. - `actor: object or object or object or 8 more` @@ -112281,22 +114877,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `is_service_created: boolean` - - Whether the org service was implicitly created in this request - - - `key_name: string` - - The human-readable name of the key - - - `service_name: string` - - The service name this key belongs to - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_level: optional string or null` + + Access level granted for the share. + - `created_at: optional string` When this activity occurred. @@ -112311,21 +114899,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scopes: optional array of string` - - The scopes granted to this service key - - - `service_key_id: optional string or null` - - The ID of the created service key + - `share_id: optional string or null` - - `type: optional "service_key_created"` + - `type: optional "session_share_created"` - default: service_key_created + default: session_share_created - - `ServiceKeyRevoked object` + - `SessionShareRevoked object` - Activity logged when an org service key is revoked. + Session share was revoked. - `actor: object or object or object or 8 more` @@ -112538,14 +115120,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `service_key_id: string` - - The tagged ID of the revoked service key - - - `service_name: string` - - The service name this key belongs to - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -112564,13 +115138,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "service_key_revoked"` + - `reason: optional string or null` - default: service_key_revoked + Why the share was revoked. - - `SessionRevoked object` + - `share_id: optional string or null` - User revoked a specific session. + - `type: optional "session_share_revoked"` + + default: session_share_revoked + + - `ClaudeSkillCreated object` + + Skill was created. - `actor: object or object or object or 8 more` @@ -112801,13 +115381,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "session_revoked"` + - `skill_id: optional string or null` - default: session_revoked + - `skill_name: optional string or null` - - `SessionShareAccessed object` + - `type: optional "claude_skill_created"` - Session share was accessed. + default: claude_skill_created + + - `ClaudeSkillDeleted object` + + Skill was deleted. - `actor: object or object or object or 8 more` @@ -113030,6 +115614,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `deleted_version_ids: optional array of string` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -113038,15 +115624,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `share_id: optional string or null` + - `skill_id: optional string or null` - - `type: optional "session_share_accessed"` + - `skill_name: optional string or null` - default: session_share_accessed + - `type: optional "claude_skill_deleted"` - - `SessionShareCreated object` + default: claude_skill_deleted - Session share was created. + - `versions_deleted: optional number or null` + + Set when the deletion removed the skill's versions in the same request (the public API's cascading skill delete): one consolidated record of what went with the skill, reconcilable against earlier version-created records, rather than one version-deleted activity per row. versions_deleted is the exact count; deleted_version_ids lists at most the newest 1000 (truncated when versions_deleted exceeds its length). + + - `ClaudeSkillDisabled object` + + User disabled a skill for their account. - `actor: object or object or object or 8 more` @@ -113263,10 +115855,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `access_level: optional string or null` - - Access level granted for the share. - - `created_at: optional string` When this activity occurred. @@ -113281,15 +115869,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `share_id: optional string or null` + - `skill_id: optional string or null` - - `type: optional "session_share_created"` + - `skill_name: optional string or null` - default: session_share_created + - `type: optional "claude_skill_disabled"` - - `SessionShareRevoked object` + default: claude_skill_disabled - Session share was revoked. + - `ClaudeSkillEnabled object` + + User enabled a skill for their account. - `actor: object or object or object or 8 more` @@ -113520,19 +116110,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reason: optional string or null` - - Why the share was revoked. + - `skill_id: optional string or null` - - `share_id: optional string or null` + - `skill_name: optional string or null` - - `type: optional "session_share_revoked"` + - `type: optional "claude_skill_enabled"` - default: session_share_revoked + default: claude_skill_enabled - - `ClaudeSkillCreated object` + - `ClaudeSkillReplaced object` - Skill was created. + Skill was replaced. - `actor: object or object or object or 8 more` @@ -113767,13 +116355,14 @@ compliance activities that can be filtered by various criteria. - `skill_name: optional string or null` - - `type: optional "claude_skill_created"` + - `type: optional "claude_skill_replaced"` - default: claude_skill_created + default: claude_skill_replaced - - `ClaudeSkillDeleted object` + - `SlackWorkspaceClaimRevoked object` - Skill was deleted. + A Slack workspace or Enterprise Grid organization was disconnected + from the organization for Claude in Slack. - `actor: object or object or object or 8 more` @@ -113986,6 +116575,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `slack_team_id: string` + + Claim subject: a Slack team id for scope 'workspace', or an Enterprise Grid org id for scope 'enterprise_grid'. Use the scope field to tell which — never the value's prefix (legacy workspaces exist with E-prefixed team ids) + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -113996,8 +116589,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `deleted_version_ids: optional array of string` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -114006,21 +116597,20 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `skill_id: optional string or null` - - - `skill_name: optional string or null` + - `scope: optional string` - - `type: optional "claude_skill_deleted"` + Blast radius of the revocation: 'workspace' for one Slack workspace, 'enterprise_grid' for every workspace in a Slack Enterprise Grid organization - default: claude_skill_deleted + default: workspace - - `versions_deleted: optional number or null` + - `type: optional "slack_workspace_claim_revoked"` - Set when the deletion removed the skill's versions in the same request (the public API's cascading skill delete): one consolidated record of what went with the skill, reconcilable against earlier version-created records, rather than one version-deleted activity per row. versions_deleted is the exact count; deleted_version_ids lists at most the newest 1000 (truncated when versions_deleted exceeds its length). + default: slack_workspace_claim_revoked - - `ClaudeSkillDisabled object` + - `SlackWorkspaceClaimed object` - User disabled a skill for their account. + A Slack workspace or Enterprise Grid organization was connected to + the organization for Claude in Slack. - `actor: object or object or object or 8 more` @@ -114233,6 +116823,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `slack_team_id: string` + + Claim subject: a Slack team id for scope 'workspace', or an Enterprise Grid org id for scope 'enterprise_grid'. Use the scope field to tell which — never the value's prefix (legacy workspaces exist with E-prefixed team ids) + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -114251,17 +116845,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `skill_id: optional string or null` + - `scope: optional string` - - `skill_name: optional string or null` + Blast radius of the claim: 'workspace' for one Slack workspace, 'enterprise_grid' for every workspace in a Slack Enterprise Grid organization - - `type: optional "claude_skill_disabled"` + default: workspace - default: claude_skill_disabled + - `type: optional "slack_workspace_claimed"` - - `ClaudeSkillEnabled object` + default: slack_workspace_claimed - User enabled a skill for their account. + - `SocialLoginSucceeded object` + + A user successfully signed in with a social identity provider (Google, Apple, or Microsoft). - `actor: object or object or object or 8 more` @@ -114474,16 +117070,34 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `provider: "apple" or "google" or "microsoft"` + + - `"apple"` + + - `"google"` + + - `"microsoft"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `auth_method: optional "social"` + + The method the user used to authenticate. May be absent on activities recorded before this field was introduced. + + default: social + - `created_at: optional string` When this activity occurred. format: date-time + - `mfa_method: optional "not_used" or null` + + The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -114492,17 +117106,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `skill_id: optional string or null` - - - `skill_name: optional string or null` - - - `type: optional "claude_skill_enabled"` + - `type: optional "social_login_succeeded"` - default: claude_skill_enabled + default: social_login_succeeded - - `ClaudeSkillReplaced object` + - `StepUpAuthenticationFailed object` - Skill was replaced. + An additional identity check failed. - `actor: object or object or object or 8 more` @@ -114715,6 +117325,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `method: "device_key" or "unspecified" or "webauthn"` + + The verification method the user attempted. + + - `"device_key"` + + - `"unspecified"` + + - `"webauthn"` + + - `reason: "challenge_rejected" or "unspecified" or "verification_failed"` + + Why the attempt failed. + + - `"challenge_rejected"` + + - `"unspecified"` + + - `"verification_failed"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -114733,18 +117363,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `skill_id: optional string or null` + - `trusted_device_id: optional string or null` - - `skill_name: optional string or null` + Identifier of the trusted device the attempt referenced, e.g. "tdev_...". Present only for the device key method. - - `type: optional "claude_skill_replaced"` + - `type: optional "step_up_authentication_failed"` - default: claude_skill_replaced + default: step_up_authentication_failed - - `SlackWorkspaceClaimRevoked object` + - `StepUpAuthenticationSucceeded object` - A Slack workspace or Enterprise Grid organization was disconnected - from the organization for Claude in Slack. + The user completed an additional identity check to confirm a sensitive action. - `actor: object or object or object or 8 more` @@ -114957,9 +117586,15 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `slack_team_id: string` + - `method: "device_key" or "unspecified" or "webauthn"` - Claim subject: a Slack team id for scope 'workspace', or an Enterprise Grid org id for scope 'enterprise_grid'. Use the scope field to tell which — never the value's prefix (legacy workspaces exist with E-prefixed team ids) + The verification method the user completed. + + - `"device_key"` + + - `"unspecified"` + + - `"webauthn"` - `id: optional string` @@ -114979,20 +117614,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scope: optional string` - - Blast radius of the revocation: 'workspace' for one Slack workspace, 'enterprise_grid' for every workspace in a Slack Enterprise Grid organization + - `trusted_device_id: optional string or null` - default: workspace + Identifier of the trusted device used, e.g. "tdev_...". Present only for the device key method. - - `type: optional "slack_workspace_claim_revoked"` + - `type: optional "step_up_authentication_succeeded"` - default: slack_workspace_claim_revoked + default: step_up_authentication_succeeded - - `SlackWorkspaceClaimed object` + - `StepUpCredentialEnrolled object` - A Slack workspace or Enterprise Grid organization was connected to - the organization for Claude in Slack. + A user enrolled a passkey for confirming sensitive actions on their account. - `actor: object or object or object or 8 more` @@ -115205,9 +117837,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `slack_team_id: string` + - `credential_id: string` - Claim subject: a Slack team id for scope 'workspace', or an Enterprise Grid org id for scope 'enterprise_grid'. Use the scope field to tell which — never the value's prefix (legacy workspaces exist with E-prefixed team ids) + Identifier of the enrolled credential, e.g. "sucr_...". - `id: optional string` @@ -115227,19 +117859,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scope: optional string` - - Blast radius of the claim: 'workspace' for one Slack workspace, 'enterprise_grid' for every workspace in a Slack Enterprise Grid organization - - default: workspace - - - `type: optional "slack_workspace_claimed"` + - `type: optional "step_up_credential_enrolled"` - default: slack_workspace_claimed + default: step_up_credential_enrolled - - `SocialLoginSucceeded object` + - `SubscriptionCancellationScheduled object` - A user successfully signed in with a social identity provider (Google, Apple, or Microsoft). + Subscription cancellation was scheduled at end of billing period. - `actor: object or object or object or 8 more` @@ -115452,34 +118078,16 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `provider: "apple" or "google" or "microsoft"` - - - `"apple"` - - - `"google"` - - - `"microsoft"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `auth_method: optional "social"` - - The method the user used to authenticate. May be absent on activities recorded before this field was introduced. - - default: social - - `created_at: optional string` When this activity occurred. format: date-time - - `mfa_method: optional "not_used" or null` - - The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -115488,13 +118096,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "social_login_succeeded"` + - `type: optional "subscription_cancellation_scheduled"` - default: social_login_succeeded + default: subscription_cancellation_scheduled - - `StepUpAuthenticationFailed object` + - `SubscriptionQuantityUpdated object` - An additional identity check failed. + Contracted subscription seat quantity was updated. - `actor: object or object or object or 8 more` @@ -115707,25 +118315,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `method: "device_key" or "unspecified" or "webauthn"` - - The verification method the user attempted. - - - `"device_key"` - - - `"unspecified"` - - - `"webauthn"` - - - `reason: "challenge_rejected" or "unspecified" or "verification_failed"` - - Why the attempt failed. - - - `"challenge_rejected"` - - - `"unspecified"` + - `added_seats: number` - - `"verification_failed"` + - `new_quantity: number` - `id: optional string` @@ -115745,17 +118337,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `trusted_device_id: optional string or null` - - Identifier of the trusted device the attempt referenced, e.g. "tdev_...". Present only for the device key method. + - `previous_quantity: optional number or null` - - `type: optional "step_up_authentication_failed"` + - `type: optional "subscription_quantity_updated"` - default: step_up_authentication_failed + default: subscription_quantity_updated - - `StepUpAuthenticationSucceeded object` + - `SubscriptionRenewed object` - The user completed an additional identity check to confirm a sensitive action. + A cancelled subscription was renewed. - `actor: object or object or object or 8 more` @@ -115968,20 +118558,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `method: "device_key" or "unspecified" or "webauthn"` - - The verification method the user completed. - - - `"device_key"` - - - `"unspecified"` - - - `"webauthn"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `billing_interval: optional string or null` + + Billing interval (e.g. monthly, annual). + - `created_at: optional string` When this activity occurred. @@ -115996,17 +118580,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `trusted_device_id: optional string or null` + - `plan_type: optional string or null` - Identifier of the trusted device used, e.g. "tdev_...". Present only for the device key method. + Plan type being renewed into (e.g. team). - - `type: optional "step_up_authentication_succeeded"` + - `type: optional "subscription_renewed"` - default: step_up_authentication_succeeded + default: subscription_renewed - - `StepUpCredentialEnrolled object` + - `SubscriptionResumed object` - A user enrolled a passkey for confirming sensitive actions on their account. + A scheduled subscription cancellation was reversed. - `actor: object or object or object or 8 more` @@ -116219,10 +118803,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - Identifier of the enrolled credential, e.g. "sucr_...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -116241,13 +118821,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "step_up_credential_enrolled"` + - `type: optional "subscription_resumed"` - default: step_up_credential_enrolled + default: subscription_resumed - - `SubscriptionCancellationScheduled object` + - `SubscriptionStarted object` - Subscription cancellation was scheduled at end of billing period. + A new subscription was created (Team or Enterprise). - `actor: object or object or object or 8 more` @@ -116464,6 +119044,10 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `billing_interval: optional string or null` + + Billing interval (e.g. monthly, annual). + - `created_at: optional string` When this activity occurred. @@ -116478,13 +119062,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "subscription_cancellation_scheduled"` + - `plan_type: optional string or null` - default: subscription_cancellation_scheduled + Type of subscription started (e.g. team, enterprise). - - `SubscriptionQuantityUpdated object` + - `seat_count: optional number or null` - Contracted subscription seat quantity was updated. + Number of seats purchased. + + - `type: optional "subscription_started"` + + default: subscription_started + + - `SubscriptionUpgraded object` + + Subscription plan was upgraded (e.g. Team to Enterprise). - `actor: object or object or object or 8 more` @@ -116697,10 +119289,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `added_seats: number` - - - `new_quantity: number` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -116711,6 +119299,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `new_plan: optional string or null` + + New plan type after upgrade. + + - `old_plan: optional string or null` + + Previous plan type. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -116719,15 +119315,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_quantity: optional number or null` - - - `type: optional "subscription_quantity_updated"` + - `type: optional "subscription_upgraded"` - default: subscription_quantity_updated + default: subscription_upgraded - - `SubscriptionRenewed object` + - `TrustedDeviceCredentialRotated object` - A cancelled subscription was renewed. + The identity-verification credential of a trusted device was rotated to a new key. - `actor: object or object or object or 8 more` @@ -116940,13 +119534,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `trusted_device_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Identifier of the device whose credential was rotated, e.g. "tdev_...". - - `billing_interval: optional string or null` + - `id: optional string` - Billing interval (e.g. monthly, annual). + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -116962,17 +119556,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plan_type: optional string or null` - - Plan type being renewed into (e.g. team). - - - `type: optional "subscription_renewed"` + - `type: optional "trusted_device_credential_rotated"` - default: subscription_renewed + default: trusted_device_credential_rotated - - `SubscriptionResumed object` + - `TrustedDeviceEnrolled object` - A scheduled subscription cancellation was reversed. + A device was enrolled as a trusted device for the user's account. Trusted devices can be used to confirm the user's identity for sensitive actions. - `actor: object or object or object or 8 more` @@ -117185,6 +119775,38 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enrollment_method: "oauth" or "session" or "unspecified"` + + How the user confirmed their identity when enrolling the device. + + - `"oauth"` + + - `"session"` + + - `"unspecified"` + + - `platform: "android" or "claude_in_slack" or "desktop_app" or 4 more` + + The kind of client the enrollment request came from. + + - `"android"` + + - `"claude_in_slack"` + + - `"desktop_app"` + + - `"ios"` + + - `"unspecified"` + + - `"web_claude_ai"` + + - `"web_console"` + + - `trusted_device_id: string` + + Identifier of the device that was enrolled, e.g. "tdev_...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -117203,13 +119825,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "subscription_resumed"` + - `type: optional "trusted_device_enrolled"` - default: subscription_resumed + default: trusted_device_enrolled - - `SubscriptionStarted object` + - `TrustedDeviceRevoked object` - A new subscription was created (Team or Enterprise). + A trusted device was removed from the user's account. - `actor: object or object or object or 8 more` @@ -117422,13 +120044,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `reason: "org_member_removed" or "superseded" or "unspecified" or "user_revoked"` - Unique identifier for the activity e.g. 'activity_abcd1234' + Why the device trust was removed. - - `billing_interval: optional string or null` + - `"org_member_removed"` - Billing interval (e.g. monthly, annual). + - `"superseded"` + + - `"unspecified"` + + - `"user_revoked"` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -117444,21 +120074,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plan_type: optional string or null` + - `revoked_count: optional number or null` - Type of subscription started (e.g. team, enterprise). + Number of devices removed. Set when a security action removed all of the user's trusted devices at once; absent when a single device was removed (see trusted_device_id). - - `seat_count: optional number or null` + - `trusted_device_id: optional string or null` - Number of seats purchased. + Identifier of the device that was removed, e.g. "tdev_...". Set when a single device was removed; absent when several devices were removed at once (see revoked_count). - - `type: optional "subscription_started"` + - `type: optional "trusted_device_revoked"` - default: subscription_started + default: trusted_device_revoked - - `SubscriptionUpgraded object` + - `TunnelArchived object` - Subscription plan was upgraded (e.g. Team to Enterprise). + An MCP tunnel was archived. - `actor: object or object or object or 8 more` @@ -117671,6 +120301,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `tunnel_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -117681,14 +120313,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `new_plan: optional string or null` - - New plan type after upgrade. - - - `old_plan: optional string or null` - - Previous plan type. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -117697,13 +120321,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "subscription_upgraded"` + - `type: optional "tunnel_archived"` - default: subscription_upgraded + default: tunnel_archived - - `TrustedDeviceCredentialRotated object` + - `TunnelCertificateAdded object` - The identity-verification credential of a trusted device was rotated to a new key. + An inner-TLS CA certificate was added to a tunnel. - `actor: object or object or object or 8 more` @@ -117916,14 +120540,16 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `trusted_device_id: string` + - `certificate_id: string` - Identifier of the device whose credential was rotated, e.g. "tdev_...". + - `tunnel_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `certificate_fingerprint: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -117938,13 +120564,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "trusted_device_credential_rotated"` + - `type: optional "tunnel_certificate_added"` - default: trusted_device_credential_rotated + default: tunnel_certificate_added - - `TrustedDeviceEnrolled object` + - `TunnelCertificateRevoked object` - A device was enrolled as a trusted device for the user's account. Trusted devices can be used to confirm the user's identity for sensitive actions. + An inner-TLS CA certificate was revoked from a tunnel. - `actor: object or object or object or 8 more` @@ -118157,42 +120783,16 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enrollment_method: "oauth" or "session" or "unspecified"` - - How the user confirmed their identity when enrolling the device. - - - `"oauth"` - - - `"session"` - - - `"unspecified"` - - - `platform: "android" or "claude_in_slack" or "desktop_app" or 4 more` - - The kind of client the enrollment request came from. - - - `"android"` - - - `"claude_in_slack"` - - - `"desktop_app"` - - - `"ios"` - - - `"unspecified"` - - - `"web_claude_ai"` - - - `"web_console"` - - - `trusted_device_id: string` + - `certificate_id: string` - Identifier of the device that was enrolled, e.g. "tdev_...". + - `tunnel_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `certificate_fingerprint: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -118207,13 +120807,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "trusted_device_enrolled"` + - `type: optional "tunnel_certificate_revoked"` - default: trusted_device_enrolled + default: tunnel_certificate_revoked - - `TrustedDeviceRevoked object` + - `TunnelCreated object` - A trusted device was removed from the user's account. + An MCP tunnel was created. - `actor: object or object or object or 8 more` @@ -118426,17 +121026,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `reason: "org_member_removed" or "superseded" or "unspecified" or "user_revoked"` - - Why the device trust was removed. - - - `"org_member_removed"` - - - `"superseded"` - - - `"unspecified"` - - - `"user_revoked"` + - `tunnel_id: string` - `id: optional string` @@ -118456,21 +121046,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `revoked_count: optional number or null` - - Number of devices removed. Set when a security action removed all of the user's trusted devices at once; absent when a single device was removed (see trusted_device_id). - - - `trusted_device_id: optional string or null` - - Identifier of the device that was removed, e.g. "tdev_...". Set when a single device was removed; absent when several devices were removed at once (see revoked_count). - - - `type: optional "trusted_device_revoked"` + - `type: optional "tunnel_created"` - default: trusted_device_revoked + default: tunnel_created - - `TunnelArchived object` + - `TunnelTokenMinted object` - An MCP tunnel was archived. + An OAuth bearer token for the tunnel management API was minted. - `actor: object or object or object or 8 more` @@ -118683,7 +121265,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `tunnel_id: string` + - `token_id: string` - `id: optional string` @@ -118703,13 +121285,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "tunnel_archived"` + - `token_name: optional string or null` - default: tunnel_archived + - `type: optional "tunnel_token_minted"` - - `TunnelCertificateAdded object` + default: tunnel_token_minted - An inner-TLS CA certificate was added to a tunnel. + - `TunnelTokenRevealed object` + + The Cloudflare connector secret for a tunnel was revealed to the caller. - `actor: object or object or object or 8 more` @@ -118922,16 +121506,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `certificate_id: string` - - `tunnel_id: string` + - `tunnel_token_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `certificate_fingerprint: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -118946,13 +121528,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "tunnel_certificate_added"` + - `type: optional "tunnel_token_revealed"` - default: tunnel_certificate_added + default: tunnel_token_revealed - - `TunnelCertificateRevoked object` + - `TunnelTokenRevoked object` - An inner-TLS CA certificate was revoked from a tunnel. + An OAuth bearer token for the tunnel management API was revoked. - `actor: object or object or object or 8 more` @@ -119165,16 +121747,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `certificate_id: string` - - - `tunnel_id: string` + - `token_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `certificate_fingerprint: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -119189,13 +121767,20 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "tunnel_certificate_revoked"` + - `token_name: optional string or null` - default: tunnel_certificate_revoked + Name the administrator gave the token when it was created, if any - - `TunnelCreated object` + - `type: optional "tunnel_token_revoked"` - An MCP tunnel was created. + default: tunnel_token_revoked + + - `TunnelTokenRotated object` + + The Cloudflare connector secret for a tunnel was rotated. + + `tunnel_token_id` is the id of the *newly-issued* token. The previous + token is invalidated by the rotation and its id is not recorded here. - `actor: object or object or object or 8 more` @@ -119410,6 +121995,8 @@ compliance activities that can be filtered by various criteria. - `tunnel_id: string` + - `tunnel_token_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -119428,13 +122015,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "tunnel_created"` + - `reason: optional string or null` - default: tunnel_created + - `type: optional "tunnel_token_rotated"` - - `TunnelTokenMinted object` + default: tunnel_token_rotated - An OAuth bearer token for the tunnel management API was minted. + - `UserConsentRecorded object` + + User granted a consent for a specific entity (e.g. consumer health consent for an MCP server). - `actor: object or object or object or 8 more` @@ -119647,7 +122236,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `token_id: string` + - `consent_type: string` + + - `entity_id: string` + + - `entity_type: string` - `id: optional string` @@ -119667,15 +122260,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `token_name: optional string or null` - - - `type: optional "tunnel_token_minted"` + - `type: optional "user_consent_recorded"` - default: tunnel_token_minted + default: user_consent_recorded - - `TunnelTokenRevealed object` + - `UserConsentRevoked object` - The Cloudflare connector secret for a tunnel was revealed to the caller. + User revoked a previously granted consent for a specific entity. - `actor: object or object or object or 8 more` @@ -119888,20 +122479,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `tunnel_id: string` - - - `tunnel_token_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `consent_id: optional string or null` + + - `consent_type: optional string or null` + - `created_at: optional string` When this activity occurred. format: date-time + - `entity_id: optional string or null` + + - `entity_type: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -119910,13 +122505,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "tunnel_token_revealed"` + - `type: optional "user_consent_revoked"` - default: tunnel_token_revealed + default: user_consent_revoked - - `TunnelTokenRevoked object` + - `ClaudeUserRoleUpdated object` - An OAuth bearer token for the tunnel management API was revoked. + A user's role within the organization was changed, or the user was added to or removed from the organization. - `actor: object or object or object or 8 more` @@ -120129,255 +122724,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `token_id: string` - - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `organization_id: optional string or null` - - Organization ID this activity is associated with - - - `organization_uuid: optional string or null` - - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - - `token_name: optional string or null` - - Name the administrator gave the token when it was created, if any - - - `type: optional "tunnel_token_revoked"` - - default: tunnel_token_revoked - - - `TunnelTokenRotated object` - - The Cloudflare connector secret for a tunnel was rotated. - - `tunnel_token_id` is the id of the *newly-issued* token. The previous - token is invalidated by the rotation and its id is not recorded here. - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp - - - `FederatedActorOidcProvider object` - - Asserting party: a customer-registered OIDC federation issuer. - - - `issuer: optional string or null` - - The federation issuer's URL. Null when the presented credential failed verification. - - - `type: optional "oidc"` - - default: oidc - - - `ip_address: optional string or null` - - - `subject: optional string or null` - - The provider's verified identifier for the caller; its form depends on the provider. - - - `type: optional "federated_actor"` - - default: federated_actor - - - `user_agent: optional string or null` - - - `AttestedDeviceActor object` - - An attested mobile device authenticated via Apple App Attest. - - - `external_client_id: string` + - `current_role: string or null` - - `kid_hash: string` + If null, then user was removed from the Organization - - `ip_address: optional string or null` + - `previous_role: string or null` - - `type: optional "attested_device_actor"` + If null, then user was added to the Organization - default: attested_device_actor + - `user_email: string` - - `user_agent: optional string or null` + Email of the user whose role was changed - - `tunnel_id: string` + - `user_id: string` - - `tunnel_token_id: string` + ID of the user whose role was changed - `id: optional string` @@ -120397,15 +122758,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reason: optional string or null` - - - `type: optional "tunnel_token_rotated"` + - `type: optional "claude_user_role_updated"` - default: tunnel_token_rotated + default: claude_user_role_updated - - `UserConsentRecorded object` + - `ClaudeUserSettingsUpdated object` - User granted a consent for a specific entity (e.g. consumer health consent for an MCP server). + User updated their personal settings. - `actor: object or object or object or 8 more` @@ -120618,11 +122977,253 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `consent_type: string` + - `updates: array of object or object or object or 19 more` - - `entity_id: string` + - `FullName object` - - `entity_type: string` + - `current_value: string or null` + + - `previous_value: string or null` + + - `type: optional "full_name"` + + default: full_name + + - `DisplayName object` + + - `current_value: string or null` + + - `previous_value: string or null` + + - `type: optional "display_name"` + + default: display_name + + - `ArtifactsEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "artifacts_enabled"` + + default: artifacts_enabled + + - `LatexEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "latex_enabled"` + + default: latex_enabled + + - `AnalysisToolEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "analysis_tool_enabled"` + + default: analysis_tool_enabled + + - `ChatSuggestionsEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "chat_suggestions_enabled"` + + default: chat_suggestions_enabled + + - `MultimodalPdfsEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "multimodal_pdfs_enabled"` + + default: multimodal_pdfs_enabled + + - `GDriveEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "gdrive_enabled"` + + default: gdrive_enabled + + - `WebSearchEnabled object` + + The web search setting was changed. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "web_search_enabled"` + + default: web_search_enabled + + - `GeolocationEnabled object` + + The geolocation setting was changed. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "geolocation_enabled"` + + default: geolocation_enabled + + - `UserMemoryEnabledSetting object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "enabled_saffron"` + + default: enabled_saffron + + - `McpToolsEnabled object` + + - `current_value: map[boolean] or null` + + - `previous_value: map[boolean] or null` + + - `type: optional "mcp_tools_enabled"` + + default: mcp_tools_enabled + + - `CliOpPermissionsEnabled object` + + - `current_value: map[string] or null` + + - `previous_value: map[string] or null` + + - `type: optional "cli_op_permissions_enabled"` + + default: cli_op_permissions_enabled + + - `GoogleDriveSearchEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "google_drive_search_enabled"` + + default: google_drive_search_enabled + + - `GmailIntegrationEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "gmail_integration_enabled"` + + default: gmail_integration_enabled + + - `GoogleCalendarIntegrationEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "google_calendar_integration_enabled"` + + default: google_calendar_integration_enabled + + - `ThinkingModeEnabled object` + + - `current_value: "adaptive" or "extended" or "off" or null` + + - `"adaptive"` + + - `"extended"` + + - `"off"` + + - `previous_value: "adaptive" or "extended" or "off" or null` + + - `"adaptive"` + + - `"extended"` + + - `"off"` + + - `type: optional "thinking_mode_enabled"` + + default: thinking_mode_enabled + + - `ResearchModeEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "research_mode_enabled"` + + default: research_mode_enabled + + - `ComputerUseEnabled object` + + - `current_value: boolean or null` + + - `previous_value: boolean or null` + + - `type: optional "computer_use_enabled"` + + default: computer_use_enabled + + - `ClaudeAPIInArtifactsEnabled object` + + The Claude API in Artifacts setting was changed. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_api_in_artifacts_enabled"` + + default: claude_api_in_artifacts_enabled + + - `ConversationPreferences object` + + The 'conversation_preferences' for the user were updated. Values omitted. + + - `type: optional "conversation_preferences"` + + default: conversation_preferences + + - `CoworkGlobalInstructions object` + + The Cowork global instructions were updated. Values omitted. + + - `type: optional "cowork_global_instructions"` + + default: cowork_global_instructions - `id: optional string` @@ -120642,13 +123243,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "user_consent_recorded"` + - `type: optional "claude_user_settings_updated"` - default: user_consent_recorded + default: claude_user_settings_updated - - `UserConsentRevoked object` + - `VerificationEvidenceSubmitted object` - User revoked a previously granted consent for a specific entity. + Verification evidence was submitted for an organization's verification. - `actor: object or object or object or 8 more` @@ -120861,13 +123462,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `verification_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the verification the evidence was submitted for. - - `consent_id: optional string or null` + - `verification_type: string` - - `consent_type: optional string or null` + The type of verification the evidence was submitted for. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -120875,10 +123480,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `entity_id: optional string or null` - - - `entity_type: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -120887,13 +123488,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "user_consent_revoked"` + - `type: optional "verification_evidence_submitted"` - default: user_consent_revoked + default: verification_evidence_submitted - - `ClaudeUserRoleUpdated object` + - `VerificationProgramApplicationCreated object` - A user's role within the organization was changed, or the user was added to or removed from the organization. + An organization applied to a verification program. - `actor: object or object or object or 8 more` @@ -121106,21 +123707,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `current_role: string or null` - - If null, then user was removed from the Organization - - - `previous_role: string or null` - - If null, then user was added to the Organization - - - `user_email: string` - - Email of the user whose role was changed - - - `user_id: string` + - `program_slug: string` - ID of the user whose role was changed + The verification program the organization applied to. - `id: optional string` @@ -121140,13 +123729,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_user_role_updated"` + - `type: optional "verification_program_application_created"` - default: claude_user_role_updated + default: verification_program_application_created - - `ClaudeUserSettingsUpdated object` + - `WorkspaceMemberSpendLimitCreated object` - User updated their personal settings. + A per-member or workspace-default Claude Code spend limit was created. - `actor: object or object or object or 8 more` @@ -121359,258 +123948,267 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `updates: array of object or object or object or 19 more` + - `id: optional string` - - `FullName object` + Unique identifier for the activity e.g. 'activity_abcd1234' - - `current_value: string or null` + - `account_id: optional string or null` - - `previous_value: string or null` + Tagged ID of the user (null for workspace-wide default). - - `type: optional "full_name"` + - `created_at: optional string` - default: full_name + When this activity occurred. - - `DisplayName object` + format: date-time - - `current_value: string or null` + - `limit_action: optional string or null` - - `previous_value: string or null` + The action taken when the limit is reached. - - `type: optional "display_name"` + - `limit_usd: optional number or null` - default: display_name + The spend limit threshold in USD cents. - - `ArtifactsEnabled object` + - `organization_id: optional string or null` - - `current_value: boolean or null` + Organization ID this activity is associated with - - `previous_value: boolean or null` + - `organization_uuid: optional string or null` - - `type: optional "artifacts_enabled"` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - default: artifacts_enabled + - `type: optional "workspace_member_spend_limit_created"` - - `LatexEnabled object` + default: workspace_member_spend_limit_created - - `current_value: boolean or null` + - `workspace_id: optional string or null` - - `previous_value: boolean or null` + Tagged ID of the workspace. - - `type: optional "latex_enabled"` + - `WorkspaceMemberSpendLimitDeleted object` - default: latex_enabled + A per-member or workspace-default Claude Code spend limit was deleted. - - `AnalysisToolEnabled object` + - `actor: object or object or object or 8 more` - - `current_value: boolean or null` + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `previous_value: boolean or null` + - `APIActor object` - - `type: optional "analysis_tool_enabled"` + - `api_key_id: string` - default: analysis_tool_enabled + - `ip_address: string` - - `ChatSuggestionsEnabled object` + - `user_agent: string` - - `current_value: boolean or null` + - `type: optional "api_actor"` - - `previous_value: boolean or null` + default: api_actor - - `type: optional "chat_suggestions_enabled"` + - `UserActor object` - default: chat_suggestions_enabled + - `email_address: string` - - `MultimodalPdfsEnabled object` + format: email - - `current_value: boolean or null` + - `ip_address: string` - - `previous_value: boolean or null` + - `user_agent: string` - - `type: optional "multimodal_pdfs_enabled"` + - `user_id: string` - default: multimodal_pdfs_enabled + - `type: optional "user_actor"` - - `GDriveEnabled object` + default: user_actor - - `current_value: boolean or null` + - `UnauthenticatedUserActor object` - - `previous_value: boolean or null` + - `ip_address: string` - - `type: optional "gdrive_enabled"` + - `user_agent: string` - default: gdrive_enabled + - `type: optional "unauthenticated_user_actor"` - - `WebSearchEnabled object` + default: unauthenticated_user_actor - The web search setting was changed. + - `unauthenticated_email_address: optional string or null` - - `current_value: boolean or null` + format: email - Setting value immediately after this change + - `AnthropicActor object` - - `previous_value: boolean or null` + - `email_address: optional string or null` - Setting value immediately before this change + format: email - - `type: optional "web_search_enabled"` + - `type: optional "anthropic_actor"` - default: web_search_enabled + default: anthropic_actor - - `GeolocationEnabled object` + - `SystemActor object` - The geolocation setting was changed. + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `current_value: boolean or null` + - `service: optional string or null` - Setting value immediately after this change + Name of the automated process that performed the action, when known. - - `previous_value: boolean or null` + - `type: optional "system_actor"` - Setting value immediately before this change + default: system_actor - - `type: optional "geolocation_enabled"` + - `AdminAPIKeyActor object` - default: geolocation_enabled + - `admin_api_key_id: string` - - `UserMemoryEnabledSetting object` + - `ip_address: string` - - `current_value: boolean or null` + - `user_agent: string` - - `previous_value: boolean or null` + - `type: optional "admin_api_key_actor"` - - `type: optional "enabled_saffron"` + default: admin_api_key_actor - default: enabled_saffron + - `ServiceAccountActor object` - - `McpToolsEnabled object` + - `ip_address: string` - - `current_value: map[boolean] or null` + - `service_account_id: string` - - `previous_value: map[boolean] or null` + - `user_agent: string` - - `type: optional "mcp_tools_enabled"` + - `type: optional "service_account_actor"` - default: mcp_tools_enabled + default: service_account_actor - - `CliOpPermissionsEnabled object` + - `ScimDirectorySyncActor object` - - `current_value: map[string] or null` + - `directory_id: string` - - `previous_value: map[string] or null` + - `workos_event_id: string` - - `type: optional "cli_op_permissions_enabled"` + - `idp_connection_type: optional string or null` - default: cli_op_permissions_enabled + - `type: optional "scim_directory_sync_actor"` - - `GoogleDriveSearchEnabled object` + default: scim_directory_sync_actor - - `current_value: boolean or null` + - `FederatedIdentityActor object` - - `previous_value: boolean or null` + A federated external workload authenticated via a verified OIDC token. - - `type: optional "google_drive_search_enabled"` + Carries the verified issuer, subject, and audience claims from the + presented JWT. - default: google_drive_search_enabled + - `issuer: string` - - `GmailIntegrationEnabled object` + - `subject: string` - - `current_value: boolean or null` + - `audience: optional array of string` - - `previous_value: boolean or null` + - `ip_address: optional string or null` - - `type: optional "gmail_integration_enabled"` + - `type: optional "federated_identity_actor"` - default: gmail_integration_enabled + default: federated_identity_actor - - `GoogleCalendarIntegrationEnabled object` + - `user_agent: optional string or null` - - `current_value: boolean or null` + - `FederatedActor object` - - `previous_value: boolean or null` + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. - - `type: optional "google_calendar_integration_enabled"` + - `provider: object or object or object or object` - default: google_calendar_integration_enabled + Asserting party: the AWS account the organization is bound to. - - `ThinkingModeEnabled object` + - `FederatedActorAwsProvider object` - - `current_value: "adaptive" or "extended" or "off" or null` + Asserting party: the AWS account the organization is bound to. - - `"adaptive"` + - `account_id: string` - - `"extended"` + - `signed_principal: string` - - `"off"` + The AWS-signed ARN of the IAM principal that requested the token. - - `previous_value: "adaptive" or "extended" or "off" or null` + - `type: optional "aws"` - - `"adaptive"` + default: aws - - `"extended"` + - `FederatedActorAzureProvider object` - - `"off"` + Asserting party: the Azure subscription the organization is bound to. - - `type: optional "thinking_mode_enabled"` + - `subscription_id: string` - default: thinking_mode_enabled + - `type: optional "azure"` - - `ResearchModeEnabled object` + default: azure - - `current_value: boolean or null` + - `FederatedActorGcpProvider object` - - `previous_value: boolean or null` + Asserting party: the GCP project the organization is bound to. - - `type: optional "research_mode_enabled"` + - `project_number: string` - default: research_mode_enabled + - `type: optional "gcp"` - - `ComputerUseEnabled object` + default: gcp - - `current_value: boolean or null` + - `FederatedActorOidcProvider object` - - `previous_value: boolean or null` + Asserting party: a customer-registered OIDC federation issuer. - - `type: optional "computer_use_enabled"` + - `issuer: optional string or null` - default: computer_use_enabled + The federation issuer's URL. Null when the presented credential failed verification. - - `ClaudeAPIInArtifactsEnabled object` + - `type: optional "oidc"` - The Claude API in Artifacts setting was changed. + default: oidc - - `current_value: boolean or null` + - `ip_address: optional string or null` - Setting value immediately after this change + - `subject: optional string or null` - - `previous_value: boolean or null` + The provider's verified identifier for the caller; its form depends on the provider. - Setting value immediately before this change + - `type: optional "federated_actor"` - - `type: optional "claude_api_in_artifacts_enabled"` + default: federated_actor - default: claude_api_in_artifacts_enabled + - `user_agent: optional string or null` - - `ConversationPreferences object` + - `AttestedDeviceActor object` - The 'conversation_preferences' for the user were updated. Values omitted. + An attested mobile device authenticated via Apple App Attest. - - `type: optional "conversation_preferences"` + - `external_client_id: string` - default: conversation_preferences + - `kid_hash: string` - - `CoworkGlobalInstructions object` + - `ip_address: optional string or null` - The Cowork global instructions were updated. Values omitted. + - `type: optional "attested_device_actor"` - - `type: optional "cowork_global_instructions"` + default: attested_device_actor - default: cowork_global_instructions + - `user_agent: optional string or null` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `account_id: optional string or null` + + Tagged ID of the user (null for workspace-wide default). + - `created_at: optional string` When this activity occurred. @@ -121625,13 +124223,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_user_settings_updated"` + - `spend_limit_id: optional string or null` - default: claude_user_settings_updated + UUID of the deleted spend limit. - - `VerificationEvidenceSubmitted object` + - `type: optional "workspace_member_spend_limit_deleted"` - Verification evidence was submitted for an organization's verification. + default: workspace_member_spend_limit_deleted + + - `workspace_id: optional string or null` + + Tagged ID of the workspace. + + - `WorkspaceMemberSpendLimitUpdated object` + + A per-member Claude Code spend limit amount was updated. - `actor: object or object or object or 8 more` @@ -121844,24 +124450,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `verification_id: string` - - Tagged ID of the verification the evidence was submitted for. - - - `verification_type: string` - - The type of verification the evidence was submitted for. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `account_id: optional string or null` + + Tagged ID of the user (null for workspace-wide default). + - `created_at: optional string` When this activity occurred. format: date-time + - `new_limit_usd: optional number or null` + + The new spend limit threshold in USD cents. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -121870,13 +124476,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "verification_evidence_submitted"` + - `spend_limit_id: optional string or null` - default: verification_evidence_submitted + UUID of the spend limit. - - `VerificationProgramApplicationCreated object` + - `type: optional "workspace_member_spend_limit_updated"` - An organization applied to a verification program. + default: workspace_member_spend_limit_updated + + - `workspace_id: optional string or null` + + Tagged ID of the workspace. + + - `WorkspaceSpendLimitAlertEmailsUpdated object` + + Spend limit alert email recipients were updated for a workspace. - `actor: object or object or object or 8 more` @@ -122089,14 +124703,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `program_slug: string` - - The verification program the organization applied to. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `alert_emails: optional array of string or null` + + Updated list of alert email addresses. + - `created_at: optional string` When this activity occurred. @@ -122111,13 +124725,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "verification_program_application_created"` + - `type: optional "workspace_spend_limit_alert_emails_updated"` - default: verification_program_application_created + default: workspace_spend_limit_alert_emails_updated - - `WorkspaceMemberSpendLimitCreated object` + - `workspace_id: optional string or null` - A per-member or workspace-default Claude Code spend limit was created. + Tagged ID of the workspace. + + - `WorkspaceSpendLimitCreated object` + + A workspace-level API spend limit was created. - `actor: object or object or object or 8 more` @@ -122334,10 +124952,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `account_id: optional string or null` - - Tagged ID of the user (null for workspace-wide default). - - `created_at: optional string` When this activity occurred. @@ -122346,7 +124960,7 @@ compliance activities that can be filtered by various criteria. - `limit_action: optional string or null` - The action taken when the limit is reached. + The action taken when the limit is reached (notify_only or notify_and_pause). - `limit_usd: optional number or null` @@ -122360,17 +124974,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "workspace_member_spend_limit_created"` + - `type: optional "workspace_spend_limit_created"` - default: workspace_member_spend_limit_created + default: workspace_spend_limit_created - `workspace_id: optional string or null` Tagged ID of the workspace. - - `WorkspaceMemberSpendLimitDeleted object` + - `WorkspaceSpendLimitDeleted object` - A per-member or workspace-default Claude Code spend limit was deleted. + A workspace-level API spend limit was deleted. - `actor: object or object or object or 8 more` @@ -122587,10 +125201,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `account_id: optional string or null` - - Tagged ID of the user (null for workspace-wide default). - - `created_at: optional string` When this activity occurred. @@ -122609,270 +125219,67 @@ compliance activities that can be filtered by various criteria. UUID of the deleted spend limit. - - `type: optional "workspace_member_spend_limit_deleted"` + - `type: optional "workspace_spend_limit_deleted"` - default: workspace_member_spend_limit_deleted + default: workspace_spend_limit_deleted - `workspace_id: optional string or null` Tagged ID of the workspace. - - `WorkspaceMemberSpendLimitUpdated object` - - A per-member Claude Code spend limit amount was updated. - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp - - - `FederatedActorOidcProvider object` - - Asserting party: a customer-registered OIDC federation issuer. - - - `issuer: optional string or null` - - The federation issuer's URL. Null when the presented credential failed verification. - - - `type: optional "oidc"` - - default: oidc - - - `ip_address: optional string or null` - - - `subject: optional string or null` - - The provider's verified identifier for the caller; its form depends on the provider. - - - `type: optional "federated_actor"` - - default: federated_actor - - - `user_agent: optional string or null` - - - `AttestedDeviceActor object` - - An attested mobile device authenticated via Apple App Attest. - - - `external_client_id: string` - - - `kid_hash: string` - - - `ip_address: optional string or null` - - - `type: optional "attested_device_actor"` - - default: attested_device_actor - - - `user_agent: optional string or null` - - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `account_id: optional string or null` - - Tagged ID of the user (null for workspace-wide default). - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `new_limit_usd: optional number or null` +- `first_id: optional string or null` - The new spend limit threshold in USD cents. +- `has_more: optional boolean` - - `organization_id: optional string or null` + default: false - Organization ID this activity is associated with +- `last_id: optional string or null` - - `organization_uuid: optional string or null` +### Example - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). +```bash +curl https://api.anthropic.com/v1/compliance/activities \ + -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" +``` - - `spend_limit_id: optional string or null` +#### Response (200) - UUID of the spend limit. +```json +{ + "data": [ + { + "actor": { + "api_key_id": "api_key_id", + "ip_address": "ip_address", + "user_agent": "user_agent", + "type": "api_actor" + }, + "decision": "blocked", + "id": "id", + "abuse_session_id": "abuse_session_id", + "created_at": "2019-12-27T18:11:19.117Z", + "organization_id": "organization_id", + "organization_uuid": "organization_uuid", + "type": "abuse_decision_received" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` - - `type: optional "workspace_member_spend_limit_updated"` +## Domain types - default: workspace_member_spend_limit_updated +### Activity List Response - - `workspace_id: optional string or null` +- `ActivityListResponse = object or object or object or 480 more` - Tagged ID of the workspace. + An external anti-abuse service reported a consequential decision about a sign-in or sign-up attempt. - - `WorkspaceSpendLimitAlertEmailsUpdated object` + - `AbuseDecisionReceived object` - Spend limit alert email recipients were updated for a workspace. + An external anti-abuse service reported a consequential decision about a sign-in or sign-up attempt. - `actor: object or object or object or 8 more` @@ -123085,13 +125492,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `decision: "blocked" or "unspecified"` + + The decision applied to the session. + + - `"blocked"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `alert_emails: optional array of string or null` + - `abuse_session_id: optional string or null` - Updated list of alert email addresses. + The anti-abuse service's opaque session identifier for correlation. - `created_at: optional string` @@ -123107,17 +125522,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "workspace_spend_limit_alert_emails_updated"` - - default: workspace_spend_limit_alert_emails_updated - - - `workspace_id: optional string or null` + - `type: optional "abuse_decision_received"` - Tagged ID of the workspace. + default: abuse_decision_received - - `WorkspaceSpendLimitCreated object` + - `AccountDeleted object` - A workspace-level API spend limit was created. + User-initiated self-service account deletion. - `actor: object or object or object or 8 more` @@ -123340,14 +125751,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `limit_action: optional string or null` - - The action taken when the limit is reached (notify_only or notify_and_pause). - - - `limit_usd: optional number or null` - - The spend limit threshold in USD cents. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -123356,17 +125759,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "workspace_spend_limit_created"` - - default: workspace_spend_limit_created - - - `workspace_id: optional string or null` + - `type: optional "account_deleted"` - Tagged ID of the workspace. + default: account_deleted - - `WorkspaceSpendLimitDeleted object` + - `AdminAPIKeyCreated object` - A workspace-level API spend limit was deleted. + An admin API key was created. - `actor: object or object or object or 8 more` @@ -123579,6 +125978,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `admin_api_key_id: string` + + Tagged ID of the created admin API key + + - `scopes: array of string` + + Scopes granted to the key (empty for legacy non-scoped admin keys) + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -123597,71 +126004,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - UUID of the deleted spend limit. - - - `type: optional "workspace_spend_limit_deleted"` - - default: workspace_spend_limit_deleted - - - `workspace_id: optional string or null` - - Tagged ID of the workspace. - -- `first_id: optional string or null` - -- `has_more: optional boolean` - - default: false - -- `last_id: optional string or null` - -### Example - -```bash -curl https://api.anthropic.com/v1/compliance/activities \ - -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" -``` - -#### Response (200) - -```json -{ - "data": [ - { - "actor": { - "api_key_id": "api_key_id", - "ip_address": "ip_address", - "user_agent": "user_agent", - "type": "api_actor" - }, - "decision": "blocked", - "id": "id", - "abuse_session_id": "abuse_session_id", - "created_at": "2019-12-27T18:11:19.117Z", - "organization_id": "organization_id", - "organization_uuid": "organization_uuid", - "type": "abuse_decision_received" - } - ], - "first_id": "first_id", - "has_more": true, - "last_id": "last_id" -} -``` - -## Domain types - -### Activity List Response - -- `ActivityListResponse = object or object or object or 474 more` + - `type: optional "admin_api_key_created"` - An external anti-abuse service reported a consequential decision about a sign-in or sign-up attempt. + default: admin_api_key_created - - `AbuseDecisionReceived object` + - `AdminAPIKeyDeleted object` - An external anti-abuse service reported a consequential decision about a sign-in or sign-up attempt. + An admin API key was deleted. - `actor: object or object or object or 8 more` @@ -123874,22 +126223,14 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `decision: "blocked" or "unspecified"` - - The decision applied to the session. - - - `"blocked"` + - `admin_api_key_id: string` - - `"unspecified"` + Tagged ID of the deleted admin API key - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `abuse_session_id: optional string or null` - - The anti-abuse service's opaque session identifier for correlation. - - `created_at: optional string` When this activity occurred. @@ -123904,13 +126245,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "abuse_decision_received"` + - `type: optional "admin_api_key_deleted"` - default: abuse_decision_received + default: admin_api_key_deleted - - `AccountDeleted object` + - `AdminAPIKeyUpdated object` - User-initiated self-service account deletion. + An admin API key was updated (renamed or activated/deactivated). - `actor: object or object or object or 8 more` @@ -124123,6 +126464,22 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` + - `admin_api_key_id: string` + + Tagged ID of the updated admin API key + + - `updates: array of object` + + - `current_value: string` + + - `previous_value: string` + + - `type: "name" or "status"` + + - `"name"` + + - `"status"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -124141,13 +126498,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "account_deleted"` + - `type: optional "admin_api_key_updated"` - default: account_deleted + default: admin_api_key_updated - - `AdminAPIKeyCreated object` + - `AdminConnectorRequestResolved object` - An admin API key was created. + Admin approved or dismissed pending member requests to enable an MCP connector. - `actor: object or object or object or 8 more` @@ -124360,13 +126717,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `admin_api_key_id: string` + - `decision: "approved" or "dismissed" or "unspecified"` - Tagged ID of the created admin API key + - `"approved"` - - `scopes: array of string` + - `"dismissed"` - Scopes granted to the key (empty for legacy non-scoped admin keys) + - `"unspecified"` + + - `mcp_server_id: string` + + - `resolved_count: number` - `id: optional string` @@ -124386,13 +126747,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "admin_api_key_created"` + - `type: optional "admin_connector_request_resolved"` - default: admin_api_key_created + default: admin_connector_request_resolved - - `AdminAPIKeyDeleted object` + - `AdminRequestCreated object` - An admin API key was deleted. + Admin request created by an org member (seat upgrade, limit increase, join org, end-user invite). - `actor: object or object or object or 8 more` @@ -124605,9 +126966,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `admin_api_key_id: string` - - Tagged ID of the deleted admin API key + - `request_type: string` - `id: optional string` @@ -124627,13 +126986,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "admin_api_key_deleted"` + - `type: optional "admin_request_created"` - default: admin_api_key_deleted + default: admin_request_created - - `AdminAPIKeyUpdated object` + - `AgeVerified object` - An admin API key was updated (renamed or activated/deactivated). + User age was verified. - `actor: object or object or object or 8 more` @@ -124846,22 +127205,6 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `admin_api_key_id: string` - - Tagged ID of the updated admin API key - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "name" or "status"` - - - `"name"` - - - `"status"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -124880,13 +127223,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "admin_api_key_updated"` + - `type: optional "age_verified"` - default: admin_api_key_updated + default: age_verified - - `AdminConnectorRequestResolved object` + - `AnonymousMobileLoginAttempted object` - Admin approved or dismissed pending member requests to enable an MCP connector. + Anonymous mobile login was attempted. - `actor: object or object or object or 8 more` @@ -125099,18 +127442,6 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `decision: "approved" or "dismissed" or "unspecified"` - - - `"approved"` - - - `"dismissed"` - - - `"unspecified"` - - - `mcp_server_id: string` - - - `resolved_count: number` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -125129,13 +127460,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "admin_connector_request_resolved"` + - `type: optional "anonymous_mobile_login_attempted"` - default: admin_connector_request_resolved + default: anonymous_mobile_login_attempted - - `AdminRequestCreated object` + - `APIKeyCreated object` - Admin request created by an org member (seat upgrade, limit increase, join org, end-user invite). + Activity logged when a new API key is created. - `actor: object or object or object or 8 more` @@ -125348,7 +127679,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `request_type: string` + - `api_key_id: string` + + The tagged ID of the created API key + + - `scopes: array of string` + + The scopes for this API key - `id: optional string` @@ -125368,13 +127705,19 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "admin_request_created"` + - `restricted_to_organization: optional boolean` - default: admin_request_created + Whether the key was restricted to the creating organization, rather than granted access across the whole parent organization - - `AgeVerified object` + default: false - User age was verified. + - `type: optional "api_key_created"` + + default: api_key_created + + - `ClaudeArtifactAccessFailed object` + + An attempt to access an artifact failed. - `actor: object or object or object or 8 more` @@ -125591,6 +127934,14 @@ curl https://api.anthropic.com/v1/compliance/activities \ Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_artifact_id: optional string or null` + + The artifact's identifier, when known. + + - `claude_artifact_version_id: optional string or null` + + The version of the artifact the user attempted to access, when known. + - `created_at: optional string` When this activity occurred. @@ -125605,13 +127956,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "age_verified"` + - `reason: optional string or null` - default: age_verified + The reason access was denied, when recorded. - - `AnonymousMobileLoginAttempted object` + - `type: optional "claude_artifact_access_failed"` - Anonymous mobile login was attempted. + default: claude_artifact_access_failed + + - `ClaudeArtifactCommented object` + + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. - `actor: object or object or object or 8 more` @@ -125824,254 +128179,47 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `organization_id: optional string or null` - - Organization ID this activity is associated with - - - `organization_uuid: optional string or null` - - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - - `type: optional "anonymous_mobile_login_attempted"` - - default: anonymous_mobile_login_attempted - - - `APIKeyCreated object` - - Activity logged when a new API key is created. - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp + - `claude_artifact_id: string` - - `FederatedActorOidcProvider object` + The artifact's identifier. - Asserting party: a customer-registered OIDC federation issuer. + - `comment_action: "activate_thread" or "create_thread" or "deactivate_thread" or 6 more` - - `issuer: optional string or null` + The action recorded: for example a new comment thread, a reply to an existing thread, a thread resolved, reopened, or deleted, a thread's Claude activation granted or revoked, or a comment's text rewritten by its author. - The federation issuer's URL. Null when the presented credential failed verification. + - `"activate_thread"` - - `type: optional "oidc"` + - `"create_thread"` - default: oidc + - `"deactivate_thread"` - - `ip_address: optional string or null` + - `"delete_thread"` - - `subject: optional string or null` - - The provider's verified identifier for the caller; its form depends on the provider. - - - `type: optional "federated_actor"` + - `"edit_comment"` - default: federated_actor + - `"reopen"` - - `user_agent: optional string or null` + - `"reply"` - - `AttestedDeviceActor object` + - `"resolve"` - An attested mobile device authenticated via Apple App Attest. - - - `external_client_id: string` - - - `kid_hash: string` - - - `ip_address: optional string or null` + - `"unspecified"` - - `type: optional "attested_device_actor"` + - `id: optional string` - default: attested_device_actor + Unique identifier for the activity e.g. 'activity_abcd1234' - - `user_agent: optional string or null` + - `claude_artifact_comment_id: optional string or null` - - `api_key_id: string` + The comment's identifier. Present when the activity relates to a specific comment, for example a new comment or an author's edit of one; absent for thread-level actions performed without a comment, such as resolve, reopen, deletion, or an activation change. - The tagged ID of the created API key + - `claude_artifact_comment_thread_id: optional string or null` - - `scopes: array of string` + The comment thread's identifier. - The scopes for this API key - - - `id: optional string` + - `claude_artifact_version_id: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The artifact version the comment activity applied to, when known. - `created_at: optional string` @@ -126087,19 +128235,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `restricted_to_organization: optional boolean` - - Whether the key was restricted to the creating organization, rather than granted access across the whole parent organization - - default: false - - - `type: optional "api_key_created"` + - `type: optional "claude_artifact_commented"` - default: api_key_created + default: claude_artifact_commented - - `ClaudeArtifactAccessFailed object` + - `ClaudeArtifactCommentsViewed object` - An attempt to access an artifact failed. + An artifact's comments were viewed. - `actor: object or object or object or 8 more` @@ -126312,17 +128454,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `id: optional string` + - `claude_artifact_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The artifact's identifier. - - `claude_artifact_id: optional string or null` + - `id: optional string` - The artifact's identifier, when known. + Unique identifier for the activity e.g. 'activity_abcd1234' - `claude_artifact_version_id: optional string or null` - The version of the artifact the user attempted to access, when known. + The version of the artifact whose comments were served, when known. - `created_at: optional string` @@ -126338,13 +128480,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reason: optional string or null` - - The reason access was denied, when recorded. - - - `type: optional "claude_artifact_access_failed"` + - `type: optional "claude_artifact_comments_viewed"` - default: claude_artifact_access_failed + default: claude_artifact_comments_viewed - `ClaudeArtifactCreated object` @@ -128620,7 +130758,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `guest_policy: optional string or null` - Whether the agent responds in Slack channels that include guest users: "allow", "restrict", or "channel" (the agent responds, using only that channel's own content and configuration). Omitted when the agent inherits the default policy. + Whether the agent responds in Slack channels that include guest users, and in Slack Connect channels shared with other organizations: "allow", "restrict", or "channel" (the agent responds, using only that channel's own content and configuration). In Slack Connect channels "allow" gives at most "channel" access. Omitted when the agent inherits the default policy. - `organization_id: optional string or null` @@ -134621,7 +136759,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `guest_policy: optional string or null` - The agent's guest-user response policy after the update: "allow", "restrict", "channel" (the agent responds, using only that channel's own content and configuration), or "default" when the update removed the agent-specific policy so the agent inherits the surrounding default. Present only when the update changed it. + The agent's response policy for Slack channels that include guest users and Slack Connect channels shared with other organizations, after the update: "allow", "restrict", "channel" (the agent responds, using only that channel's own content and configuration), or "default" when the update removed the agent-specific policy so the agent inherits the surrounding default. In Slack Connect channels "allow" gives at most "channel" access. Present only when the update changed it. - `organization_id: optional string or null` @@ -143115,7 +145253,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience. - - `action: "archived" or "created" or "migrated" or 2 more` + - `action: "archived" or "created" or "migrated" or 3 more` The state change applied to the scan project. @@ -143125,6 +145263,8 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"migrated"` + - `"resumed"` + - `"unarchived"` - `"unspecified"` @@ -143623,9 +145763,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `ClaudeCodeSecurityScanRunUpdated object` - A single Claude Code Security scan run was archived or unarchived. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. - - `action: "archived" or "created" or "migrated" or 2 more` + - `action: "archived" or "created" or "migrated" or 3 more` The state change applied to the scan run @@ -143635,6 +145775,8 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"migrated"` + - `"resumed"` + - `"unarchived"` - `"unspecified"` @@ -143852,7 +145994,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `scan_id: string` - Tagged ID of the scan the request named — any scan in the archived run, not necessarily its canonical (run_index=0) scan + Tagged ID of the scan the request named — for archive/unarchive any scan in the run, not necessarily its canonical (run_index=0) scan; for resume, the paused scan - `id: optional string` @@ -147711,6 +149853,253 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: claude_code_user_settings_updated + - `ClaudeEnterpriseUpgradeCreditUpdated object` + + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. + + - `action: "cancelled" or "resumed" or "unspecified"` + + Whether the credit was cancelled or turned back on + + - `"cancelled"` + + - `"resumed"` + + - `"unspecified"` + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "claude_enterprise_upgrade_credit_updated"` + + default: claude_enterprise_upgrade_credit_updated + - `ClaudeFileAccessFailed object` A user was denied access to a file in Claude.ai. @@ -150695,7 +153084,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `request_id: string` - - `request_method: "DELETE" or "GET" or "POST" or "PUT"` + Identifier of the request, as returned in the response's request-id header + + - `request_method: "DELETE" or "GET" or "POST" or 2 more` + + HTTP method of the request - `"DELETE"` @@ -150705,12 +153098,16 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"PUT"` + - `"unspecified"` + - `status_code: number` HTTP status code - `url: string` + Full URL that was requested, including any query string + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -166660,6 +169057,10 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `token_vault_connect_mode: optional string or null` + + How a token vault credential sign-in was completed: "authorization_server" for a sign-in at an administrator-provided authorization server, or "mcp_server" for a sign-in at a tool server the organization has not registered as a connector. + - `type: optional "integration_user_connected"` default: integration_user_connected @@ -169046,11 +171447,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Unique identifier for the activity e.g. 'activity_abcd1234' - - `auth_method: optional "magic_link"` + - `auth_method: optional "magic_link" or "unspecified" or null` The method the user used to authenticate. May be absent on activities recorded before this field was introduced. - default: magic_link + - `"magic_link"` + + - `"unspecified"` - `created_at: optional string` @@ -169058,10 +171461,14 @@ curl https://api.anthropic.com/v1/compliance/activities \ format: date-time - - `mfa_method: optional "not_used" or null` + - `mfa_method: optional "not_used" or "unspecified" or null` The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. + - `"not_used"` + + - `"unspecified"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -194817,7 +197224,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `OrgWorkAcrossAppsDisabled object` - Organization Work Across Apps was disabled. + The organization's "Let Claude work across apps" setting was turned off. - `actor: object or object or object or 8 more` @@ -195062,7 +197469,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `OrgWorkAcrossAppsEnabled object` - Organization Work Across Apps was enabled. + The organization's "Let Claude work across apps" setting was turned on. - `actor: object or object or object or 8 more` @@ -196249,15 +198656,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `updates: array of object or object or object or 84 more` - - `OrganizationName object` + - `Name object` The organization name setting was changed. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change @@ -196265,15 +198672,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: name - - `OrganizationCapabilities object` + - `Capabilities object` The organization capabilities setting was changed. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -196281,15 +198688,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: capabilities - - `OrganizationRedactContent object` + - `RedactContent object` The organization content-redaction setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196301,11 +198708,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The public projects setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196317,11 +198724,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The web search setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196333,11 +198740,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The geolocation setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196345,15 +198752,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: geolocation_enabled - - `OrgMemoryEnabledSetting object` + - `EnabledSaffron object` The memory setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196365,7 +198772,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ The data retention periods setting was changed for the organization. - - `current_value: array of object or null` + - `current_value: optional array of object or null` Setting value immediately after this change @@ -196393,7 +198800,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"month"` - - `previous_value: array of object or null` + - `previous_value: optional array of object or null` Setting value immediately before this change @@ -196429,11 +198836,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The members limit setting was changed for the organization. - - `current_value: number or null` + - `current_value: optional number or null` Setting value immediately after this change - - `previous_value: number or null` + - `previous_value: optional number or null` Setting value immediately before this change @@ -196445,11 +198852,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude API in Artifacts setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196461,7 +198868,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ The support contact routing mode setting was changed for the organization. - - `current_value: "ai_support_only" or "human_support_restricted" or null` + - `current_value: optional "ai_support_only" or "human_support_restricted" or "unspecified" or null` Setting value immediately after this change @@ -196469,7 +198876,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"human_support_restricted"` - - `previous_value: "ai_support_only" or "human_support_restricted" or null` + - `"unspecified"` + + - `previous_value: optional "ai_support_only" or "human_support_restricted" or "unspecified" or null` Setting value immediately before this change @@ -196477,6 +198886,8 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"human_support_restricted"` + - `"unspecified"` + - `type: optional "support_contact_mode"` default: support_contact_mode @@ -196485,11 +198896,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The support contact always-include-admins-owners setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196501,11 +198912,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The support contact designated groups setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -196517,11 +198928,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The organization's subscription seat quotas were changed. - - `current_value: map[number] or null` + - `current_value: optional map[number] or null` Seat-type to quantity mapping immediately after this change. A null quantity means the item is unlimited/unmetered. - - `previous_value: map[number] or null` + - `previous_value: optional map[number] or null` Seat-type to quantity mapping immediately before this change. A null quantity means the item was unlimited/unmetered. @@ -196533,7 +198944,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ All organization members were assigned the specified seat tier. - - `current_value: string or null` + - `current_value: optional string or null` The seat tier every member was assigned to @@ -196553,11 +198964,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code on the web setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196569,11 +198980,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code Desktop bypass-permissions mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196585,11 +198996,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code Desktop auto-permissions mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196601,11 +199012,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai skills setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196617,11 +199028,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Workbench completion feedback setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196633,11 +199044,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai completion feedback setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196649,11 +199060,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai integration sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196665,11 +199076,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai chat sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196677,15 +199088,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: claude_ai_chat_sharing_enabled - - `ClaudeAiccrSharingEnabled object` + - `ClaudeAICcrSharingEnabled object` The Claude.ai remote Claude Code session sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196693,15 +199104,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: claude_ai_ccr_sharing_enabled - - `ClaudeAiccrSupportSharingEnabled object` + - `ClaudeAICcrSupportSharingEnabled object` The Anthropic support access setting for Claude Code sessions was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196713,7 +199124,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ The batches download UI visibility setting was changed for the organization. - - `current_value: "all" or "none" or "selected" or null` + - `current_value: optional "all" or "none" or "selected" or "unspecified" or null` Setting value immediately after this change @@ -196723,7 +199134,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"selected"` - - `previous_value: "all" or "none" or "selected" or null` + - `"unspecified"` + + - `previous_value: optional "all" or "none" or "selected" or "unspecified" or null` Setting value immediately before this change @@ -196733,6 +199146,8 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"selected"` + - `"unspecified"` + - `type: optional "batches_download_ui_visibility"` default: batches_download_ui_visibility @@ -196741,11 +199156,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The allowed invite domains setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -196753,11 +199168,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: allowed_invite_domains - - `WebSearchAPISettingsChanged object` + - `WebSearchAPISettings object` The web search API setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -196771,7 +199186,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `is_enabled: boolean` - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -196789,11 +199204,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: web_search_api_settings - - `WebFetchAPISettingsChanged object` + - `WebFetchAPISettings object` The web fetch API setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -196807,7 +199222,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `is_enabled: boolean` - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -196829,7 +199244,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ The default workspace setting was changed for the organization. - - `current_value: object or null` + - `current_value: optional object or null` Setting value immediately after this change @@ -196837,7 +199252,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: true - - `previous_value: object or null` + - `previous_value: optional object or null` Setting value immediately before this change @@ -196853,11 +199268,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The batches download UI enabled workspace IDs setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -196890,11 +199305,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ Tracks changes to the enterprise account session duration setting (in seconds). - - `current_value: number or null` + - `current_value: optional number or null` Setting value immediately after this change - - `previous_value: number or null` + - `previous_value: optional number or null` Setting value immediately before this change @@ -196906,7 +199321,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ Tracks changes to VCS (GitHub, etc.) organization connections. - - `current_value: array of object or null` + - `current_value: optional array of object or null` Setting value immediately after this change @@ -196920,7 +199335,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `org_id: optional string or null` - - `previous_value: array of object or null` + - `previous_value: optional array of object or null` Setting value immediately before this change @@ -196942,11 +199357,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ Tracks changes to which admin request types are disabled. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -196958,11 +199373,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The member usage dashboard visibility setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196974,11 +199389,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The code execution network egress setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -196990,11 +199405,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The code execution domain allowlist setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change @@ -197006,7 +199421,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ The code execution domain allowlist template setting was changed for the organization. - - `current_value: "custom" or "full_egress" or "package_managers" or null` + - `current_value: optional "custom" or "full_egress" or "package_managers" or "unspecified" or null` Setting value immediately after this change @@ -197016,7 +199431,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"package_managers"` - - `previous_value: "custom" or "full_egress" or "package_managers" or null` + - `"unspecified"` + + - `previous_value: optional "custom" or "full_egress" or "package_managers" or "unspecified" or null` Setting value immediately before this change @@ -197026,6 +199443,8 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"package_managers"` + - `"unspecified"` + - `type: optional "code_execution_domain_allowlist_template_changed"` default: code_execution_domain_allowlist_template_changed @@ -197034,11 +199453,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The chat setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197050,11 +199469,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code quick web setup setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197066,7 +199485,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code team memory mode setting was changed for the organization. - - `current_value: "all_org_members" or "github_repo" or "off" or "specific_groups" or null` + - `current_value: optional "all_org_members" or "github_repo" or "off" or 2 more or null` Setting value immediately after this change @@ -197078,7 +199497,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"specific_groups"` - - `previous_value: "all_org_members" or "github_repo" or "off" or "specific_groups" or null` + - `"unspecified"` + + - `previous_value: optional "all_org_members" or "github_repo" or "off" or 2 more or null` Setting value immediately before this change @@ -197090,19 +199511,21 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"specific_groups"` + - `"unspecified"` + - `type: optional "claude_code_team_memory_mode"` default: claude_code_team_memory_mode - - `BrowserExtensionSettingsUpdated object` + - `BrowserExtensionSettings object` The browser extension setting was changed for the organization. - - `current_value: map[unknown] or null` + - `current_value: optional map[unknown] or null` Setting value immediately after this change - - `previous_value: map[unknown] or null` + - `previous_value: optional map[unknown] or null` Setting value immediately before this change @@ -197110,15 +199533,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: browser_extension_settings - - `DesktopExtensionAllowlistEnabled object` + - `IsDesktopExtensionAllowlistEnabled object` The desktop extension allowlist setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197130,11 +199553,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The per-member self-serve data export setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197142,15 +199565,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: allow_member_data_export - - `ClaudeDesignEnabled object` + - `ClaudeAIDesignEnabled object` The Claude Design setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197162,11 +199585,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The setting that turns Claude Science on or off for the organization was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197178,11 +199601,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science memory setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197194,11 +199617,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science custom connectors setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197210,11 +199633,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science custom skills setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197226,11 +199649,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science setting that puts the network allowlist under the organization's management, instead of each member managing their own, was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197242,11 +199665,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science SSH hosts setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197258,11 +199681,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science setting that lets members connect Modal cloud compute was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197274,11 +199697,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science scientific model endpoints setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197290,11 +199713,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The hostnames on the organization's Claude Science network allowlist, which applies to members while the organization manages the allowlist, were changed. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list is saved (this change reset it), so Claude Science's built-in allowlist applies; an empty list means a list with no domains on it is saved. - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list was saved at that point (never saved, or since reset), so Claude Science's built-in allowlist applied; an empty list means a list with no domains on it had been saved. @@ -197306,11 +199729,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science Modal cloud compute workspace allowlist setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional array of string or null` Setting value immediately after this change: the Modal workspace names members can connect to. Null or an empty list means any workspace is allowed. - - `previous_value: array of string or null` + - `previous_value: optional array of string or null` Setting value immediately before this change: the Modal workspace names members could connect to. Null or an empty list means any workspace was allowed. @@ -197322,11 +199745,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science package mirror setting for the conda channel was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. @@ -197338,11 +199761,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Science package mirror setting for the Python package index was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. @@ -197350,15 +199773,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: claude_science_package_mirror_pip_index_changed - - `SkillPluginsScanningEnabled object` + - `ClaudeAISkillPluginsScanningEnabled object` The skill and plugin security scanning setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197370,11 +199793,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Artifact publishing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197386,11 +199809,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Artifact external sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197402,11 +199825,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Artifact presence setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197418,11 +199841,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai skill sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197434,11 +199857,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai organization-wide skill sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197450,11 +199873,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai group-based skill sharing setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197466,7 +199889,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai organization skill publish policy was changed for the organization. - - `current_value: "off" or "open" or "review" or null` + - `current_value: optional "off" or "open" or "review" or "unspecified" or null` Setting value immediately after this change @@ -197476,7 +199899,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"review"` - - `previous_value: "off" or "open" or "review" or null` + - `"unspecified"` + + - `previous_value: optional "off" or "open" or "review" or "unspecified" or null` Setting value immediately before this change @@ -197486,6 +199911,8 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `"review"` + - `"unspecified"` + - `type: optional "claude_ai_skill_publish_policy"` default: claude_ai_skill_publish_policy @@ -197494,11 +199921,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code remote control setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197510,11 +199937,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code remote control auto-enable default was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197526,11 +199953,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code routines setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197542,11 +199969,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code Workflows setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197558,11 +199985,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The frontier services data use setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197574,11 +200001,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The LTI course projects setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197590,11 +200017,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude.ai skill creation setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197606,11 +200033,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code GitHub analytics setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197622,11 +200049,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code hide managed environments setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197638,11 +200065,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code allow session pool moves setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197654,11 +200081,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code disable Anthropic compute setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197670,11 +200097,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code metrics logging setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197686,11 +200113,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code fast mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197702,11 +200129,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code trusted devices setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197718,11 +200145,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Cowork trusted devices enforcement setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197734,11 +200161,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The inline visualizations setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -197746,15 +200173,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: inline_visualizations_enabled - - `OrganizationBannerSettingsUpdated object` + - `OrganizationBannerSettings object` The organization banner setting was changed. - - `current_value: map[unknown] or null` + - `current_value: optional map[unknown] or null` Setting value immediately after this change - - `previous_value: map[unknown] or null` + - `previous_value: optional map[unknown] or null` Setting value immediately before this change @@ -197762,15 +200189,15 @@ curl https://api.anthropic.com/v1/compliance/activities \ default: organization_banner_settings - - `ClaudeInSlackSettingsUpdated object` + - `ClaudeInSlackSettings object` The Claude in Slack setting was changed for the organization. - - `current_value: map[unknown] or null` + - `current_value: optional map[unknown] or null` Setting value immediately after this change - - `previous_value: map[unknown] or null` + - `previous_value: optional map[unknown] or null` Setting value immediately before this change @@ -197782,11 +200209,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code default worker environment setting was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change @@ -197798,11 +200225,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude Code default worker pool setting was changed for the organization. - - `current_value: string or null` + - `current_value: optional string or null` Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional string or null` Setting value immediately before this change @@ -197814,11 +200241,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The managed agents setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -198539,22 +200966,745 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `invitee_email: string` - - Email address the share was created for. - - - `resource_id: string` - - Tagged ID of the resource being shared. - - - `resource_type: string` - - The type of resource being shared. - - - `role: string` - - The role that will be granted when the invitee joins the organization. - + - `invitee_email: string` + + Email address the share was created for. + + - `resource_id: string` + + Tagged ID of the resource being shared. + + - `resource_type: string` + + The type of resource being shared. + + - `role: string` + + The role that will be granted when the invitee joins the organization. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "pending_share_created"` + + default: pending_share_created + + - `PendingShareRevoked object` + + A pending share of a project or skill was revoked before the invitee joined the organization. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `invitee_email: string` + + Email address the share had been created for. + + - `resource_id: string` + + Tagged ID of the resource that was shared. + + - `resource_type: string` + + The type of resource that was shared. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "pending_share_revoked"` + + default: pending_share_revoked + + - `PhoneCodeSent object` + + User requested a phone verification code. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "phone_code_sent"` + + default: phone_code_sent + + - `PhoneCodeVerified object` + + User successfully verified their phone code. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -198573,13 +201723,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "pending_share_created"` + - `type: optional "phone_code_verified"` - default: pending_share_created + default: phone_code_verified - - `PendingShareRevoked object` + - `PlatformAgentArchived object` - A pending share of a project or skill was revoked before the invitee joined the organization. + An agent was archived on the API platform. - `actor: object or object or object or 8 more` @@ -198792,17 +201942,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `invitee_email: string` - - Email address the share had been created for. - - - `resource_id: string` - - Tagged ID of the resource that was shared. - - - `resource_type: string` + - `agent_id: string` - The type of resource that was shared. + The agent that was archived, e.g. "agent_01HX...". - `id: optional string` @@ -198822,13 +201964,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "pending_share_revoked"` + - `type: optional "platform_agent_archived"` - default: pending_share_revoked + default: platform_agent_archived - - `PhoneCodeSent object` + - `workspace_id: optional string or null` - User requested a phone verification code. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentCreated object` + + An agent was created on the API platform. - `actor: object or object or object or 8 more` @@ -199041,6 +202187,10 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` + - `agent_id: string` + + The agent that was created, e.g. "agent_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -199059,13 +202209,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "phone_code_sent"` + - `type: optional "platform_agent_created"` - default: phone_code_sent + default: platform_agent_created - - `PhoneCodeVerified object` + - `workspace_id: optional string or null` - User successfully verified their phone code. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeleted object` + + An agent was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -199278,6 +202432,10 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` + - `agent_id: string` + + The agent that was deleted, e.g. "agent_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -199296,13 +202454,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "phone_code_verified"` + - `type: optional "platform_agent_deleted"` - default: phone_code_verified + default: platform_agent_deleted - - `PlatformAgentArchived object` + - `workspace_id: optional string or null` - An agent was archived on the API platform. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeploymentArchived object` + + An agent deployment was archived on the API platform. - `actor: object or object or object or 8 more` @@ -199515,9 +202677,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was archived, e.g. "agent_01HX...". + The agent deployment that was archived, e.g. "depl_01HX...". - `id: optional string` @@ -199537,17 +202699,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_archived"` + - `type: optional "platform_agent_deployment_archived"` - default: platform_agent_archived + default: platform_agent_deployment_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentCreated object` + - `PlatformAgentDeploymentCreated object` - An agent was created on the API platform. + An agent deployment was created on the API platform. - `actor: object or object or object or 8 more` @@ -199760,9 +202922,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was created, e.g. "agent_01HX...". + The agent deployment that was created, e.g. "depl_01HX...". - `id: optional string` @@ -199782,17 +202944,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_created"` + - `type: optional "platform_agent_deployment_created"` - default: platform_agent_created + default: platform_agent_deployment_created - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeleted object` + - `PlatformAgentDeploymentDeleted object` - An agent was deleted from the API platform. + An agent deployment was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -200005,9 +203167,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was deleted, e.g. "agent_01HX...". + The agent deployment that was deleted, e.g. "depl_01HX...". - `id: optional string` @@ -200027,17 +203189,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deleted"` + - `type: optional "platform_agent_deployment_deleted"` - default: platform_agent_deleted + default: platform_agent_deployment_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentArchived object` + - `PlatformAgentDeploymentPaused object` - An agent deployment was archived on the API platform. + An agent deployment was paused on the API platform. - `actor: object or object or object or 8 more` @@ -200252,7 +203414,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `deployment_id: string` - The agent deployment that was archived, e.g. "depl_01HX...". + The agent deployment that was paused, e.g. "depl_01HX...". - `id: optional string` @@ -200272,17 +203434,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_archived"` + - `type: optional "platform_agent_deployment_paused"` - default: platform_agent_deployment_archived + default: platform_agent_deployment_paused - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentCreated object` + - `PlatformAgentDeploymentRunTriggered object` - An agent deployment was created on the API platform. + An agent deployment was run on demand on the API platform. - `actor: object or object or object or 8 more` @@ -200497,7 +203659,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `deployment_id: string` - The agent deployment that was created, e.g. "depl_01HX...". + The agent deployment that was run, e.g. "depl_01HX...". - `id: optional string` @@ -200517,17 +203679,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_created"` + - `type: optional "platform_agent_deployment_run_triggered"` - default: platform_agent_deployment_created + default: platform_agent_deployment_run_triggered - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentDeleted object` + - `PlatformAgentDeploymentUnpaused object` - An agent deployment was deleted from the API platform. + An agent deployment was resumed on the API platform. - `actor: object or object or object or 8 more` @@ -200742,7 +203904,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `deployment_id: string` - The agent deployment that was deleted, e.g. "depl_01HX...". + The agent deployment that was resumed, e.g. "depl_01HX...". - `id: optional string` @@ -200762,17 +203924,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_deleted"` + - `type: optional "platform_agent_deployment_unpaused"` - default: platform_agent_deployment_deleted + default: platform_agent_deployment_unpaused - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentPaused object` + - `PlatformAgentDeploymentUpdated object` - An agent deployment was paused on the API platform. + An agent deployment was updated on the API platform. - `actor: object or object or object or 8 more` @@ -200987,7 +204149,7 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `deployment_id: string` - The agent deployment that was paused, e.g. "depl_01HX...". + The agent deployment that was updated, e.g. "depl_01HX...". - `id: optional string` @@ -201007,17 +204169,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_paused"` + - `type: optional "platform_agent_deployment_updated"` - default: platform_agent_deployment_paused + default: platform_agent_deployment_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentRunTriggered object` + - `PlatformAgentSessionArchived object` - An agent deployment was run on demand on the API platform. + An agent session was archived on the API platform. - `actor: object or object or object or 8 more` @@ -201230,9 +204392,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was run, e.g. "depl_01HX...". + The agent session that was archived, e.g. "session_01HX...". - `id: optional string` @@ -201252,17 +204414,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_run_triggered"` + - `type: optional "platform_agent_session_archived"` - default: platform_agent_deployment_run_triggered + default: platform_agent_session_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentUnpaused object` + - `PlatformAgentSessionCreated object` - An agent deployment was resumed on the API platform. + An agent session was created on the API platform. - `actor: object or object or object or 8 more` @@ -201475,9 +204637,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was resumed, e.g. "depl_01HX...". + The agent session that was created, e.g. "session_01HX...". - `id: optional string` @@ -201497,17 +204659,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_unpaused"` + - `type: optional "platform_agent_session_created"` - default: platform_agent_deployment_unpaused + default: platform_agent_session_created - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentUpdated object` + - `PlatformAgentSessionDeleted object` - An agent deployment was updated on the API platform. + An agent session was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -201720,9 +204882,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was updated, e.g. "depl_01HX...". + The agent session that was deleted, e.g. "session_01HX...". - `id: optional string` @@ -201742,17 +204904,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_updated"` + - `type: optional "platform_agent_session_deleted"` - default: platform_agent_deployment_updated + default: platform_agent_session_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionArchived object` + - `PlatformAgentSessionResourceAdded object` - An agent session was archived on the API platform. + A resource was attached to an agent session. - `actor: object or object or object or 8 more` @@ -201965,9 +205127,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` + - `resource_id: string` + + The resource that was attached, e.g. "resource_01HX...". + - `session_id: string` - The agent session that was archived, e.g. "session_01HX...". + The agent session the resource was attached to, e.g. "session_01HX...". - `id: optional string` @@ -201987,17 +205153,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_archived"` + - `type: optional "platform_agent_session_resource_added"` - default: platform_agent_session_archived + default: platform_agent_session_resource_added - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionCreated object` + - `PlatformAgentSessionResourceDeleted object` - An agent session was created on the API platform. + A resource attached to an agent session was removed. - `actor: object or object or object or 8 more` @@ -202210,9 +205376,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` + - `resource_id: string` + + The resource that was removed, e.g. "resource_01HX...". + - `session_id: string` - The agent session that was created, e.g. "session_01HX...". + The agent session the resource belonged to, e.g. "session_01HX...". - `id: optional string` @@ -202232,17 +205402,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_created"` + - `type: optional "platform_agent_session_resource_deleted"` - default: platform_agent_session_created + default: platform_agent_session_resource_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionDeleted object` + - `PlatformAgentSessionResourceUpdated object` - An agent session was deleted from the API platform. + A resource attached to an agent session was updated. - `actor: object or object or object or 8 more` @@ -202455,9 +205625,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` + - `resource_id: string` + + The resource that was updated, e.g. "resource_01HX...". + - `session_id: string` - The agent session that was deleted, e.g. "session_01HX...". + The agent session the resource belongs to, e.g. "session_01HX...". - `id: optional string` @@ -202477,17 +205651,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_deleted"` + - `type: optional "platform_agent_session_resource_updated"` - default: platform_agent_session_deleted + default: platform_agent_session_resource_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceAdded object` + - `PlatformAgentSessionThreadArchived object` - A resource was attached to an agent session. + A thread within an agent session was archived. - `actor: object or object or object or 8 more` @@ -202700,13 +205874,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `resource_id: string` + - `session_id: string` - The resource that was attached, e.g. "resource_01HX...". + The agent session the thread belongs to, e.g. "session_01HX...". - - `session_id: string` + - `thread_id: string` - The agent session the resource was attached to, e.g. "session_01HX...". + The thread that was archived, e.g. "thread_01HX...". - `id: optional string` @@ -202726,17 +205900,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_added"` + - `type: optional "platform_agent_session_thread_archived"` - default: platform_agent_session_resource_added + default: platform_agent_session_thread_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceDeleted object` + - `PlatformAgentSessionUpdated object` - A resource attached to an agent session was removed. + An agent session was updated on the API platform. - `actor: object or object or object or 8 more` @@ -202949,13 +206123,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `resource_id: string` - - The resource that was removed, e.g. "resource_01HX...". - - `session_id: string` - The agent session the resource belonged to, e.g. "session_01HX...". + The agent session that was updated, e.g. "session_01HX...". - `id: optional string` @@ -202975,17 +206145,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_deleted"` + - `type: optional "platform_agent_session_updated"` - default: platform_agent_session_resource_deleted + default: platform_agent_session_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceUpdated object` + - `PlatformAgentUpdated object` - A resource attached to an agent session was updated. + An agent was updated on the API platform. - `actor: object or object or object or 8 more` @@ -203198,13 +206368,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `resource_id: string` - - The resource that was updated, e.g. "resource_01HX...". - - - `session_id: string` + - `agent_id: string` - The agent session the resource belongs to, e.g. "session_01HX...". + The agent that was updated, e.g. "agent_01HX...". - `id: optional string` @@ -203224,17 +206390,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_updated"` + - `type: optional "platform_agent_updated"` - default: platform_agent_session_resource_updated + default: platform_agent_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionThreadArchived object` + - `PlatformAPIKeyCreated object` - A thread within an agent session was archived. + An API key was created. - `actor: object or object or object or 8 more` @@ -203447,13 +206613,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `session_id: string` - - The agent session the thread belongs to, e.g. "session_01HX...". - - - `thread_id: string` + - `api_key_id: string` - The thread that was archived, e.g. "thread_01HX...". + Tagged ID of the created API key - `id: optional string` @@ -203473,17 +206635,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_thread_archived"` - - default: platform_agent_session_thread_archived - - - `workspace_id: optional string or null` + - `type: optional "platform_api_key_created"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_api_key_created - - `PlatformAgentSessionUpdated object` + - `PlatformAPIKeyUpdated object` - An agent session was updated on the API platform. + An API key was updated. - `actor: object or object or object or 8 more` @@ -203696,9 +206854,23 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `session_id: string` + - `api_key_id: string` - The agent session that was updated, e.g. "session_01HX...". + Tagged ID of the updated API key + + - `updates: array of object` + + - `current_value: string` + + - `previous_value: string` + + - `type: "name" or "status" or "workspace"` + + - `"name"` + + - `"status"` + + - `"workspace"` - `id: optional string` @@ -203718,17 +206890,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_updated"` - - default: platform_agent_session_updated - - - `workspace_id: optional string or null` + - `type: optional "platform_api_key_updated"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_api_key_updated - - `PlatformAgentUpdated object` + - `PlatformAppAttestAuthentication object` - An agent was updated on the API platform. + An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials. - `actor: object or object or object or 8 more` @@ -203941,10 +207109,6 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was updated, e.g. "agent_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -203955,6 +207119,22 @@ curl https://api.anthropic.com/v1/compliance/activities \ format: date-time + - `event_data: optional object or null` + + A nested object within a compliance activity payload. + + - `external_client_id: optional string or null` + + The registered external client the device presented, e.g. "clid_01HXZ4J2N8K5P7R9T3V6W1Y4M0". + + - `kid_hash: optional string or null` + + A truncated hash of the device's attested key identifier. + + - `workspace_id: optional string or null` + + The tagged ID of the workspace the minted token is bound to. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -203963,17 +207143,29 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_updated"` + - `request_id: optional string or null` - default: platform_agent_updated + The Anthropic API request identifier for correlation. - - `workspace_id: optional string or null` + - `status: optional object or null` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + A nested object within a compliance activity payload. - - `PlatformAPIKeyCreated object` + - `outcome: string` - An API key was created. + Whether the token exchange succeeded or was denied. + + - `reason: optional string or null` + + A short reason code when the exchange did not succeed. + + - `type: optional "platform_app_attest_authentication"` + + default: platform_app_attest_authentication + + - `PlatformBillingUpgradedToPrepaid object` + + The organization's API billing was upgraded to the prepaid plan. - `actor: object or object or object or 8 more` @@ -204186,9 +207378,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `api_key_id: string` + - `previous_billing_type: string` - Tagged ID of the created API key + The organization's billing type before this upgrade, for example "api_evaluation". - `id: optional string` @@ -204208,13 +207400,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_api_key_created"` + - `type: optional "platform_billing_upgraded_to_prepaid"` - default: platform_api_key_created + default: platform_billing_upgraded_to_prepaid - - `PlatformAPIKeyUpdated object` + - `PlatformClearanceWorkspaceProgramRequestCleared object` - An API key was updated. + A workspace's clearance program assignment was removed. - `actor: object or object or object or 8 more` @@ -204427,23 +207619,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `api_key_id: string` - - Tagged ID of the updated API key - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "name" or "status" or "workspace"` + - `program_slug: string` - - `"name"` + The clearance program's identifier - - `"status"` + - `workspace_id: string` - - `"workspace"` + Tagged ID of the workspace - `id: optional string` @@ -204463,13 +207645,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_api_key_updated"` + - `type: optional "platform_clearance_workspace_program_request_cleared"` - default: platform_api_key_updated + default: platform_clearance_workspace_program_request_cleared - - `PlatformAppAttestAuthentication object` + - `PlatformClearanceWorkspaceProgramRequestSet object` - An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials. + A workspace's clearance program assignment was created or updated. - `actor: object or object or object or 8 more` @@ -204682,31 +207864,33 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `id: optional string` + - `opt_decision: "opt_in" or "opt_out" or "unspecified"` - Unique identifier for the activity e.g. 'activity_abcd1234' + Whether the workspace is opted in or out of the program - - `created_at: optional string` + - `"opt_in"` - When this activity occurred. + - `"opt_out"` - format: date-time + - `"unspecified"` - - `event_data: optional object or null` + - `program_slug: string` - A nested object within a compliance activity payload. + The clearance program's identifier - - `external_client_id: optional string or null` + - `workspace_id: string` - The registered external client the device presented, e.g. "clid_01HXZ4J2N8K5P7R9T3V6W1Y4M0". + Tagged ID of the workspace - - `kid_hash: optional string or null` + - `id: optional string` - A truncated hash of the device's attested key identifier. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `workspace_id: optional string or null` + - `created_at: optional string` - The tagged ID of the workspace the minted token is bound to. + When this activity occurred. + + format: date-time - `organization_id: optional string or null` @@ -204716,29 +207900,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `request_id: optional string or null` - - The Anthropic API request identifier for correlation. - - - `status: optional object or null` - - A nested object within a compliance activity payload. - - - `outcome: string` - - Whether the token exchange succeeded or was denied. - - - `reason: optional string or null` - - A short reason code when the exchange did not succeed. - - - `type: optional "platform_app_attest_authentication"` + - `type: optional "platform_clearance_workspace_program_request_set"` - default: platform_app_attest_authentication + default: platform_clearance_workspace_program_request_set - - `PlatformBillingUpgradedToPrepaid object` + - `PlatformCostReportViewed object` - The organization's API billing was upgraded to the prepaid plan. + The cost report was viewed. - `actor: object or object or object or 8 more` @@ -204951,10 +208119,6 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `previous_billing_type: string` - - The organization's billing type before this upgrade, for example "api_evaluation". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -204973,13 +208137,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_billing_upgraded_to_prepaid"` + - `type: optional "platform_cost_report_viewed"` - default: platform_billing_upgraded_to_prepaid + default: platform_cost_report_viewed - - `PlatformClearanceWorkspaceProgramRequestCleared object` + - `PlatformDreamArchived object` - A workspace's clearance program assignment was removed. + A Dream (asynchronous memory-consolidation job) was archived. - `actor: object or object or object or 8 more` @@ -205192,13 +208356,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `program_slug: string` - - The clearance program's identifier - - - `workspace_id: string` + - `dream_id: string` - Tagged ID of the workspace + Tagged dream ID, e.g. "drm_01HX...". - `id: optional string` @@ -205218,13 +208378,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_clearance_workspace_program_request_cleared"` + - `type: optional "platform_dream_archived"` - default: platform_clearance_workspace_program_request_cleared + default: platform_dream_archived - - `PlatformClearanceWorkspaceProgramRequestSet object` + - `workspace_id: optional string or null` - A workspace's clearance program assignment was created or updated. + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. + + - `PlatformDreamCancelled object` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. - `actor: object or object or object or 8 more` @@ -205437,23 +208601,9 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` - - `opt_decision: "opt_in" or "opt_out" or "unspecified"` - - Whether the workspace is opted in or out of the program - - - `"opt_in"` - - - `"opt_out"` - - - `"unspecified"` - - - `program_slug: string` - - The clearance program's identifier - - - `workspace_id: string` + - `dream_id: string` - Tagged ID of the workspace + Tagged dream ID, e.g. "drm_01HX...". - `id: optional string` @@ -205473,13 +208623,17 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_clearance_workspace_program_request_set"` + - `type: optional "platform_dream_cancelled"` - default: platform_clearance_workspace_program_request_set + default: platform_dream_cancelled - - `PlatformCostReportViewed object` + - `workspace_id: optional string or null` - The cost report was viewed. + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. + + - `PlatformDreamCreated object` + + A Dream (asynchronous memory-consolidation job) was created. - `actor: object or object or object or 8 more` @@ -205692,6 +208846,10 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `user_agent: optional string or null` + - `dream_id: string` + + Tagged dream ID, e.g. "drm_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -205710,9 +208868,13 @@ curl https://api.anthropic.com/v1/compliance/activities \ Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_cost_report_viewed"` + - `type: optional "platform_dream_created"` - default: platform_cost_report_viewed + default: platform_dream_created + + - `workspace_id: optional string or null` + + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. - `PlatformFederatedAuthentication object` @@ -225880,15 +229042,19 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `audience: array of object or object` - Sharing audience for the project. If empty, this it's only visible to the creating user. + Sharing audience for the project. If empty, it's only visible to the creating user. + + - `Public object` - - `ProjectSharingAudiencePublic object` + Sharing audience: the project is visible to anyone with the link. - `type: optional "public"` default: public - - `ProjectSharingAudienceOrganization object` + - `Organization object` + + Sharing audience: the project is visible to members of the owning organization. - `type: optional "organization"` @@ -225896,6 +229062,8 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `claude_project_id: string` + The project's identifier, e.g. "claude_proj_01Ab...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -228377,14 +231545,24 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `resource_id: optional string or null` + ID of the resource the role is on. + - `resource_type: optional string or null` + What kind of resource the role is on, for example "chat_project", "skill", or "plugin". + - `role: optional string or null` + The role that was granted, for example "skill:viewer" or "plugin:viewer". + - `target_id: optional string or null` + ID of the grantee: a user ID for a member, a group ID for a group, the organization ID for an organization-wide grant. + - `target_type: optional string or null` + What kind of grantee received the role, for example "organization_member", "group", or "organization". + - `type: optional "role_assignment_granted"` default: role_assignment_granted @@ -228624,14 +231802,24 @@ curl https://api.anthropic.com/v1/compliance/activities \ - `resource_id: optional string or null` + ID of the resource the role was on. + - `resource_type: optional string or null` + What kind of resource the role was on, for example "chat_project", "skill", or "plugin". + - `role: optional string or null` + The role that was revoked, for example "skill:viewer" or "plugin:viewer". + - `target_id: optional string or null` + ID of the grantee that held the role: a user ID for a member, a group ID for a group, the organization ID for an organization-wide grant. + - `target_type: optional string or null` + What kind of grantee held the role, for example "organization_member", "group", or "organization". + - `type: optional "role_assignment_revoked"` default: role_assignment_revoked @@ -241152,11 +244340,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The web search setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -241168,11 +244356,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The geolocation setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -241286,11 +244474,11 @@ curl https://api.anthropic.com/v1/compliance/activities \ The Claude API in Artifacts setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change diff --git a/content/en/api/compliance/activities/list.md b/content/en/api/compliance/activities/list.md index ad98702f0..6cfc74ab5 100644 --- a/content/en/api/compliance/activities/list.md +++ b/content/en/api/compliance/activities/list.md @@ -10,7 +10,7 @@ compliance activities that can be filtered by various criteria. ## Query parameters -- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 474 more` +- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 480 more` Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`. @@ -186,6 +186,14 @@ compliance activities that can be filtered by various criteria. An attempt to access an artifact failed. + - `"claude_artifact_commented"` + + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. + + - `"claude_artifact_comments_viewed"` + + An artifact's comments were viewed. + - `"claude_artifact_created"` An artifact was created. @@ -328,7 +336,7 @@ compliance activities that can be filtered by various criteria. - `"claude_code_security_scan_run_updated"` - A single Claude Code Security scan run was archived or unarchived. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. - `"claude_code_security_scan_schedule_deleted"` @@ -402,6 +410,10 @@ compliance activities that can be filtered by various criteria. Command was replaced. + - `"claude_enterprise_upgrade_credit_updated"` + + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. + - `"claude_file_access_failed"` A user was denied access to a file in Claude.ai. @@ -1302,11 +1314,11 @@ compliance activities that can be filtered by various criteria. - `"org_work_across_apps_disabled"` - Organization Work Across Apps was disabled. + The organization's "Let Claude work across apps" setting was turned off. - `"org_work_across_apps_enabled"` - Organization Work Across Apps was enabled. + The organization's "Let Claude work across apps" setting was turned on. - `"organization_address_updated"` @@ -1448,6 +1460,18 @@ compliance activities that can be filtered by various criteria. The cost report was viewed. + - `"platform_dream_archived"` + + A Dream (asynchronous memory-consolidation job) was archived. + + - `"platform_dream_cancelled"` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. + + - `"platform_dream_created"` + + A Dream (asynchronous memory-consolidation job) was created. + - `"platform_federated_authentication"` A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials. @@ -1982,7 +2006,7 @@ compliance activities that can be filtered by various criteria. format: date-time -- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 474 more` +- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 480 more` Exclude activities of these types. Cannot be combined with `activity_types[]`. @@ -2158,6 +2182,14 @@ compliance activities that can be filtered by various criteria. An attempt to access an artifact failed. + - `"claude_artifact_commented"` + + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. + + - `"claude_artifact_comments_viewed"` + + An artifact's comments were viewed. + - `"claude_artifact_created"` An artifact was created. @@ -2300,7 +2332,7 @@ compliance activities that can be filtered by various criteria. - `"claude_code_security_scan_run_updated"` - A single Claude Code Security scan run was archived or unarchived. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. - `"claude_code_security_scan_schedule_deleted"` @@ -2374,6 +2406,10 @@ compliance activities that can be filtered by various criteria. Command was replaced. + - `"claude_enterprise_upgrade_credit_updated"` + + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. + - `"claude_file_access_failed"` A user was denied access to a file in Claude.ai. @@ -3274,11 +3310,11 @@ compliance activities that can be filtered by various criteria. - `"org_work_across_apps_disabled"` - Organization Work Across Apps was disabled. + The organization's "Let Claude work across apps" setting was turned off. - `"org_work_across_apps_enabled"` - Organization Work Across Apps was enabled. + The organization's "Let Claude work across apps" setting was turned on. - `"organization_address_updated"` @@ -3420,6 +3456,18 @@ compliance activities that can be filtered by various criteria. The cost report was viewed. + - `"platform_dream_archived"` + + A Dream (asynchronous memory-consolidation job) was archived. + + - `"platform_dream_cancelled"` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. + + - `"platform_dream_created"` + + A Dream (asynchronous memory-consolidation job) was created. + - `"platform_federated_authentication"` A federated workload identity attempted to exchange an OIDC token for Anthropic API credentials. @@ -3946,7 +3994,7 @@ compliance activities that can be filtered by various criteria. ## Returns -- `data: optional array of object or object or object or 474 more` +- `data: optional array of object or object or object or 480 more` List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present. @@ -6637,9 +6685,9 @@ compliance activities that can be filtered by various criteria. default: claude_artifact_access_failed - - `ClaudeArtifactCreated object` + - `ClaudeArtifactCommented object` - An artifact was created. + Comment activity on a published artifact: a comment was added, a thread's resolved state was changed, or a thread was deleted. The actor is the user who performed the action; the comment text itself is stored with the artifact and is not part of this record. - `actor: object or object or object or 8 more` @@ -6854,250 +6902,45 @@ compliance activities that can be filtered by various criteria. - `claude_artifact_id: string` - - `id: optional string` - - Unique identifier for the activity e.g. 'activity_abcd1234' - - - `created_at: optional string` - - When this activity occurred. - - format: date-time - - - `organization_id: optional string or null` - - Organization ID this activity is associated with - - - `organization_uuid: optional string or null` - - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - - `type: optional "claude_artifact_created"` - - default: claude_artifact_created - - - `ClaudePublishedArtifactDeleted object` - - A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation). - - - `actor: object or object or object or 8 more` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `APIActor object` - - - `api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "api_actor"` - - default: api_actor - - - `UserActor object` - - - `email_address: string` - - format: email - - - `ip_address: string` - - - `user_agent: string` - - - `user_id: string` - - - `type: optional "user_actor"` - - default: user_actor - - - `UnauthenticatedUserActor object` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "unauthenticated_user_actor"` - - default: unauthenticated_user_actor - - - `unauthenticated_email_address: optional string or null` - - format: email - - - `AnthropicActor object` - - - `email_address: optional string or null` - - format: email - - - `type: optional "anthropic_actor"` - - default: anthropic_actor - - - `SystemActor object` - - Automated background processing performed by Anthropic systems, acting - without a user or customer credential. - - - `service: optional string or null` - - Name of the automated process that performed the action, when known. - - - `type: optional "system_actor"` - - default: system_actor - - - `AdminAPIKeyActor object` - - - `admin_api_key_id: string` - - - `ip_address: string` - - - `user_agent: string` - - - `type: optional "admin_api_key_actor"` - - default: admin_api_key_actor - - - `ServiceAccountActor object` - - - `ip_address: string` - - - `service_account_id: string` - - - `user_agent: string` - - - `type: optional "service_account_actor"` - - default: service_account_actor - - - `ScimDirectorySyncActor object` - - - `directory_id: string` - - - `workos_event_id: string` - - - `idp_connection_type: optional string or null` - - - `type: optional "scim_directory_sync_actor"` - - default: scim_directory_sync_actor - - - `FederatedIdentityActor object` - - A federated external workload authenticated via a verified OIDC token. - - Carries the verified issuer, subject, and audience claims from the - presented JWT. - - - `issuer: string` - - - `subject: string` - - - `audience: optional array of string` - - - `ip_address: optional string or null` - - - `type: optional "federated_identity_actor"` - - default: federated_identity_actor - - - `user_agent: optional string or null` - - - `FederatedActor object` - - An external identity asserted by a trusted provider — a cloud-provider - gateway or a customer-registered federation issuer — acting without an - Anthropic-provisioned account or service account. - - - `provider: object or object or object or object` - - Asserting party: the AWS account the organization is bound to. - - - `FederatedActorAwsProvider object` - - Asserting party: the AWS account the organization is bound to. - - - `account_id: string` - - - `signed_principal: string` - - The AWS-signed ARN of the IAM principal that requested the token. - - - `type: optional "aws"` - - default: aws - - - `FederatedActorAzureProvider object` - - Asserting party: the Azure subscription the organization is bound to. - - - `subscription_id: string` - - - `type: optional "azure"` - - default: azure - - - `FederatedActorGcpProvider object` - - Asserting party: the GCP project the organization is bound to. - - - `project_number: string` - - - `type: optional "gcp"` - - default: gcp - - - `FederatedActorOidcProvider object` - - Asserting party: a customer-registered OIDC federation issuer. - - - `issuer: optional string or null` - - The federation issuer's URL. Null when the presented credential failed verification. - - - `type: optional "oidc"` + The artifact's identifier. - default: oidc + - `comment_action: "activate_thread" or "create_thread" or "deactivate_thread" or 6 more` - - `ip_address: optional string or null` + The action recorded: for example a new comment thread, a reply to an existing thread, a thread resolved, reopened, or deleted, a thread's Claude activation granted or revoked, or a comment's text rewritten by its author. - - `subject: optional string or null` + - `"activate_thread"` - The provider's verified identifier for the caller; its form depends on the provider. + - `"create_thread"` - - `type: optional "federated_actor"` + - `"deactivate_thread"` - default: federated_actor + - `"delete_thread"` - - `user_agent: optional string or null` + - `"edit_comment"` - - `AttestedDeviceActor object` + - `"reopen"` - An attested mobile device authenticated via Apple App Attest. + - `"reply"` - - `external_client_id: string` + - `"resolve"` - - `kid_hash: string` + - `"unspecified"` - - `ip_address: optional string or null` + - `id: optional string` - - `type: optional "attested_device_actor"` + Unique identifier for the activity e.g. 'activity_abcd1234' - default: attested_device_actor + - `claude_artifact_comment_id: optional string or null` - - `user_agent: optional string or null` + The comment's identifier. Present when the activity relates to a specific comment, for example a new comment or an author's edit of one; absent for thread-level actions performed without a comment, such as resolve, reopen, deletion, or an activation change. - - `claude_published_artifact_id: string` + - `claude_artifact_comment_thread_id: optional string or null` - The published artifact's identifier. + The comment thread's identifier. - - `id: optional string` + - `claude_artifact_version_id: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The artifact version the comment activity applied to, when known. - `created_at: optional string` @@ -7113,13 +6956,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_published_artifact_deleted"` + - `type: optional "claude_artifact_commented"` - default: claude_published_artifact_deleted + default: claude_artifact_commented - - `ClaudeArtifactPublished object` + - `ClaudeArtifactCommentsViewed object` - A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded on every save, including saves of private artifacts, and changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated. + An artifact's comments were viewed. - `actor: object or object or object or 8 more` @@ -7332,17 +7175,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `artifact_type: string` - - Artifact type (code, html, react, etc.) - - - `claude_published_artifact_id: string` - - The published artifact's identifier. - - - `title: string` + - `claude_artifact_id: string` - Title of the published artifact + The artifact's identifier. - `id: optional string` @@ -7350,7 +7185,7 @@ compliance activities that can be filtered by various criteria. - `claude_artifact_version_id: optional string or null` - The version identifier recorded as live by this publish. + The version of the artifact whose comments were served, when known. - `created_at: optional string` @@ -7358,14 +7193,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `description: optional string or null` - - Optional gallery-card description supplied at publish time. Same provenance as title (caller-authored, reader-visible). - - - `is_redeploy: optional boolean or null` - - True when the publish updated an existing artifact; false when the publish created the artifact. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -7374,13 +7201,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_artifact_published"` + - `type: optional "claude_artifact_comments_viewed"` - default: claude_artifact_published + default: claude_artifact_comments_viewed - - `ClaudeArtifactSharingUpdated object` + - `ClaudeArtifactCreated object` - An artifact's sharing settings were updated. + An artifact was created. - `actor: object or object or object or 8 more` @@ -7593,43 +7420,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `audience: array of object or object or object` - - Sharing audience for the project. If empty, this it's only visible to the creating user. - - - `ArtifactSharingAudienceOrganization object` - - Sharing audience: visible to the owning organization. - - - `type: optional "organization"` - - default: organization - - - `ArtifactSharingAudienceUsers object` - - Sharing audience: visible to an explicit allowlist of users. - - - `type: optional "users"` - - default: users - - - `ArtifactSharingAudienceAnyoneWithLink object` - - Sharing audience: anyone with the link, including anonymous viewers - (an artifact shared to the open internet). - - - `type: optional "anyone_with_link"` - - default: anyone_with_link - - `claude_artifact_id: string` - The artifact's identifier. - - - `claude_artifact_version_id: string` - - The artifact version's identifier. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -7640,22 +7432,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `new_mode: optional string or null` - - The read-axis sharing mode after the change: `owner`, `users`, or `org`. - - - `new_user_count: optional number or null` - - The number of accounts on the explicit read allowlist after the change. Only meaningful when `new_mode` is `users`. - - - `new_write_mode: optional string or null` - - The write-axis sharing mode after the change: `owner`, `users`, or `org`. - - - `new_write_user_count: optional number or null` - - The number of accounts on the explicit write allowlist after the change. Only meaningful when `new_write_mode` is `users`. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -7664,29 +7440,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mode: optional string or null` - - The read-axis sharing mode before the change: `owner`, `users`, or `org`. - - - `previous_user_count: optional number or null` - - The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`. - - - `previous_write_mode: optional string or null` - - The write-axis sharing mode before the change: `owner`, `users`, or `org`. - - - `previous_write_user_count: optional number or null` - - The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`. - - - `type: optional "claude_artifact_sharing_updated"` + - `type: optional "claude_artifact_created"` - default: claude_artifact_sharing_updated + default: claude_artifact_created - - `ClaudeArtifactViewed object` + - `ClaudePublishedArtifactDeleted object` - An artifact was viewed. + A published artifact was deleted or unpublished — by its creator, by an organization admin, or by Anthropic (for example, when it was removed for a policy violation). - `actor: object or object or object or 8 more` @@ -7899,18 +7659,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_artifact_id: string` + - `claude_published_artifact_id: string` - The artifact's identifier. + The published artifact's identifier. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_version_id: optional string or null` - - The version of the artifact the user was served, when known. - - `created_at: optional string` When this activity occurred. @@ -7925,13 +7681,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_artifact_viewed"` + - `type: optional "claude_published_artifact_deleted"` - default: claude_artifact_viewed + default: claude_published_artifact_deleted - - `AuditLogExportAccessed object` + - `ClaudeArtifactPublished object` - Audit log export file was accessed/downloaded via signed URL. + A new version of an artifact was published — for an artifact created in a chat this is the action that made it publicly viewable; for an artifact created outside a chat it is recorded on every save, including saves of private artifacts, and changes to who can access the artifact are recorded separately as claude_artifact_sharing_updated. - `actor: object or object or object or 8 more` @@ -8144,16 +7900,40 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `artifact_type: string` + + Artifact type (code, html, react, etc.) + + - `claude_published_artifact_id: string` + + The published artifact's identifier. + + - `title: string` + + Title of the published artifact + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_artifact_version_id: optional string or null` + + The version identifier recorded as live by this publish. + - `created_at: optional string` When this activity occurred. format: date-time + - `description: optional string or null` + + Optional gallery-card description supplied at publish time. Same provenance as title (caller-authored, reader-visible). + + - `is_redeploy: optional boolean or null` + + True when the publish updated an existing artifact; false when the publish created the artifact. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -8162,13 +7942,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "audit_log_export_accessed"` + - `type: optional "claude_artifact_published"` - default: audit_log_export_accessed + default: claude_artifact_published - - `AuditLogExportStarted object` + - `ClaudeArtifactSharingUpdated object` - Audit log export was initiated. + An artifact's sharing settings were updated. - `actor: object or object or object or 8 more` @@ -8381,6 +8161,43 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `audience: array of object or object or object` + + Sharing audience for the project. If empty, this it's only visible to the creating user. + + - `ArtifactSharingAudienceOrganization object` + + Sharing audience: visible to the owning organization. + + - `type: optional "organization"` + + default: organization + + - `ArtifactSharingAudienceUsers object` + + Sharing audience: visible to an explicit allowlist of users. + + - `type: optional "users"` + + default: users + + - `ArtifactSharingAudienceAnyoneWithLink object` + + Sharing audience: anyone with the link, including anonymous viewers + (an artifact shared to the open internet). + + - `type: optional "anyone_with_link"` + + default: anyone_with_link + + - `claude_artifact_id: string` + + The artifact's identifier. + + - `claude_artifact_version_id: string` + + The artifact version's identifier. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -8391,9 +8208,21 @@ compliance activities that can be filtered by various criteria. format: date-time - - `from_date: optional string or null` + - `new_mode: optional string or null` - Start date of the export range + The read-axis sharing mode after the change: `owner`, `users`, or `org`. + + - `new_user_count: optional number or null` + + The number of accounts on the explicit read allowlist after the change. Only meaningful when `new_mode` is `users`. + + - `new_write_mode: optional string or null` + + The write-axis sharing mode after the change: `owner`, `users`, or `org`. + + - `new_write_user_count: optional number or null` + + The number of accounts on the explicit write allowlist after the change. Only meaningful when `new_write_mode` is `users`. - `organization_id: optional string or null` @@ -8403,17 +8232,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `to_date: optional string or null` + - `previous_mode: optional string or null` - End date of the export range + The read-axis sharing mode before the change: `owner`, `users`, or `org`. - - `type: optional "audit_log_export_started"` + - `previous_user_count: optional number or null` - default: audit_log_export_started + The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`. - - `BillingEmailsUpdated object` + - `previous_write_mode: optional string or null` - The organization's billing email recipients were updated. + The write-axis sharing mode before the change: `owner`, `users`, or `org`. + + - `previous_write_user_count: optional number or null` + + The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`. + + - `type: optional "claude_artifact_sharing_updated"` + + default: claude_artifact_sharing_updated + + - `ClaudeArtifactViewed object` + + An artifact was viewed. - `actor: object or object or object or 8 more` @@ -8626,13 +8467,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_artifact_id: string` + + The artifact's identifier. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cc_email_count: optional number or null` + - `claude_artifact_version_id: optional string or null` - Number of 'cc' email recipients. + The version of the artifact the user was served, when known. - `created_at: optional string` @@ -8648,21 +8493,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `primary_email_set: optional boolean or null` - - Whether a primary billing email is configured. - - - `to_email_count: optional number or null` - - Number of 'to' email recipients. - - - `type: optional "billing_emails_updated"` + - `type: optional "claude_artifact_viewed"` - default: billing_emails_updated + default: claude_artifact_viewed - - `CcrAgentCreated object` + - `AuditLogExportAccessed object` - A Claude Code agent was created. + Audit log export file was accessed/downloaded via signed URL. - `actor: object or object or object or 8 more` @@ -8875,26 +8712,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was created, e.g. "cagt_01HX...". - - - `default_source_urls_truncated: boolean` - - Whether default_source_urls was capped and omits some of the granted repositories. - - - `display_name: string` - - The agent's display name at creation time. - - - `omitted_source_url_count: number` - - Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. - - - `slug: string` - - The agent's URL-safe identifier, unique within the organization. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -8905,14 +8722,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_source_urls: optional array of string` - - The repository URLs the agent works on by default, reduced to scheme, host, and path — credentials and query parameters are never included. Empty with a zero omitted_source_url_count means the agent was created without any default repositories; empty with a non-zero count means repositories were granted but could not be safely rendered. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - - - `guest_policy: optional string or null` - - Whether the agent responds in Slack channels that include guest users: "allow", "restrict", or "channel" (the agent responds, using only that channel's own content and configuration). Omitted when the agent inherits the default policy. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -8921,17 +8730,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `slack_alias: optional string or null` - - The Slack trigger word that routes mentions to this agent. An empty value means the agent responds to bare "@Claude" mentions. Omitted when the agent is not addressable from Slack. - - - `type: optional "ccr_agent_created"` + - `type: optional "audit_log_export_accessed"` - default: ccr_agent_created + default: audit_log_export_accessed - - `CcrAgentDeleted object` + - `AuditLogExportStarted object` - A Claude Code agent was deleted. + Audit log export was initiated. - `actor: object or object or object or 8 more` @@ -9144,32 +8949,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was deleted, e.g. "cagt_01HX...". - - - `cascaded_agent_ids_truncated: boolean` - - True when more agents were deleted in this cascade than are individually recorded. On a cascade parent event (cascaded_from_agent_id unset), cascaded_agent_ids is capped at 100. On a cascade child event (cascaded_from_agent_id set, emitted when the parent deletion failed after committing child deletions), one event is emitted per deleted child up to 100, and this field indicates additional children were deleted in the same cascade. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascaded_agent_ids: optional array of string` - - Agents assigned to individual Slack channels that were also deleted because agent_id was the agent assigned to their entire Slack workspace. Empty when no such agents were deleted, and always empty on a cascade child event (cascaded_from_agent_id set) — the child's siblings are recorded as their own events, not listed here. Capped at 100 entries; cascaded_agent_ids_truncated is set when the actual count exceeded the cap. - - - `cascaded_from_agent_id: optional string or null` - - When set, the Slack workspace's dedicated agent whose deletion attempt caused this agent to be deleted. The parent's own deletion may have failed after the cascade committed — check for a separate event with agent_id = cascaded_from_agent_id to confirm. Unset on a direct deletion. - - `created_at: optional string` When this activity occurred. format: date-time + - `from_date: optional string or null` + + Start date of the export range + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -9178,13 +8971,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_deleted"` + - `to_date: optional string or null` - default: ccr_agent_deleted + End date of the export range - - `CcrAgentProxyCredentialCreated object` + - `type: optional "audit_log_export_started"` - A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself. + default: audit_log_export_started + + - `BillingEmailsUpdated object` + + The organization's billing email recipients were updated. - `actor: object or object or object or 8 more` @@ -9397,57 +9194,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential that was created, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - - - `display_name: string` - - The credential's display name. - - - `host_constraint_truncated: boolean` - - Whether host_constraint was capped and omits some of the configured host name patterns. - - - `profile_id: string` - - The agent proxy profile the credential belongs to, e.g. "capp_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `authorization_basis: optional object or null` - - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - - - `slack_channel_id: string` - - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - - - `slack_enterprise_id: string` - - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. - - - `slack_team_id: string` - - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". - - - `via_entitlement_leg: boolean` - - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. - - - `via_full_manage: boolean` - - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. - - - `granting_role_ids: optional array of string` + - `cc_email_count: optional number or null` - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + Number of 'cc' email recipients. - `created_at: optional string` @@ -9455,10 +9208,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `host_constraint: optional array of string` - - The host name patterns the credential may be sent to, e.g. "api.example.com" or "*.example.com". At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -9467,13 +9216,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_created"` + - `primary_email_set: optional boolean or null` - default: ccr_agent_proxy_credential_created + Whether a primary billing email is configured. - - `CcrAgentProxyCredentialDeleted object` + - `to_email_count: optional number or null` - A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host. + Number of 'to' email recipients. + + - `type: optional "billing_emails_updated"` + + default: billing_emails_updated + + - `CcrAgentCreated object` + + A Claude Code agent was created. - `actor: object or object or object or 8 more` @@ -9686,51 +9443,43 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential that was deleted, e.g. "apc_01HX...". - - - `profile_id: string` - - The agent proxy profile the credential belonged to, e.g. "capp_01HX...". Carried so the deletion can be correlated with the profile's other audit events after the credential row no longer exists. - - - `id: optional string` + - `agent_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The agent that was created, e.g. "cagt_01HX...". - - `authorization_basis: optional object or null` + - `default_source_urls_truncated: boolean` - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + Whether default_source_urls was capped and omits some of the granted repositories. - - `slack_channel_id: string` + - `display_name: string` - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + The agent's display name at creation time. - - `slack_enterprise_id: string` + - `omitted_source_url_count: number` - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. - - `slack_team_id: string` + - `slug: string` - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + The agent's URL-safe identifier, unique within the organization. - - `via_entitlement_leg: boolean` + - `id: optional string` - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `via_full_manage: boolean` + - `created_at: optional string` - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + When this activity occurred. - - `granting_role_ids: optional array of string` + format: date-time - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + - `default_source_urls: optional array of string` - - `created_at: optional string` + The repository URLs the agent works on by default, reduced to scheme, host, and path — credentials and query parameters are never included. Empty with a zero omitted_source_url_count means the agent was created without any default repositories; empty with a non-zero count means repositories were granted but could not be safely rendered. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - When this activity occurred. + - `guest_policy: optional string or null` - format: date-time + Whether the agent responds in Slack channels that include guest users, and in Slack Connect channels shared with other organizations: "allow", "restrict", or "channel" (the agent responds, using only that channel's own content and configuration). In Slack Connect channels "allow" gives at most "channel" access. Omitted when the agent inherits the default policy. - `organization_id: optional string or null` @@ -9740,13 +9489,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_deleted"` + - `slack_alias: optional string or null` - default: ccr_agent_proxy_credential_deleted + The Slack trigger word that routes mentions to this agent. An empty value means the agent responds to bare "@Claude" mentions. Omitted when the agent is not addressable from Slack. - - `CcrAgentProxyCredentialRotated object` + - `type: optional "ccr_agent_created"` - A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement. + default: ccr_agent_created + + - `CcrAgentDeleted object` + + A Claude Code agent was deleted. - `actor: object or object or object or 8 more` @@ -9959,65 +9712,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The replacement credential, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - - - `destinations_repointed: number` - - The number of agent proxy destinations that referenced the old credential and now reference the replacement. - - - `display_name: string` - - The credential's display name. - - - `previous_credential_id: string` - - The credential that was replaced, e.g. "apc_01HX...". - - - `profile_id: string` + - `agent_id: string` - The agent proxy profile the credential belongs to, e.g. "capp_01HX...". + The agent that was deleted, e.g. "cagt_01HX...". - - `rules_repointed: number` + - `cascaded_agent_ids_truncated: boolean` - The number of agent proxy rules that referenced the old credential and now reference the replacement. + True when more agents were deleted in this cascade than are individually recorded. On a cascade parent event (cascaded_from_agent_id unset), cascaded_agent_ids is capped at 100. On a cascade child event (cascaded_from_agent_id set, emitted when the parent deletion failed after committing child deletions), one event is emitted per deleted child up to 100, and this field indicates additional children were deleted in the same cascade. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `authorization_basis: optional object or null` - - CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - - - `slack_channel_id: string` - - The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - - - `slack_enterprise_id: string` - - The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. - - - `slack_team_id: string` - - The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". - - - `via_entitlement_leg: boolean` - - True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. - - - `via_full_manage: boolean` + - `cascaded_agent_ids: optional array of string` - True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + Agents assigned to individual Slack channels that were also deleted because agent_id was the agent assigned to their entire Slack workspace. Empty when no such agents were deleted, and always empty on a cascade child event (cascaded_from_agent_id set) — the child's siblings are recorded as their own events, not listed here. Capped at 100 entries; cascaded_agent_ids_truncated is set when the actual count exceeded the cap. - - `granting_role_ids: optional array of string` + - `cascaded_from_agent_id: optional string or null` - The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + When set, the Slack workspace's dedicated agent whose deletion attempt caused this agent to be deleted. The parent's own deletion may have failed after the cascade committed — check for a separate event with agent_id = cascaded_from_agent_id to confirm. Unset on a direct deletion. - `created_at: optional string` @@ -10033,13 +9746,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_rotated"` + - `type: optional "ccr_agent_deleted"` - default: ccr_agent_proxy_credential_rotated + default: ccr_agent_deleted - - `CcrAgentProxyCredentialUpdated object` + - `CcrAgentProxyCredentialCreated object` - A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation. + A Claude Code agent proxy credential was created. Credentials hold the secrets the agent proxy injects into requests Claude Code sessions send to approved external services; each credential belongs to an agent proxy profile. Audit events carry only credential names and settings, never the secret material itself. - `actor: object or object or object or 8 more` @@ -10254,11 +9967,15 @@ compliance activities that can be filtered by various criteria. - `credential_id: string` - The credential that was updated, e.g. "apc_01HX...". + The credential that was created, e.g. "apc_01HX...". + + - `credential_type: string` + + The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". - `display_name: string` - The credential's display name after the update. + The credential's display name. - `host_constraint_truncated: boolean` @@ -10308,7 +10025,7 @@ compliance activities that can be filtered by various criteria. - `host_constraint: optional array of string` - The host name patterns the credential may be sent to after the update, e.g. "api.example.com" or "*.example.com". Populated only when the update changed them. At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. + The host name patterns the credential may be sent to, e.g. "api.example.com" or "*.example.com". At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. - `organization_id: optional string or null` @@ -10318,17 +10035,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_credential_updated"` - - default: ccr_agent_proxy_credential_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_proxy_credential_created"` - Names of the settings included in the update: "display_name", "host_constraint". + default: ccr_agent_proxy_credential_created - - `CcrAgentProxyDestinationDeleted object` + - `CcrAgentProxyCredentialDeleted object` - An agent proxy destination was deleted. + A Claude Code agent proxy credential was deleted. Its secret material was removed and can no longer be sent to any host. - `actor: object or object or object or 8 more` @@ -10541,25 +10254,45 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_with_profile: boolean` - - True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyDestination call. - - - `destination_id: string` + - `credential_id: string` - The destination that was deleted, e.g. "apd_01HX...". + The credential that was deleted, e.g. "apc_01HX...". - `profile_id: string` - The agent proxy profile the destination belonged to, e.g. "capp_01HX...". + The agent proxy profile the credential belonged to, e.g. "capp_01HX...". Carried so the deletion can be correlated with the profile's other audit events after the credential row no longer exists. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascade_trigger_credential_id: optional string or null` + - `authorization_basis: optional object or null` - Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the destination's client_tls_credential was the deleted credential). Unset for a direct DeleteAgentProxyDestination call and for the profile-delete cascade (see deleted_with_profile). + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + + - `slack_channel_id: string` + + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). - `created_at: optional string` @@ -10575,13 +10308,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_destination_deleted"` + - `type: optional "ccr_agent_proxy_credential_deleted"` - default: ccr_agent_proxy_destination_deleted + default: ccr_agent_proxy_credential_deleted - - `CcrAgentProxyNetworkEventsListed object` + - `CcrAgentProxyCredentialRotated object` - A Claude Code network activity export was accessed for the given hour. + A Claude Code agent proxy credential's secret material was replaced. The replacement keeps the same name, profile, and allowed hosts under a new credential identifier, and everything that referenced the old credential now uses the replacement. - `actor: object or object or object or 8 more` @@ -10794,23 +10527,69 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `failed: boolean` + - `credential_id: string` - True when the export request did not complete successfully. + The replacement credential, e.g. "apc_01HX...". + + - `credential_type: string` + + The kind of credential, e.g. "bearer", "basic", "github_app", "mtls". + + - `destinations_repointed: number` + + The number of agent proxy destinations that referenced the old credential and now reference the replacement. + + - `display_name: string` + + The credential's display name. + + - `previous_credential_id: string` + + The credential that was replaced, e.g. "apc_01HX...". + + - `profile_id: string` + + The agent proxy profile the credential belongs to, e.g. "capp_01HX...". + + - `rules_repointed: number` + + The number of agent proxy rules that referenced the old credential and now reference the replacement. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `created_at: optional string` + - `authorization_basis: optional object or null` - When this activity occurred. + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. - format: date-time + - `slack_channel_id: string` - - `hour: optional string or null` + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". - The UTC hour that was exported. + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + + - `created_at: optional string` + + When this activity occurred. format: date-time @@ -10822,13 +10601,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_network_events_listed"` + - `type: optional "ccr_agent_proxy_credential_rotated"` - default: ccr_agent_proxy_network_events_listed + default: ccr_agent_proxy_credential_rotated - - `CcrAgentProxyProfileBound object` + - `CcrAgentProxyCredentialUpdated object` - A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope. + A Claude Code agent proxy credential's settings were updated. Only the display name and the allowed host patterns can be updated; the secret material can only be replaced through a rotation. - `actor: object or object or object or 8 more` @@ -11041,28 +10820,64 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `profile_id: string` + - `credential_id: string` - The profile that was bound, e.g. "capp_01HX...". + The credential that was updated, e.g. "apc_01HX...". - - `scope_id: string` + - `display_name: string` - The identifier of the scope the profile was bound to. + The credential's display name after the update. - - `scope_kind: string` + - `host_constraint_truncated: boolean` - The kind of scope the profile was bound to: "organization", "environment", "account", or "agent". + Whether host_constraint was capped and omits some of the configured host name patterns. + + - `profile_id: string` + + The agent proxy profile the credential belongs to, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `authorization_basis: optional object or null` + + CcrAgentProxyCredentialAuthorizationBasis records how the actor was authorized to perform a Claude Code agent proxy credential operation. Populated only when the operation was authorized against a specific actor's permissions; absent on system-initiated operations (for example, an automatic token rotation) and on operations authorized by a provisioning link rather than the actor's own permissions. + + - `slack_channel_id: string` + + The Slack channel the credential's agent proxy profile is bound to, e.g. "C01ABC...". + + - `slack_enterprise_id: string` + + The Slack Enterprise Grid organization containing the workspace, e.g. "E01ABC...". Empty when the workspace does not belong to an Enterprise Grid organization. + + - `slack_team_id: string` + + The Slack workspace the credential's agent proxy profile is bound to, e.g. "T01ABC...". + + - `via_entitlement_leg: boolean` + + True when the actor's permission came from a custom role assigned in Roles & permissions. False when it came from a built-in Owner or Admin role. + + - `via_full_manage: boolean` + + True when the actor held the organization-wide Claude Tag management permission. False when the actor was instead authorized via the per-channel `claude_tag_channel:manage` permission for the Slack channel identified below. + + - `granting_role_ids: optional array of string` + + The tagged IDs of the custom roles that granted the actor the per-channel `claude_tag_channel:manage` permission, e.g. "rbac_role_01HX...". Empty when `via_full_manage` is true (the actor was authorized by the organization-wide permission, so no per-channel role grant was evaluated). + - `created_at: optional string` When this activity occurred. format: date-time + - `host_constraint: optional array of string` + + The host name patterns the credential may be sent to after the update, e.g. "api.example.com" or "*.example.com". Populated only when the update changed them. At most 100 entries are included; host_constraint_truncated indicates when the configured set is larger. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11071,13 +10886,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_bound"` + - `type: optional "ccr_agent_proxy_credential_updated"` - default: ccr_agent_proxy_profile_bound + default: ccr_agent_proxy_credential_updated - - `CcrAgentProxyProfileCreated object` + - `updated_fields: optional array of string` - A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization. + Names of the settings included in the update: "display_name", "host_constraint". + + - `CcrAgentProxyDestinationDeleted object` + + An agent proxy destination was deleted. - `actor: object or object or object or 8 more` @@ -11290,60 +11109,32 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` + - `deleted_with_profile: boolean` - The profile's display name at creation time. + True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyDestination call. - - `profile_id: string` + - `destination_id: string` - The profile that was created, e.g. "capp_01HX...". + The destination that was deleted, e.g. "apd_01HX...". - - `slug: string` + - `profile_id: string` - The profile's URL-safe identifier, unique within the organization. + The agent proxy profile the destination belonged to, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `cascade_trigger_credential_id: optional string or null` + + Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the destination's client_tls_credential was the deleted credential). Unset for a direct DeleteAgentProxyDestination call and for the profile-delete cascade (see deleted_with_profile). + - `created_at: optional string` When this activity occurred. format: date-time - - `github_access: optional array of object` - - The GitHub repository access the profile grants, one entry per GitHub App installation. Empty when the profile grants no GitHub access. - - - `access_mode: string` - - How repository access is granted: "none" (no access), "list" (exactly the repositories in repos), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. - - - `github_installation_id: number` - - The GitHub App installation the access applies to. - - - `repo_count: number` - - The total number of repositories granted, including any omitted from repos. - - - `repos_truncated: boolean` - - Whether repos was capped and omits some of the granted repositories. - - - `ghe_configuration_id: optional number or null` - - The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. - - - `repo_ids: optional array of number` - - The numeric GitHub repository IDs the profile grants access to, in the same order as repos (and subject to the same 100-entry cap). These IDs are the authoritative identity of the granted repositories — access is enforced against them, not against the display names in repos. - - - `repos: optional array of string` - - Repository names (owner/name) the profile grants access to, populated when access_mode is "list". Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids are the authoritative identity of the granted repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when the granted set is larger. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11352,13 +11143,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_created"` + - `type: optional "ccr_agent_proxy_destination_deleted"` - default: ccr_agent_proxy_profile_created + default: ccr_agent_proxy_destination_deleted - - `CcrAgentProxyProfileDeleted object` + - `CcrAgentProxyNetworkEventsListed object` - A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to. + A Claude Code network activity export was accessed for the given hour. - `actor: object or object or object or 8 more` @@ -11571,33 +11362,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_credential_count: number` - - Number of credentials deleted together with the profile — deleting a profile also deletes the credentials attached to it. Each deleted credential additionally emits its own ccr_agent_proxy_credential_deleted activity, at most 100 per profile deletion. Best-effort: when deleted_credentials_unknown is true the count could not be determined and 0 here does not mean the profile had no credentials. - - - `deleted_credentials_unknown: boolean` - - Whether the number of credentials deleted with the profile could not be determined. When true, deleted_credential_count is 0 and no per-credential deletion activities were emitted, even though the deletion may have destroyed credentials. - - - `deleted_destination_count: number` - - Number of destinations deleted together with the profile. Each deleted destination additionally emits its own ccr_agent_proxy_destination_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_destinations_unknown is true the count could not be determined and 0 here does not mean the profile had no destinations. - - - `deleted_destinations_unknown: boolean` - - Whether the number of destinations deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - - `deleted_rule_count: number` - - Number of rules deleted together with the profile. Each deleted rule additionally emits its own ccr_agent_proxy_rule_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_rules_unknown is true the count could not be determined and 0 here does not mean the profile had no rules. - - - `deleted_rules_unknown: boolean` - - Whether the number of rules deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - - `profile_id: string` + - `failed: boolean` - The profile that was deleted, e.g. "capp_01HX...". + True when the export request did not complete successfully. - `id: optional string` @@ -11609,6 +11376,12 @@ compliance activities that can be filtered by various criteria. format: date-time + - `hour: optional string or null` + + The UTC hour that was exported. + + format: date-time + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -11617,13 +11390,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_deleted"` + - `type: optional "ccr_agent_proxy_network_events_listed"` - default: ccr_agent_proxy_profile_deleted + default: ccr_agent_proxy_network_events_listed - - `CcrAgentProxyProfileUnbound object` + - `CcrAgentProxyProfileBound object` - A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope. + A Claude Code agent proxy profile was bound to a scope, applying its policy to Claude Code sessions in that scope. - `actor: object or object or object or 8 more` @@ -11838,15 +11611,15 @@ compliance activities that can be filtered by various criteria. - `profile_id: string` - The profile that was unbound, e.g. "capp_01HX...". + The profile that was bound, e.g. "capp_01HX...". - `scope_id: string` - The identifier of the scope the profile was unbound from. + The identifier of the scope the profile was bound to. - `scope_kind: string` - The kind of scope the profile was unbound from: "organization", "environment", "account", or "agent". + The kind of scope the profile was bound to: "organization", "environment", "account", or "agent". - `id: optional string` @@ -11866,13 +11639,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_unbound"` + - `type: optional "ccr_agent_proxy_profile_bound"` - default: ccr_agent_proxy_profile_unbound + default: ccr_agent_proxy_profile_bound - - `CcrAgentProxyProfileUpdated object` + - `CcrAgentProxyProfileCreated object` - A Claude Code agent proxy profile's configuration was updated. + A Claude Code agent proxy profile was created. Agent proxy profiles are named, reusable bundles of access policy that administrators bind to parts of the organization. - `actor: object or object or object or 8 more` @@ -12085,9 +11858,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `display_name: string` + + The profile's display name at creation time. + - `profile_id: string` - The profile that was updated, e.g. "capp_01HX...". + The profile that was created, e.g. "capp_01HX...". + + - `slug: string` + + The profile's URL-safe identifier, unique within the organization. - `id: optional string` @@ -12099,49 +11880,37 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_access_changes: optional array of object` + - `github_access: optional array of object` - How the profile's GitHub repository access changed, one entry per GitHub App installation whose access changed. Empty when the update did not change GitHub access. + The GitHub repository access the profile grants, one entry per GitHub App installation. Empty when the profile grants no GitHub access. - `access_mode: string` - How repository access is granted after the change: "none" (no access), "list" (access is restricted to an explicit repository list — repos_added/repos_removed carry this change's delta and repo_count the post-change total), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. + How repository access is granted: "none" (no access), "list" (exactly the repositories in repos), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. - `github_installation_id: number` - The GitHub App installation the change applies to. + The GitHub App installation the access applies to. - `repo_count: number` - The total number of repositories granted after the change. + The total number of repositories granted, including any omitted from repos. - `repos_truncated: boolean` - Whether repos_added or repos_removed was capped and omits some of the changed repositories. + Whether repos was capped and omits some of the granted repositories. - `ghe_configuration_id: optional number or null` The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. - - `previous_access_mode: optional string or null` - - How repository access was granted before the change. Present only when the access mode changed. - - - `repo_ids_added: optional array of number` - - The numeric GitHub repository IDs added to the granted set, in the same order as repos_added (and subject to the same 100-entry cap). These IDs are the authoritative identity of the added repositories — access is enforced against them, not against the display names in repos_added. - - - `repo_ids_removed: optional array of number` - - The numeric GitHub repository IDs removed from the granted set, in the same order as repos_removed (and subject to the same 100-entry cap). These IDs are the authoritative identity of the removed repositories. - - - `repos_added: optional array of string` + - `repo_ids: optional array of number` - Repository names (owner/name) added to the granted set. Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids_added are the authoritative identity of the added repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when more were added. Empty when the change involves "all" access, which grants every repository regardless of any explicit list. + The numeric GitHub repository IDs the profile grants access to, in the same order as repos (and subject to the same 100-entry cap). These IDs are the authoritative identity of the granted repositories — access is enforced against them, not against the display names in repos. - - `repos_removed: optional array of string` + - `repos: optional array of string` - Repository names (owner/name) removed from the granted set. Same rendering, cap, and "all" handling as repos_added; repo_ids_removed carries the authoritative identity of the removed repositories. + Repository names (owner/name) the profile grants access to, populated when access_mode is "list". Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids are the authoritative identity of the granted repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when the granted set is larger. - `organization_id: optional string or null` @@ -12151,17 +11920,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_profile_updated"` - - default: ccr_agent_proxy_profile_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_proxy_profile_created"` - Names of the configuration fields included in the update, e.g. "display_name", "github_installation_permissions". + default: ccr_agent_proxy_profile_created - - `CcrAgentProxyProvisioningCredentialRejected object` + - `CcrAgentProxyProfileDeleted object` - An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution. + A Claude Code agent proxy profile was deleted, removing its policy from everything it was bound to. - `actor: object or object or object or 8 more` @@ -12374,25 +12139,33 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` + - `deleted_credential_count: number` - The credential the member submitted, e.g. "apc_01HX...". + Number of credentials deleted together with the profile — deleting a profile also deletes the credentials attached to it. Each deleted credential additionally emits its own ccr_agent_proxy_credential_deleted activity, at most 100 per profile deletion. Best-effort: when deleted_credentials_unknown is true the count could not be determined and 0 here does not mean the profile had no credentials. - - `link_id: string` + - `deleted_credentials_unknown: boolean` - The provisioning link's identifier. + Whether the number of credentials deleted with the profile could not be determined. When true, deleted_credential_count is 0 and no per-credential deletion activities were emitted, even though the deletion may have destroyed credentials. - - `profile_id: string` + - `deleted_destination_count: number` - The agent proxy profile the credential lived in, e.g. "capp_01HX...". + Number of destinations deleted together with the profile. Each deleted destination additionally emits its own ccr_agent_proxy_destination_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_destinations_unknown is true the count could not be determined and 0 here does not mean the profile had no destinations. - - `rule_id: string` + - `deleted_destinations_unknown: boolean` - The disabled rule that was deleted alongside the credential, e.g. "apr_01HX...". + Whether the number of destinations deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. - - `submitted_by_user_id: string` + - `deleted_rule_count: number` - The tagged account ID of the user who originally submitted the credential, e.g. "user_01HX...". + Number of rules deleted together with the profile. Each deleted rule additionally emits its own ccr_agent_proxy_rule_deleted activity with deleted_with_profile set, at most 100 per profile deletion. Best-effort: when deleted_rules_unknown is true the count could not be determined and 0 here does not mean the profile had no rules. + + - `deleted_rules_unknown: boolean` + + Whether the number of rules deleted with the profile could not be determined. Same semantics as deleted_credentials_unknown. + + - `profile_id: string` + + The profile that was deleted, e.g. "capp_01HX...". - `id: optional string` @@ -12412,13 +12185,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_credential_rejected"` + - `type: optional "ccr_agent_proxy_profile_deleted"` - default: ccr_agent_proxy_provisioning_credential_rejected + default: ccr_agent_proxy_profile_deleted - - `CcrAgentProxyProvisioningLinkEnabled object` + - `CcrAgentProxyProfileUnbound object` - An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event. + A Claude Code agent proxy profile was unbound from a scope, removing its policy from Claude Code sessions in that scope. - `actor: object or object or object or 8 more` @@ -12631,21 +12404,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_id: string` - - The credential the member submitted, e.g. "apc_01HX...". - - - `link_id: string` + - `profile_id: string` - The provisioning link's identifier. + The profile that was unbound, e.g. "capp_01HX...". - - `profile_id: string` + - `scope_id: string` - The agent proxy profile the credential lives in, e.g. "capp_01HX...". + The identifier of the scope the profile was unbound from. - - `rule_id: string` + - `scope_kind: string` - The rule that was flipped to enforce, e.g. "apr_01HX...". + The kind of scope the profile was unbound from: "organization", "environment", "account", or "agent". - `id: optional string` @@ -12665,13 +12434,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_enabled"` + - `type: optional "ccr_agent_proxy_profile_unbound"` - default: ccr_agent_proxy_provisioning_link_enabled + default: ccr_agent_proxy_profile_unbound - - `CcrAgentProxyProvisioningLinkGenerated object` + - `CcrAgentProxyProfileUpdated object` - An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role. + A Claude Code agent proxy profile's configuration was updated. - `actor: object or object or object or 8 more` @@ -12884,13 +12653,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `link_id: string` - - The provisioning link's identifier. Correlation only; redemption requires an org-member session, so this is not a bearer credential. - - `profile_id: string` - The agent proxy profile the submitted credential will be created in, e.g. "capp_01HX...". + The profile that was updated, e.g. "capp_01HX...". - `id: optional string` @@ -12902,6 +12667,50 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_access_changes: optional array of object` + + How the profile's GitHub repository access changed, one entry per GitHub App installation whose access changed. Empty when the update did not change GitHub access. + + - `access_mode: string` + + How repository access is granted after the change: "none" (no access), "list" (access is restricted to an explicit repository list — repos_added/repos_removed carry this change's delta and repo_count the post-change total), or "all" — a legacy value for policies created before per-repository grants were required; it can no longer be assigned. + + - `github_installation_id: number` + + The GitHub App installation the change applies to. + + - `repo_count: number` + + The total number of repositories granted after the change. + + - `repos_truncated: boolean` + + Whether repos_added or repos_removed was capped and omits some of the changed repositories. + + - `ghe_configuration_id: optional number or null` + + The GitHub host configuration this installation belongs to. Distinguishes installations with the same numeric installation ID across github.com and GitHub Enterprise Server hosts. Absent for github.com installations. + + - `previous_access_mode: optional string or null` + + How repository access was granted before the change. Present only when the access mode changed. + + - `repo_ids_added: optional array of number` + + The numeric GitHub repository IDs added to the granted set, in the same order as repos_added (and subject to the same 100-entry cap). These IDs are the authoritative identity of the added repositories — access is enforced against them, not against the display names in repos_added. + + - `repo_ids_removed: optional array of number` + + The numeric GitHub repository IDs removed from the granted set, in the same order as repos_removed (and subject to the same 100-entry cap). These IDs are the authoritative identity of the removed repositories. + + - `repos_added: optional array of string` + + Repository names (owner/name) added to the granted set. Names are display-only labels resolved when the event was recorded and may lag a repository rename; the entries in repo_ids_added are the authoritative identity of the added repositories. A repository whose name is unavailable is listed as its numeric GitHub repository ID instead. At most 100 entries are included; repos_truncated indicates when more were added. Empty when the change involves "all" access, which grants every repository regardless of any explicit list. + + - `repos_removed: optional array of string` + + Repository names (owner/name) removed from the granted set. Same rendering, cap, and "all" handling as repos_added; repo_ids_removed carries the authoritative identity of the removed repositories. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -12910,13 +12719,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_generated"` + - `type: optional "ccr_agent_proxy_profile_updated"` - default: ccr_agent_proxy_provisioning_link_generated + default: ccr_agent_proxy_profile_updated - - `CcrAgentProxyProvisioningLinkRevoked object` + - `updated_fields: optional array of string` - An organization owner revoked an unfilled agent proxy provisioning link. + Names of the configuration fields included in the update, e.g. "display_name", "github_installation_permissions". + + - `CcrAgentProxyProvisioningCredentialRejected object` + + An organization owner rejected a credential that a teammate submitted via an agent proxy provisioning link: the credential and its disabled rule were deleted and the link was revoked. The actor is the owner; the submitter is recorded for attribution. - `actor: object or object or object or 8 more` @@ -13129,13 +12942,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `credential_id: string` + + The credential the member submitted, e.g. "apc_01HX...". + - `link_id: string` The provisioning link's identifier. - `profile_id: string` - The agent proxy profile the link targeted, e.g. "capp_01HX...". + The agent proxy profile the credential lived in, e.g. "capp_01HX...". + + - `rule_id: string` + + The disabled rule that was deleted alongside the credential, e.g. "apr_01HX...". + + - `submitted_by_user_id: string` + + The tagged account ID of the user who originally submitted the credential, e.g. "user_01HX...". - `id: optional string` @@ -13155,13 +12980,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_revoked"` + - `type: optional "ccr_agent_proxy_provisioning_credential_rejected"` - default: ccr_agent_proxy_provisioning_link_revoked + default: ccr_agent_proxy_provisioning_credential_rejected - - `CcrAgentProxyProvisioningLinkSubmitted object` + - `CcrAgentProxyProvisioningLinkEnabled object` - A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created. + An organization owner enabled a credential that a teammate submitted via an agent proxy provisioning link: the disabled rule created at submission was switched to enforce, so the credential now takes traffic. The actor is the owner; the submitter is the actor on the prior ccr_agent_proxy_provisioning_link_submitted event. - `actor: object or object or object or 8 more` @@ -13376,11 +13201,7 @@ compliance activities that can be filtered by various criteria. - `credential_id: string` - The credential that was created, e.g. "apc_01HX...". - - - `credential_type: string` - - The kind of credential, e.g. "bearer" or "basic". + The credential the member submitted, e.g. "apc_01HX...". - `link_id: string` @@ -13388,7 +13209,11 @@ compliance activities that can be filtered by various criteria. - `profile_id: string` - The agent proxy profile the credential was created in, e.g. "capp_01HX...". + The agent proxy profile the credential lives in, e.g. "capp_01HX...". + + - `rule_id: string` + + The rule that was flipped to enforce, e.g. "apr_01HX...". - `id: optional string` @@ -13400,10 +13225,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `host_constraint: optional array of string` - - The host name patterns the credential may be sent to. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -13412,13 +13233,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_provisioning_link_submitted"` + - `type: optional "ccr_agent_proxy_provisioning_link_enabled"` - default: ccr_agent_proxy_provisioning_link_submitted + default: ccr_agent_proxy_provisioning_link_enabled - - `CcrAgentProxyRuleDeleted object` + - `CcrAgentProxyProvisioningLinkGenerated object` - An agent proxy rule was deleted. + An organization owner generated a one-time agent proxy credential provisioning link so a teammate can submit a credential into the target agent proxy profile without holding the owner role. - `actor: object or object or object or 8 more` @@ -13631,26 +13452,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_with_profile: boolean` + - `link_id: string` - True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyRule call or a provisioning-link reject (RejectAgentProxyProvisionedCredential) — the reject case also emits CcrAgentProxyProvisioningCredentialRejected with the same rule_id in the same batch. + The provisioning link's identifier. Correlation only; redemption requires an org-member session, so this is not a bearer credential. - `profile_id: string` - The agent proxy profile the rule belonged to, e.g. "capp_01HX...". - - - `rule_id: string` - - The rule that was deleted, e.g. "apr_01HX...". + The agent proxy profile the submitted credential will be created in, e.g. "capp_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `cascade_trigger_credential_id: optional string or null` - - Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the rule inject_credential-referenced the deleted credential). Unset for a direct DeleteAgentProxyRule call, for the profile-delete cascade (see deleted_with_profile), and for a provisioning-link reject that removed the provisioned rule. - - `created_at: optional string` When this activity occurred. @@ -13665,13 +13478,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_proxy_rule_deleted"` + - `type: optional "ccr_agent_proxy_provisioning_link_generated"` - default: ccr_agent_proxy_rule_deleted + default: ccr_agent_proxy_provisioning_link_generated - - `CcrAgentSlackAccessScopeCreated object` + - `CcrAgentProxyProvisioningLinkRevoked object` - A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to. + An organization owner revoked an unfilled agent proxy provisioning link. - `actor: object or object or object or 8 more` @@ -13884,21 +13697,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was granted access, e.g. "cagt_01HX...". - - - `can_write: boolean` - - Whether the grant includes permission to post messages in the channel, in addition to reading it. - - - `slack_channel_id: string` + - `link_id: string` - The Slack channel the agent was granted access to, e.g. "C01ABC...". Empty when the grant covers the entire workspace. + The provisioning link's identifier. - - `slack_team_id: string` + - `profile_id: string` - The Slack workspace containing the channel, e.g. "T01ABC...". + The agent proxy profile the link targeted, e.g. "capp_01HX...". - `id: optional string` @@ -13918,13 +13723,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_access_scope_created"` + - `type: optional "ccr_agent_proxy_provisioning_link_revoked"` - default: ccr_agent_slack_access_scope_created + default: ccr_agent_proxy_provisioning_link_revoked - - `CcrAgentSlackAccessScopeDeleted object` + - `CcrAgentProxyProvisioningLinkSubmitted object` - A Claude Code agent's access to an additional Slack channel was revoked. + A teammate submitted a credential via an agent proxy provisioning link. The credential and a disabled rule are created; the credential takes traffic only after an organization owner enables the submitted credential. This event records the link-mediated lifecycle; the credential itself additionally emits ccr_agent_proxy_credential_created. - `actor: object or object or object or 8 more` @@ -14137,17 +13942,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `credential_id: string` - The agent whose access was revoked, e.g. "cagt_01HX...". + The credential that was created, e.g. "apc_01HX...". - - `slack_channel_id: string` + - `credential_type: string` - The Slack channel the agent's access was revoked from, e.g. "C01ABC...". Empty when the revoked grant covered the entire workspace. + The kind of credential, e.g. "bearer" or "basic". - - `slack_team_id: string` + - `link_id: string` - The Slack workspace containing the channel, e.g. "T01ABC...". + The provisioning link's identifier. + + - `profile_id: string` + + The agent proxy profile the credential was created in, e.g. "capp_01HX...". - `id: optional string` @@ -14159,6 +13968,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `host_constraint: optional array of string` + + The host name patterns the credential may be sent to. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -14167,13 +13980,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_access_scope_deleted"` + - `type: optional "ccr_agent_proxy_provisioning_link_submitted"` - default: ccr_agent_slack_access_scope_deleted + default: ccr_agent_proxy_provisioning_link_submitted - - `CcrAgentSlackBindingCreated object` + - `CcrAgentProxyRuleDeleted object` - A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent. + An agent proxy rule was deleted. - `actor: object or object or object or 8 more` @@ -14386,22 +14199,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deleted_with_profile: boolean` - The agent the binding was created for, e.g. "cagt_01HX...". + True when this deletion happened as part of deleting the whole profile (profile_id names the deleted profile). At most one of deleted_with_profile / cascade_trigger_credential_id is set; both unset means a direct DeleteAgentProxyRule call or a provisioning-link reject (RejectAgentProxyProvisionedCredential) — the reject case also emits CcrAgentProxyProvisioningCredentialRejected with the same rule_id in the same batch. - - `slack_channel_id: string` + - `profile_id: string` - The Slack channel the agent was assigned to, e.g. "C01ABC...". Empty when the agent was assigned to the entire workspace. + The agent proxy profile the rule belonged to, e.g. "capp_01HX...". - - `slack_team_id: string` + - `rule_id: string` - The Slack workspace the agent was assigned to, e.g. "T01ABC...". + The rule that was deleted, e.g. "apr_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `cascade_trigger_credential_id: optional string or null` + + Set when this deletion was triggered by a cascading DeleteAgentProxyCredential (the rule inject_credential-referenced the deleted credential). Unset for a direct DeleteAgentProxyRule call, for the profile-delete cascade (see deleted_with_profile), and for a provisioning-link reject that removed the provisioned rule. + - `created_at: optional string` When this activity occurred. @@ -14416,13 +14233,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_binding_created"` + - `type: optional "ccr_agent_proxy_rule_deleted"` - default: ccr_agent_slack_binding_created + default: ccr_agent_proxy_rule_deleted - - `CcrAgentSlackBindingDeleted object` + - `CcrAgentSlackAccessScopeCreated object` - A Claude Code agent's assignment to a Slack channel or workspace was removed. + A Claude Code agent was granted access to read or write in an additional Slack channel beyond the one it is assigned to. - `actor: object or object or object or 8 more` @@ -14637,15 +14454,19 @@ compliance activities that can be filtered by various criteria. - `agent_id: string` - The agent the binding was removed from, e.g. "cagt_01HX...". + The agent that was granted access, e.g. "cagt_01HX...". + + - `can_write: boolean` + + Whether the grant includes permission to post messages in the channel, in addition to reading it. - `slack_channel_id: string` - The Slack channel the agent was unassigned from, e.g. "C01ABC...". Empty when the assignment covered the entire workspace. + The Slack channel the agent was granted access to, e.g. "C01ABC...". Empty when the grant covers the entire workspace. - `slack_team_id: string` - The Slack workspace the agent was unassigned from, e.g. "T01ABC...". + The Slack workspace containing the channel, e.g. "T01ABC...". - `id: optional string` @@ -14665,13 +14486,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_agent_slack_binding_deleted"` + - `type: optional "ccr_agent_slack_access_scope_created"` - default: ccr_agent_slack_binding_deleted + default: ccr_agent_slack_access_scope_created - - `CcrAgentUpdated object` + - `CcrAgentSlackAccessScopeDeleted object` - A Claude Code agent's configuration was updated. Also emitted with updated_fields ["is_virtual"] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it. + A Claude Code agent's access to an additional Slack channel was revoked. - `actor: object or object or object or 8 more` @@ -14886,15 +14707,15 @@ compliance activities that can be filtered by various criteria. - `agent_id: string` - The agent that was updated, e.g. "cagt_01HX...". + The agent whose access was revoked, e.g. "cagt_01HX...". - - `default_source_urls_truncated: boolean` + - `slack_channel_id: string` - Whether default_source_urls was capped and omits some of the granted repositories. + The Slack channel the agent's access was revoked from, e.g. "C01ABC...". Empty when the revoked grant covered the entire workspace. - - `omitted_source_url_count: number` + - `slack_team_id: string` - Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. + The Slack workspace containing the channel, e.g. "T01ABC...". - `id: optional string` @@ -14906,14 +14727,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_source_urls: optional array of string` - - The agent's default repository URLs after the update, reduced to scheme, host, and path — credentials and query parameters are never included. Populated only when the update changed them — "default_source_urls" appears in updated_fields. Empty while listed in updated_fields AND omitted_source_url_count is 0 means all default repositories were removed. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. - - - `guest_policy: optional string or null` - - The agent's guest-user response policy after the update: "allow", "restrict", "channel" (the agent responds, using only that channel's own content and configuration), or "default" when the update removed the agent-specific policy so the agent inherits the surrounding default. Present only when the update changed it. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -14922,21 +14735,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `slack_alias: optional string or null` - - The agent's Slack trigger word after the update. Present only when the update changed it. An empty value means the agent responds to bare "@Claude" mentions. - - - `type: optional "ccr_agent_updated"` - - default: ccr_agent_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_agent_slack_access_scope_deleted"` - Names of the configuration fields included in the update, e.g. "display_name", "system_prompt_addendum", "guest_policy". Includes "is_virtual" when this update was the first administrator action on an auto-provisioned agent — a durable state change even when no other field was supplied. + default: ccr_agent_slack_access_scope_deleted - - `CcrRoleChannelAssignmentDeleted object` + - `CcrAgentSlackBindingCreated object` - CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels). + A Claude Code agent was assigned to a Slack channel or workspace as its dedicated agent. - `actor: object or object or object or 8 more` @@ -15149,13 +14954,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `previous_channel_count: number` + - `agent_id: string` - Number of (team, channel) pairs the role was assigned before deletion. + The agent the binding was created for, e.g. "cagt_01HX...". - - `role_id: string` + - `slack_channel_id: string` - Tagged ID of the role whose channel assignment was removed. + The Slack channel the agent was assigned to, e.g. "C01ABC...". Empty when the agent was assigned to the entire workspace. + + - `slack_team_id: string` + + The Slack workspace the agent was assigned to, e.g. "T01ABC...". - `id: optional string` @@ -15175,13 +14984,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_role_channel_assignment_deleted"` + - `type: optional "ccr_agent_slack_binding_created"` - default: ccr_role_channel_assignment_deleted + default: ccr_agent_slack_binding_created - - `CcrRoleChannelAssignmentUpdated object` + - `CcrAgentSlackBindingDeleted object` - CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface. + A Claude Code agent's assignment to a Slack channel or workspace was removed. - `actor: object or object or object or 8 more` @@ -15394,26 +15203,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `channel_count: number` + - `agent_id: string` - Number of channels assigned after the write. + The agent the binding was removed from, e.g. "cagt_01HX...". - - `previous_channel_count: number` + - `slack_channel_id: string` - Number of channels assigned before the write. + The Slack channel the agent was unassigned from, e.g. "C01ABC...". Empty when the assignment covered the entire workspace. - - `role_id: string` + - `slack_team_id: string` - Tagged ID of the role whose channel assignment was written. + The Slack workspace the agent was unassigned from, e.g. "T01ABC...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `agent_ids: optional array of string` - - The channel-silo agents (cagt_...) assigned after the write. Capped at 100 entries; channel_count carries the uncapped total. - - `created_at: optional string` When this activity occurred. @@ -15428,13 +15233,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_role_channel_assignment_updated"` + - `type: optional "ccr_agent_slack_binding_deleted"` - default: ccr_role_channel_assignment_updated + default: ccr_agent_slack_binding_deleted - - `CcrSessionCreated object` + - `CcrAgentUpdated object` - A Claude Code session was created. A session is one coding interaction with Claude. + A Claude Code agent's configuration was updated. Also emitted with updated_fields ["is_virtual"] alone when an auto-provisioned agent is promoted to a configured one, whether by an update request targeting it or by binding an agent proxy profile to it. - `actor: object or object or object or 8 more` @@ -15647,17 +15452,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `agent_id: string` - The session that was created, e.g. "cse_01HX...". + The agent that was updated, e.g. "cagt_01HX...". - - `id: optional string` + - `default_source_urls_truncated: boolean` - Unique identifier for the activity e.g. 'activity_abcd1234' + Whether default_source_urls was capped and omits some of the granted repositories. - - `agent_id: optional string or null` + - `omitted_source_url_count: number` - The Claude Code agent attached to the session, e.g. "cagt_01HX...". Omitted when the session was created without an agent. + Number of default repository entries that could not be safely rendered as a credential-free URL and were omitted from default_source_urls. A non-zero value with an empty list means repositories were granted but could not be displayed — not that all repositories were removed. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -15665,6 +15474,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `default_source_urls: optional array of string` + + The agent's default repository URLs after the update, reduced to scheme, host, and path — credentials and query parameters are never included. Populated only when the update changed them — "default_source_urls" appears in updated_fields. Empty while listed in updated_fields AND omitted_source_url_count is 0 means all default repositories were removed. At most 100 entries are included; default_source_urls_truncated indicates when more were granted. + + - `guest_policy: optional string or null` + + The agent's response policy for Slack channels that include guest users and Slack Connect channels shared with other organizations, after the update: "allow", "restrict", "channel" (the agent responds, using only that channel's own content and configuration), or "default" when the update removed the agent-specific policy so the agent inherits the surrounding default. In Slack Connect channels "allow" gives at most "channel" access. Present only when the update changed it. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -15673,13 +15490,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_created"` + - `slack_alias: optional string or null` - default: ccr_session_created + The agent's Slack trigger word after the update. Present only when the update changed it. An empty value means the agent responds to bare "@Claude" mentions. - - `CcrSessionDeleted object` + - `type: optional "ccr_agent_updated"` - A Claude Code session was deleted. + default: ccr_agent_updated + + - `updated_fields: optional array of string` + + Names of the configuration fields included in the update, e.g. "display_name", "system_prompt_addendum", "guest_policy". Includes "is_virtual" when this update was the first administrator action on an auto-provisioned agent — a durable state change even when no other field was supplied. + + - `CcrRoleChannelAssignmentDeleted object` + + CcrRoleChannelAssignmentDeleted is emitted when an org owner/admin removes an RBAC role's channel assignment row (the role reverts to granting zero channels). - `actor: object or object or object or 8 more` @@ -15892,9 +15717,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `previous_channel_count: number` - The session that was deleted, e.g. "cse_01HX...". + Number of (team, channel) pairs the role was assigned before deletion. + + - `role_id: string` + + Tagged ID of the role whose channel assignment was removed. - `id: optional string` @@ -15914,13 +15743,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_deleted"` + - `type: optional "ccr_role_channel_assignment_deleted"` - default: ccr_session_deleted + default: ccr_role_channel_assignment_deleted - - `CcrSessionUpdated object` + - `CcrRoleChannelAssignmentUpdated object` - A Claude Code session's settings were updated. + CcrRoleChannelAssignmentUpdated is emitted when an org owner/admin sets or replaces the list of Slack channels an RBAC role's holders may configure via the delegated Claude-in-Slack channel-manage surface. - `actor: object or object or object or 8 more` @@ -16133,14 +15962,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `channel_count: number` - The session that was updated, e.g. "cse_01HX...". + Number of channels assigned after the write. + + - `previous_channel_count: number` + + Number of channels assigned before the write. + + - `role_id: string` + + Tagged ID of the role whose channel assignment was written. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `agent_ids: optional array of string` + + The channel-silo agents (cagt_...) assigned after the write. Capped at 100 entries; channel_count carries the uncapped total. + - `created_at: optional string` When this activity occurred. @@ -16155,17 +15996,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ccr_session_updated"` - - default: ccr_session_updated - - - `updated_fields: optional array of string` + - `type: optional "ccr_role_channel_assignment_updated"` - Names of the fields included in the update, e.g. "add_tags", "remove_tags". + default: ccr_role_channel_assignment_updated - - `ClaudeChatSettingsUpdated object` + - `CcrSessionCreated object` - User updated the settings for a conversation. + A Claude Code session was created. A session is one coding interaction with Claude. - `actor: object or object or object or 8 more` @@ -16378,15 +16215,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `session_id: string` + + The session that was created, e.g. "cse_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` + - `agent_id: optional string or null` - Project ID this chat belongs to, if any + The Claude Code agent attached to the session, e.g. "cagt_01HX...". Omitted when the session was created without an agent. - `created_at: optional string` @@ -16402,13 +16241,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_settings_updated"` + - `type: optional "ccr_session_created"` - default: claude_chat_settings_updated + default: ccr_session_created - - `ClaudeChatSnapshotCreated object` + - `CcrSessionDeleted object` - User created/shared a chat snapshot. + A Claude Code session was deleted. - `actor: object or object or object or 8 more` @@ -16621,9 +16460,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `session_id: string` - - `claude_chat_snapshot_id: string` + The session that was deleted, e.g. "cse_01HX...". - `id: optional string` @@ -16643,13 +16482,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_created"` + - `type: optional "ccr_session_deleted"` - default: claude_chat_snapshot_created + default: ccr_session_deleted - - `ClaudeChatSnapshotDeleted object` + - `CcrSessionUpdated object` - User deleted/unshared a chat snapshot. + A Claude Code session's settings were updated. - `actor: object or object or object or 8 more` @@ -16862,14 +16701,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_snapshot_id: string` + - `session_id: string` + + The session that was updated, e.g. "cse_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -16884,13 +16723,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_deleted"` + - `type: optional "ccr_session_updated"` - default: claude_chat_snapshot_deleted + default: ccr_session_updated - - `ClaudeChatSnapshotViewed object` + - `updated_fields: optional array of string` - User viewed a chat snapshot (authenticated or public/unauthenticated). + Names of the fields included in the update, e.g. "add_tags", "remove_tags". + + - `ClaudeChatSettingsUpdated object` + + User updated the settings for a conversation. - `actor: object or object or object or 8 more` @@ -17103,13 +16946,15 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_snapshot_id: string` + - `claude_chat_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` + - `claude_project_id: optional string or null` + + Project ID this chat belongs to, if any - `created_at: optional string` @@ -17125,13 +16970,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_snapshot_viewed"` + - `type: optional "claude_chat_settings_updated"` - default: claude_chat_snapshot_viewed + default: claude_chat_settings_updated - - `ClaudeArtifactDuplicated object` + - `ClaudeChatSnapshotCreated object` - A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified. + User created/shared a chat snapshot. - `actor: object or object or object or 8 more` @@ -17344,13 +17189,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_artifact_id: string` - - Tagged ID of the new artifact created by the duplication. It is owned by the actor and is independent of the source artifact. - - - `source_claude_artifact_id: string` + - `claude_chat_id: string` - Tagged ID of the artifact that was copied. + - `claude_chat_snapshot_id: string` - `id: optional string` @@ -17370,17 +17211,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `source_claude_artifact_version_id: optional string or null` - - The version of the source artifact that was copied into the new artifact. - - - `type: optional "claude_artifact_duplicated"` + - `type: optional "claude_chat_snapshot_created"` - default: claude_artifact_duplicated + default: claude_chat_snapshot_created - - `ClaudeChatAccessFailed object` + - `ClaudeChatSnapshotDeleted object` - A user was denied access to a Claude.ai chat conversation. + User deleted/unshared a chat snapshot. - `actor: object or object or object or 8 more` @@ -17593,14 +17430,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` - - The chat conversation the user was denied access to, e.g. "claude_chat_01Ab...". + - `claude_chat_snapshot_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_chat_id: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -17615,13 +17452,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_access_failed"` + - `type: optional "claude_chat_snapshot_deleted"` - default: claude_chat_access_failed + default: claude_chat_snapshot_deleted - - `ClaudeChatCreated object` + - `ClaudeChatSnapshotViewed object` - User created a chat. + User viewed a chat snapshot (authenticated or public/unauthenticated). - `actor: object or object or object or 8 more` @@ -17834,17 +17671,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` - - Tagged ID of the created conversation, e.g. "claude_chat_01HX...". + - `claude_chat_snapshot_id: string` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` - - Tagged ID of the project the chat was created in, if any, e.g. "claude_proj_01HX...". + - `claude_chat_id: optional string or null` - `created_at: optional string` @@ -17860,13 +17693,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_created"` + - `type: optional "claude_chat_snapshot_viewed"` - default: claude_chat_created + default: claude_chat_snapshot_viewed - - `ClaudeChatDeleted object` + - `ClaudeArtifactDuplicated object` - A user deleted a Claude.ai chat conversation. + A user duplicated an artifact they could view into a new artifact that they own. The actor is the user who created the copy; the source artifact is not modified. - `actor: object or object or object or 8 more` @@ -18079,17 +17912,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_artifact_id: string` - The chat conversation that was deleted, e.g. "claude_chat_01HX...". + Tagged ID of the new artifact created by the duplication. It is owned by the actor and is independent of the source artifact. - - `id: optional string` + - `source_claude_artifact_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the artifact that was copied. - - `claude_project_id: optional string or null` + - `id: optional string` - The project the chat belonged to, if any, e.g. "claude_proj_01HX...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -18105,13 +17938,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_deleted"` + - `source_claude_artifact_version_id: optional string or null` - default: claude_chat_deleted + The version of the source artifact that was copied into the new artifact. - - `ClaudeChatDeletionFailed object` + - `type: optional "claude_artifact_duplicated"` - A request to delete a Claude.ai chat conversation failed. + default: claude_artifact_duplicated + + - `ClaudeChatAccessFailed object` + + A user was denied access to a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -18326,7 +18163,7 @@ compliance activities that can be filtered by various criteria. - `claude_chat_id: string` - The chat conversation the user attempted to delete, e.g. "claude_chat_01HX...". + The chat conversation the user was denied access to, e.g. "claude_chat_01Ab...". - `id: optional string` @@ -18346,13 +18183,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_deletion_failed"` + - `type: optional "claude_chat_access_failed"` - default: claude_chat_deletion_failed + default: claude_chat_access_failed - - `ClaudeChatSyncSourceCreated object` + - `ClaudeChatCreated object` - A sync source was connected for syncing external content into Claude chats. + User created a chat. - `actor: object or object or object or 8 more` @@ -18565,18 +18402,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was created. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + Tagged ID of the created conversation, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the chat was created in, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. @@ -18591,17 +18428,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_chat_sync_source_created"` + - `type: optional "claude_chat_created"` - default: claude_chat_sync_source_created + default: claude_chat_created - - `ClaudeChatSyncSourceDeleted object` + - `ClaudeChatDeleted object` - A sync source was disconnected from Claude chats. + A user deleted a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -18814,18 +18647,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was deleted. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source. Always `unspecified` for deletion events. + The chat conversation that was deleted, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + The project the chat belonged to, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. @@ -18840,13 +18673,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_sync_source_deleted"` + - `type: optional "claude_chat_deleted"` - default: claude_chat_sync_source_deleted + default: claude_chat_deleted - - `ClaudeChatSyncSourceUpdated object` + - `ClaudeChatDeletionFailed object` - A Claude chat sync source's configuration was updated. + A request to delete a Claude.ai chat conversation failed. - `actor: object or object or object or 8 more` @@ -19059,22 +18892,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_sync_source_id: string` - - Tagged ID of the chat-scoped sync source that was updated. - - - `provider: string` + - `claude_chat_id: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + The chat conversation the user attempted to delete, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `config_changed: optional boolean or null` - - Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - - `created_at: optional string` When this activity occurred. @@ -19089,17 +18914,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_chat_sync_source_updated"` + - `type: optional "claude_chat_deletion_failed"` - default: claude_chat_sync_source_updated + default: claude_chat_deletion_failed - - `ClaudeChatUpdated object` + - `ClaudeChatSyncSourceCreated object` - User updated the chat metadata (e.g name, model). + A sync source was connected for syncing external content into Claude chats. - `actor: object or object or object or 8 more` @@ -19312,17 +19133,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_chat_sync_source_id: string` - Tagged ID of the updated conversation, e.g. "claude_chat_01HX...". + Tagged ID of the chat-scoped sync source that was created. - - `id: optional string` + - `provider: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - - `claude_project_id: optional string or null` + - `id: optional string` - Tagged ID of the project the chat belongs to, if any, e.g. "claude_proj_01HX...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -19338,13 +19159,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_updated"` + - `resource_descriptor: optional string or null` - default: claude_chat_updated + A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `ClaudeChatViewed object` + - `type: optional "claude_chat_sync_source_created"` - A user viewed a Claude.ai chat conversation. + default: claude_chat_sync_source_created + + - `ClaudeChatSyncSourceDeleted object` + + A sync source was disconnected from Claude chats. - `actor: object or object or object or 8 more` @@ -19557,17 +19382,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_chat_id: string` + - `claude_chat_sync_source_id: string` - The chat conversation that was viewed, e.g. "claude_chat_01Ab...". + Tagged ID of the chat-scoped sync source that was deleted. - - `id: optional string` + - `provider: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + The external provider backing the sync source. Always `unspecified` for deletion events. - - `claude_project_id: optional string or null` + - `id: optional string` - The project the chat belongs to, if any, e.g. "claude_proj_01Ab...". + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -19583,13 +19408,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_chat_viewed"` + - `type: optional "claude_chat_sync_source_deleted"` - default: claude_chat_viewed + default: claude_chat_sync_source_deleted - - `ClaudeCodeCredentialRevoked object` + - `ClaudeChatSyncSourceUpdated object` - A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded. + A Claude chat sync source's configuration was updated. - `actor: object or object or object or 8 more` @@ -19802,25 +19627,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `credential_type: "runner_pool_key" or "runner_token" or "session_token" or "unspecified"` - - The kind of credential the revoked target identifies, when known. Subject-targeted revocations cascade to every credential delegated from the target regardless of kind; this field describes the target itself, not the full set of credentials the cascade reached. For a revocation submitted as a pasted credential the kind is best-effort and may be inaccurate; the recorded jti and the revocation itself are unaffected. - - - `"runner_pool_key"` + - `claude_chat_sync_source_id: string` - - `"runner_token"` + Tagged ID of the chat-scoped sync source that was updated. - - `"session_token"` + - `provider: string` - - `"unspecified"` + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `agent_id: optional string or null` + - `config_changed: optional boolean or null` - The agent identity whose Claude Code credentials were revoked, when revocation targeted every session created by an agent identity, e.g. "cagt_01HX...". + Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - `created_at: optional string` @@ -19828,14 +19649,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `delegating_jti: optional string or null` - - The credential identifier whose delegated credentials were revoked (a chain revoke): every credential delegated from this one was revoked, but the credential itself was not. Distinct from `jti`, which records a revocation of the credential itself and its delegates. - - - `jti: optional string or null` - - The unique identifier of the revoked credential, recorded in its canonical form. Revoking a runner pool key also revokes every runner and session token delegated from it. A revocation submitted as a pasted credential is recorded by that credential's identifier. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -19844,29 +19657,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_id: optional string or null` - - The runner whose credentials were revoked, when revocation targeted every credential delegated from the runner, e.g. "ccrunner_01HX...". - - - `runner_pool_id: optional string or null` - - The runner pool whose credentials were revoked, when revocation targeted every credential delegated from the pool, e.g. "ccpool_01HX...". - - - `session_id: optional string or null` - - The session whose credentials were revoked, when revocation targeted every credential delegated from the session, e.g. "cse_01HX...". - - - `type: optional "claude_code_credential_revoked"` + - `resource_descriptor: optional string or null` - default: claude_code_credential_revoked + A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `user_id: optional string or null` + - `type: optional "claude_chat_sync_source_updated"` - The user whose Claude Code credentials were revoked, when revocation targeted every credential minted for a user. Carries the user's tagged account ID, e.g. "user_01HX..." — the only form the revocation API accepts, so the field joins against other activities' account identifiers and never carries an email. + default: claude_chat_sync_source_updated - - `ClaudeCodeReviewConfigUpdated object` + - `ClaudeChatUpdated object` - Claude Code Review configuration was enabled/disabled for an org. + User updated the chat metadata (e.g name, model). - `actor: object or object or object or 8 more` @@ -20079,28 +19880,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` + - `claude_chat_id: string` - Whether code review is now enabled + Tagged ID of the updated conversation, e.g. "claude_chat_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the chat belongs to, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time - - `environment_id: optional string or null` - - Environment used for code review - - - `model: optional string or null` - - Model configured for code review - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20109,49 +19906,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `per_review_limit_usd: optional string or null` - - Per-review spend limit in USD - - - `previous_enabled: optional boolean or null` - - Whether code review was enabled before the change. Absent when no configuration existed before this update. - - - `previous_environment_id: optional string or null` - - Environment used for code review before the change. Absent when no configuration existed before this update or no environment was set. - - - `previous_model: optional string or null` - - Model configured for code review before the change. Absent when no configuration existed before this update or no model was set. - - - `previous_per_review_limit_usd: optional string or null` - - Per-review spend limit in USD before the change. Absent when no configuration existed before this update or no limit was set. - - - `previous_show_tips: optional boolean or null` - - Whether tip-style pull-request comments were enabled before the change. Absent when no configuration existed before this update. - - - `previous_verification_enabled: optional boolean or null` - - Whether the verification stage of code review was enabled for the organization before the change. Absent when no configuration existed before this update or no preference was set. - - - `show_tips: optional boolean or null` - - Whether tip-style pull-request comments are now enabled - - - `type: optional "claude_code_review_config_updated"` - - default: claude_code_review_config_updated - - - `verification_enabled: optional boolean or null` + - `type: optional "claude_chat_updated"` - Whether the verification stage of code review is now enabled for the organization. Absent when the organization has not set a preference and the default applies. + default: claude_chat_updated - - `ClaudeCodeReviewRepositoryAdded object` + - `ClaudeChatViewed object` - A repository was added to org-level Claude Code Review configuration. + A user viewed a Claude.ai chat conversation. - `actor: object or object or object or 8 more` @@ -20364,26 +20125,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` - - ID of the repository configuration - - - `repo_name: string` - - Repository name - - - `repo_owner: string` - - Repository owner (GitHub org/user) - - - `trigger_mode: string` + - `claude_chat_id: string` - When code review is triggered + The chat conversation that was viewed, e.g. "claude_chat_01Ab...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + The project the chat belongs to, if any, e.g. "claude_proj_01Ab...". + - `created_at: optional string` When this activity occurred. @@ -20398,13 +20151,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_review_repository_added"` + - `type: optional "claude_chat_viewed"` - default: claude_code_review_repository_added + default: claude_chat_viewed - - `ClaudeCodeReviewRepositoryRemoved object` + - `ClaudeCodeCredentialRevoked object` - A repository was removed from org-level Claude Code Review configuration. + A Claude Code credential (runner pool key, runner token, or session token) was revoked. The credential itself is never recorded. - `actor: object or object or object or 8 more` @@ -20617,28 +20370,40 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` + - `credential_type: "runner_pool_key" or "runner_token" or "session_token" or "unspecified"` - ID of the deleted repository configuration + The kind of credential the revoked target identifies, when known. Subject-targeted revocations cascade to every credential delegated from the target regardless of kind; this field describes the target itself, not the full set of credentials the cascade reached. For a revocation submitted as a pasted credential the kind is best-effort and may be inaccurate; the recorded jti and the revocation itself are unaffected. - - `repo_name: string` + - `"runner_pool_key"` - Repository name at deletion time + - `"runner_token"` - - `repo_owner: string` + - `"session_token"` - Repository owner at deletion time + - `"unspecified"` - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `agent_id: optional string or null` + + The agent identity whose Claude Code credentials were revoked, when revocation targeted every session created by an agent identity, e.g. "cagt_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time + - `delegating_jti: optional string or null` + + The credential identifier whose delegated credentials were revoked (a chain revoke): every credential delegated from this one was revoked, but the credential itself was not. Distinct from `jti`, which records a revocation of the credential itself and its delegates. + + - `jti: optional string or null` + + The unique identifier of the revoked credential, recorded in its canonical form. Revoking a runner pool key also revokes every runner and session token delegated from it. A revocation submitted as a pasted credential is recorded by that credential's identifier. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20647,13 +20412,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_review_repository_removed"` + - `runner_id: optional string or null` - default: claude_code_review_repository_removed + The runner whose credentials were revoked, when revocation targeted every credential delegated from the runner, e.g. "ccrunner_01HX...". - - `ClaudeCodeReviewRepositoryUpdated object` + - `runner_pool_id: optional string or null` - A Claude Code Review repository configuration was updated. + The runner pool whose credentials were revoked, when revocation targeted every credential delegated from the pool, e.g. "ccpool_01HX...". + + - `session_id: optional string or null` + + The session whose credentials were revoked, when revocation targeted every credential delegated from the session, e.g. "cse_01HX...". + + - `type: optional "claude_code_credential_revoked"` + + default: claude_code_credential_revoked + + - `user_id: optional string or null` + + The user whose Claude Code credentials were revoked, when revocation targeted every credential minted for a user. Carries the user's tagged account ID, e.g. "user_01HX..." — the only form the revocation API accepts, so the field joins against other activities' account identifiers and never carries an email. + + - `ClaudeCodeReviewConfigUpdated object` + + Claude Code Review configuration was enabled/disabled for an org. - `actor: object or object or object or 8 more` @@ -20866,17 +20647,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `config_id: string` - - ID of the repository configuration - - - `repo_name: string` - - Repository name - - - `repo_owner: string` + - `enabled: boolean` - Repository owner + Whether code review is now enabled - `id: optional string` @@ -20888,6 +20661,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `environment_id: optional string or null` + + Environment used for code review + + - `model: optional string or null` + + Model configured for code review + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -20896,21 +20677,49 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `status: optional string or null` + - `per_review_limit_usd: optional string or null` - Updated status (ACTIVE/INACTIVE) + Per-review spend limit in USD - - `trigger_mode: optional string or null` + - `previous_enabled: optional boolean or null` - Updated trigger mode + Whether code review was enabled before the change. Absent when no configuration existed before this update. - - `type: optional "claude_code_review_repository_updated"` + - `previous_environment_id: optional string or null` - default: claude_code_review_repository_updated + Environment used for code review before the change. Absent when no configuration existed before this update or no environment was set. - - `ClaudeCodeRunnerDeleted object` + - `previous_model: optional string or null` - A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again. + Model configured for code review before the change. Absent when no configuration existed before this update or no model was set. + + - `previous_per_review_limit_usd: optional string or null` + + Per-review spend limit in USD before the change. Absent when no configuration existed before this update or no limit was set. + + - `previous_show_tips: optional boolean or null` + + Whether tip-style pull-request comments were enabled before the change. Absent when no configuration existed before this update. + + - `previous_verification_enabled: optional boolean or null` + + Whether the verification stage of code review was enabled for the organization before the change. Absent when no configuration existed before this update or no preference was set. + + - `show_tips: optional boolean or null` + + Whether tip-style pull-request comments are now enabled + + - `type: optional "claude_code_review_config_updated"` + + default: claude_code_review_config_updated + + - `verification_enabled: optional boolean or null` + + Whether the verification stage of code review is now enabled for the organization. Absent when the organization has not set a preference and the default applies. + + - `ClaudeCodeReviewRepositoryAdded object` + + A repository was added to org-level Claude Code Review configuration. - `actor: object or object or object or 8 more` @@ -21123,9 +20932,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `runner_id: string` + - `config_id: string` - The runner that was removed, e.g. "ccrunner_01HX...". + ID of the repository configuration + + - `repo_name: string` + + Repository name + + - `repo_owner: string` + + Repository owner (GitHub org/user) + + - `trigger_mode: string` + + When code review is triggered - `id: optional string` @@ -21145,17 +20966,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_pool_id: optional string or null` - - The pool the runner was removed from, e.g. "ccpool_01HX...". - - - `type: optional "claude_code_runner_deleted"` + - `type: optional "claude_code_review_repository_added"` - default: claude_code_runner_deleted + default: claude_code_review_repository_added - - `ClaudeCodeRunnerPoolCreated object` + - `ClaudeCodeReviewRepositoryRemoved object` - A self-hosted runner pool for Claude Code was created. + A repository was removed from org-level Claude Code Review configuration. - `actor: object or object or object or 8 more` @@ -21368,13 +21185,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` + - `config_id: string` - The display name the pool was created with. + ID of the deleted repository configuration - - `runner_pool_id: string` + - `repo_name: string` - The runner pool that was created, e.g. "ccpool_01HX...". + Repository name at deletion time + + - `repo_owner: string` + + Repository owner at deletion time - `id: optional string` @@ -21394,13 +21215,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_created"` + - `type: optional "claude_code_review_repository_removed"` - default: claude_code_runner_pool_created + default: claude_code_review_repository_removed - - `ClaudeCodeRunnerPoolDeleted object` + - `ClaudeCodeReviewRepositoryUpdated object` - A self-hosted runner pool was deleted. + A Claude Code Review repository configuration was updated. - `actor: object or object or object or 8 more` @@ -21613,9 +21434,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `runner_pool_id: string` + - `config_id: string` - The runner pool that was deleted, e.g. "ccpool_01HX...". + ID of the repository configuration + + - `repo_name: string` + + Repository name + + - `repo_owner: string` + + Repository owner - `id: optional string` @@ -21627,10 +21456,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `display_name: optional string or null` - - The pool's display name at deletion time. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -21639,13 +21464,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_deleted"` + - `status: optional string or null` - default: claude_code_runner_pool_deleted + Updated status (ACTIVE/INACTIVE) - - `ClaudeCodeRunnerPoolSecretMinted object` + - `trigger_mode: optional string or null` - A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded. + Updated trigger mode + + - `type: optional "claude_code_review_repository_updated"` + + default: claude_code_review_repository_updated + + - `ClaudeCodeRunnerDeleted object` + + A self-hosted runner was forcibly removed from its pool. Sessions assigned to the runner were returned to the pool queue, unless a session had already been requeued repeatedly, in which case it was marked stuck instead of being requeued again. - `actor: object or object or object or 8 more` @@ -21858,13 +21691,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `jti: string` - - The minted key's unique identifier (its JWT `jti` claim), usable to revoke that key later. - - - `runner_pool_id: string` + - `runner_id: string` - The runner pool the key was minted for, e.g. "ccpool_01HX...". + The runner that was removed, e.g. "ccrunner_01HX...". - `id: optional string` @@ -21876,16 +21705,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `expires_at: optional string or null` - - When the minted key expires. - - format: date-time - - - `label: optional string or null` - - The label the key was minted with. The key minted automatically when a pool is created carries the label "Initial key". - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -21894,25 +21713,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_runner_pool_secret_minted"` - - default: claude_code_runner_pool_secret_minted - - - `ClaudeCodeRunnerPoolSessionQueueUpdated object` - - An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt. - - - `action: "dismissed" or "provisioning_retried" or "requeued" or "unspecified"` + - `runner_pool_id: optional string or null` - What changed about the session's queue state. + The pool the runner was removed from, e.g. "ccpool_01HX...". - - `"dismissed"` + - `type: optional "claude_code_runner_deleted"` - - `"provisioning_retried"` + default: claude_code_runner_deleted - - `"requeued"` + - `ClaudeCodeRunnerPoolCreated object` - - `"unspecified"` + A self-hosted runner pool for Claude Code was created. - `actor: object or object or object or 8 more` @@ -22125,9 +21936,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `display_name: string` - The session whose queue state changed, e.g. "cse_01HX...". + The display name the pool was created with. + + - `runner_pool_id: string` + + The runner pool that was created, e.g. "ccpool_01HX...". - `id: optional string` @@ -22139,10 +21954,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `excluded_runner_id: optional string or null` - - The runner the session was moved off, when action is "requeued", e.g. "ccrunner_01HX...". - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22151,17 +21962,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `runner_pool_id: optional string or null` - - The runner pool whose queue the session is in, when known, e.g. "ccpool_01HX...". - - - `type: optional "claude_code_runner_pool_session_queue_updated"` + - `type: optional "claude_code_runner_pool_created"` - default: claude_code_runner_pool_session_queue_updated + default: claude_code_runner_pool_created - - `ClaudeCodeRunnerPoolUpdated object` + - `ClaudeCodeRunnerPoolDeleted object` - A self-hosted runner pool's settings were updated. + A self-hosted runner pool was deleted. - `actor: object or object or object or 8 more` @@ -22374,13 +22181,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `display_name: string` - - The pool's display name after the update. - - `runner_pool_id: string` - The runner pool that was updated, e.g. "ccpool_01HX...". + The runner pool that was deleted, e.g. "ccpool_01HX...". - `id: optional string` @@ -22392,6 +22195,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `display_name: optional string or null` + + The pool's display name at deletion time. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22400,17 +22207,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_display_name: optional string or null` - - The pool's display name before the update. Absent when the name was unchanged or the previous value was unavailable. - - - `type: optional "claude_code_runner_pool_updated"` + - `type: optional "claude_code_runner_pool_deleted"` - default: claude_code_runner_pool_updated + default: claude_code_runner_pool_deleted - - `ClaudeCodeSecurityCenterConfigUpdated object` + - `ClaudeCodeRunnerPoolSecretMinted object` - Claude Code Security Center scanning was enabled/disabled for an org. + A registration key for a self-hosted runner pool was minted. Runners present this key to join the pool. The key itself is never recorded. - `actor: object or object or object or 8 more` @@ -22623,9 +22426,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` + - `jti: string` - Whether Security Center is now enabled + The minted key's unique identifier (its JWT `jti` claim), usable to revoke that key later. + + - `runner_pool_id: string` + + The runner pool the key was minted for, e.g. "ccpool_01HX...". - `id: optional string` @@ -22637,9 +22444,15 @@ compliance activities that can be filtered by various criteria. format: date-time - - `environment_id: optional string or null` + - `expires_at: optional string or null` - Environment used for security scanning + When the minted key expires. + + format: date-time + + - `label: optional string or null` + + The label the key was minted with. The key minted automatically when a pool is created carries the label "Initial key". - `organization_id: optional string or null` @@ -22649,13 +22462,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_center_config_updated"` + - `type: optional "claude_code_runner_pool_secret_minted"` - default: claude_code_security_center_config_updated + default: claude_code_runner_pool_secret_minted - - `ClaudeCodeSecurityScanCancelled object` + - `ClaudeCodeRunnerPoolSessionQueueUpdated object` - In-flight Claude Code Security scans were cancelled for a project. + An admin changed a session's position in its self-hosted runner pool's queue: requeued it onto a different runner, dismissed it from the queue, or re-admitted it for another runner provisioning attempt. + + - `action: "dismissed" or "provisioning_retried" or "requeued" or "unspecified"` + + What changed about the session's queue state. + + - `"dismissed"` + + - `"provisioning_retried"` + + - `"requeued"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -22868,11 +22693,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_project_id: string` - - Tagged ID of the scan project + - `session_id: string` - - `scans_cancelled: number` + The session whose queue state changed, e.g. "cse_01HX...". - `id: optional string` @@ -22884,6 +22707,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `excluded_runner_id: optional string or null` + + The runner the session was moved off, when action is "requeued", e.g. "ccrunner_01HX...". + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -22892,13 +22719,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_cancelled"` + - `runner_pool_id: optional string or null` - default: claude_code_security_scan_cancelled + The runner pool whose queue the session is in, when known, e.g. "ccpool_01HX...". - - `ClaudeCodeSecurityScanCreated object` + - `type: optional "claude_code_runner_pool_session_queue_updated"` - A Claude Code Security scan was started. + default: claude_code_runner_pool_session_queue_updated + + - `ClaudeCodeRunnerPoolUpdated object` + + A self-hosted runner pool's settings were updated. - `actor: object or object or object or 8 more` @@ -23111,13 +22942,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `display_name: string` - Tagged ID of the created scan + The pool's display name after the update. - - `scan_project_id: string` + - `runner_pool_id: string` - Tagged ID of the scan project the scan belongs to + The runner pool that was updated, e.g. "ccpool_01HX...". - `id: optional string` @@ -23137,25 +22968,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_created"` - - default: claude_code_security_scan_created - - - `ClaudeCodeSecurityScanProjectMemberUpdated object` - - A person's access to a Claude Code Security scan project was granted, changed, or revoked. - - - `action: "member_added" or "member_removed" or "member_role_changed" or "unspecified"` + - `previous_display_name: optional string or null` - Whether the member was granted access, had their role changed, or was revoked + The pool's display name before the update. Absent when the name was unchanged or the previous value was unavailable. - - `"member_added"` + - `type: optional "claude_code_runner_pool_updated"` - - `"member_removed"` + default: claude_code_runner_pool_updated - - `"member_role_changed"` + - `ClaudeCodeSecurityCenterConfigUpdated object` - - `"unspecified"` + Claude Code Security Center scanning was enabled/disabled for an org. - `actor: object or object or object or 8 more` @@ -23368,13 +23191,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `member_id: string` - - Tagged ID of the member whose access changed - - - `scan_project_id: string` + - `enabled: boolean` - Tagged ID of the scan project + Whether Security Center is now enabled - `id: optional string` @@ -23386,6 +23205,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `environment_id: optional string or null` + + Environment used for security scanning + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -23394,31 +23217,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `role: optional string or null` - - Role granted to the member (full, view_triage, or view); omitted for revocations - - - `type: optional "claude_code_security_scan_project_member_updated"` - - default: claude_code_security_scan_project_member_updated - - - `ClaudeCodeSecurityScanProjectUpdated object` - - A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience. - - - `action: "archived" or "created" or "migrated" or 2 more` - - The state change applied to the scan project. - - - `"archived"` - - - `"created"` + - `type: optional "claude_code_security_center_config_updated"` - - `"migrated"` + default: claude_code_security_center_config_updated - - `"unarchived"` + - `ClaudeCodeSecurityScanCancelled object` - - `"unspecified"` + In-flight Claude Code Security scans were cancelled for a project. - `actor: object or object or object or 8 more` @@ -23635,6 +23440,8 @@ compliance activities that can be filtered by various criteria. Tagged ID of the scan project + - `scans_cancelled: number` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -23653,23 +23460,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_project_updated"` - - default: claude_code_security_scan_project_updated - - - `ClaudeCodeSecurityScanProjectVisibilityUpdated object` - - A Claude Code Security scan project was shared with the organization or made private. - - - `action: "shared" or "unshared" or "unspecified"` - - Whether the project was shared with the organization or made private + - `type: optional "claude_code_security_scan_cancelled"` - - `"shared"` + default: claude_code_security_scan_cancelled - - `"unshared"` + - `ClaudeCodeSecurityScanCreated object` - - `"unspecified"` + A Claude Code Security scan was started. - `actor: object or object or object or 8 more` @@ -23882,18 +23679,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `scan_id: string` + + Tagged ID of the created scan + - `scan_project_id: string` - Tagged ID of the scan project + Tagged ID of the scan project the scan belongs to - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `access_level: optional string or null` - - Access level granted to organization members (read_only or full); only set when shared - - `created_at: optional string` When this activity occurred. @@ -23908,25 +23705,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_project_visibility_updated"` - - default: claude_code_security_scan_project_visibility_updated + - `type: optional "claude_code_security_scan_created"` - - `ClaudeCodeSecurityScanRunUpdated object` + default: claude_code_security_scan_created - A single Claude Code Security scan run was archived or unarchived. + - `ClaudeCodeSecurityScanProjectMemberUpdated object` - - `action: "archived" or "created" or "migrated" or 2 more` + A person's access to a Claude Code Security scan project was granted, changed, or revoked. - The state change applied to the scan run + - `action: "member_added" or "member_removed" or "member_role_changed" or "unspecified"` - - `"archived"` + Whether the member was granted access, had their role changed, or was revoked - - `"created"` + - `"member_added"` - - `"migrated"` + - `"member_removed"` - - `"unarchived"` + - `"member_role_changed"` - `"unspecified"` @@ -24141,9 +23936,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `member_id: string` - Tagged ID of the scan the request named — any scan in the archived run, not necessarily its canonical (run_index=0) scan + Tagged ID of the member whose access changed + + - `scan_project_id: string` + + Tagged ID of the scan project - `id: optional string` @@ -24163,13 +23962,33 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_run_updated"` + - `role: optional string or null` - default: claude_code_security_scan_run_updated + Role granted to the member (full, view_triage, or view); omitted for revocations - - `ClaudeCodeSecurityScanScheduleDeleted object` + - `type: optional "claude_code_security_scan_project_member_updated"` - A recurring scan schedule was deleted for a Claude Code Security project. + default: claude_code_security_scan_project_member_updated + + - `ClaudeCodeSecurityScanProjectUpdated object` + + A Claude Code Security scan project was archived, unarchived, created, or migrated to a new product experience. + + - `action: "archived" or "created" or "migrated" or 3 more` + + The state change applied to the scan project. + + - `"archived"` + + - `"created"` + + - `"migrated"` + + - `"resumed"` + + - `"unarchived"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24404,13 +24223,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_schedule_deleted"` + - `type: optional "claude_code_security_scan_project_updated"` - default: claude_code_security_scan_schedule_deleted + default: claude_code_security_scan_project_updated - - `ClaudeCodeSecurityScanScheduleUpdated object` + - `ClaudeCodeSecurityScanProjectVisibilityUpdated object` - A recurring scan schedule was set or replaced for a Claude Code Security project. + A Claude Code Security scan project was shared with the organization or made private. + + - `action: "shared" or "unshared" or "unspecified"` + + Whether the project was shared with the organization or made private + + - `"shared"` + + - `"unshared"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24623,8 +24452,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cadence: string` - - `scan_project_id: string` Tagged ID of the scan project @@ -24633,6 +24460,10 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_level: optional string or null` + + Access level granted to organization members (read_only or full); only set when shared + - `created_at: optional string` When this activity occurred. @@ -24647,13 +24478,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_scan_schedule_updated"` + - `type: optional "claude_code_security_scan_project_visibility_updated"` - default: claude_code_security_scan_schedule_updated + default: claude_code_security_scan_project_visibility_updated - - `ClaudeCodeSecurityVulnerabilityFixSessionCreated object` + - `ClaudeCodeSecurityScanRunUpdated object` - A Claude Code remediation session was created for a Claude Code Security vulnerability finding. + A single Claude Code Security scan run was archived, unarchived, or resumed after a billing pause. + + - `action: "archived" or "created" or "migrated" or 3 more` + + The state change applied to the scan run + + - `"archived"` + + - `"created"` + + - `"migrated"` + + - `"resumed"` + + - `"unarchived"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -24868,11 +24715,7 @@ compliance activities that can be filtered by various criteria. - `scan_id: string` - Tagged ID of the scan the finding belongs to - - - `session_id: string` - - ID of the created remediation session + Tagged ID of the scan the request named — for archive/unarchive any scan in the run, not necessarily its canonical (run_index=0) scan; for resume, the paused scan - `id: optional string` @@ -24892,27 +24735,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_vulnerability_fix_session_created"` - - default: claude_code_security_vulnerability_fix_session_created - - - `ClaudeCodeSecurityVulnerabilityUpdated object` - - A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened. - - - `action: "dismissed" or "fixed" or "restored" or 2 more` - - The state change applied to the finding - - - `"dismissed"` - - - `"fixed"` + - `type: optional "claude_code_security_scan_run_updated"` - - `"restored"` + default: claude_code_security_scan_run_updated - - `"unfixed"` + - `ClaudeCodeSecurityScanScheduleDeleted object` - - `"unspecified"` + A recurring scan schedule was deleted for a Claude Code Security project. - `actor: object or object or object or 8 more` @@ -25125,9 +24954,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `scan_id: string` + - `scan_project_id: string` - Tagged ID of the scan the finding belongs to + Tagged ID of the scan project - `id: optional string` @@ -25139,10 +24968,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `dismissal_reason: optional string or null` - - The categorized dismissal reason (only set when the finding was dismissed) - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -25151,13 +24976,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_code_security_vulnerability_updated"` + - `type: optional "claude_code_security_scan_schedule_deleted"` - default: claude_code_security_vulnerability_updated + default: claude_code_security_scan_schedule_deleted - - `ClaudeCodeSecurityWebhookCreated object` + - `ClaudeCodeSecurityScanScheduleUpdated object` - A Claude Code Security outbound webhook was created. + A recurring scan schedule was set or replaced for a Claude Code Security project. - `actor: object or object or object or 8 more` @@ -25370,11 +25195,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `url: string` + - `cadence: string` - - `webhook_id: string` + - `scan_project_id: string` - Tagged ID of the webhook + Tagged ID of the scan project - `id: optional string` @@ -25394,17 +25219,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` - - Tagged ID of the scan project (null for organization-wide webhooks) - - - `type: optional "claude_code_security_webhook_created"` + - `type: optional "claude_code_security_scan_schedule_updated"` - default: claude_code_security_webhook_created + default: claude_code_security_scan_schedule_updated - - `ClaudeCodeSecurityWebhookDeleted object` + - `ClaudeCodeSecurityVulnerabilityFixSessionCreated object` - A Claude Code Security outbound webhook was deleted. + A Claude Code remediation session was created for a Claude Code Security vulnerability finding. - `actor: object or object or object or 8 more` @@ -25617,9 +25438,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `webhook_id: string` + - `scan_id: string` - Tagged ID of the webhook + Tagged ID of the scan the finding belongs to + + - `session_id: string` + + ID of the created remediation session - `id: optional string` @@ -25639,17 +25464,27 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` + - `type: optional "claude_code_security_vulnerability_fix_session_created"` - Tagged ID of the scan project (null for organization-wide webhooks) + default: claude_code_security_vulnerability_fix_session_created - - `type: optional "claude_code_security_webhook_deleted"` + - `ClaudeCodeSecurityVulnerabilityUpdated object` - default: claude_code_security_webhook_deleted + A Claude Code Security vulnerability finding was dismissed, restored, marked fixed, or reopened. - - `ClaudeCodeSecurityWebhookSecretUpdated object` + - `action: "dismissed" or "fixed" or "restored" or 2 more` - The HMAC signing secret for a Claude Code Security webhook was rotated. + The state change applied to the finding + + - `"dismissed"` + + - `"fixed"` + + - `"restored"` + + - `"unfixed"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -25862,9 +25697,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `webhook_id: string` + - `scan_id: string` - Tagged ID of the webhook + Tagged ID of the scan the finding belongs to - `id: optional string` @@ -25876,6 +25711,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `dismissal_reason: optional string or null` + + The categorized dismissal reason (only set when the finding was dismissed) + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -25884,17 +25723,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scan_project_id: optional string or null` - - Tagged ID of the scan project (null for organization-wide webhooks) - - - `type: optional "claude_code_security_webhook_secret_updated"` + - `type: optional "claude_code_security_vulnerability_updated"` - default: claude_code_security_webhook_secret_updated + default: claude_code_security_vulnerability_updated - - `ClaudeCodeSecurityWebhookUpdated object` + - `ClaudeCodeSecurityWebhookCreated object` - A Claude Code Security outbound webhook was updated. + A Claude Code Security outbound webhook was created. - `actor: object or object or object or 8 more` @@ -26107,6 +25942,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `url: string` + - `webhook_id: string` Tagged ID of the webhook @@ -26133,23 +25970,13 @@ compliance activities that can be filtered by various criteria. Tagged ID of the scan project (null for organization-wide webhooks) - - `type: optional "claude_code_security_webhook_updated"` - - default: claude_code_security_webhook_updated - - - `ClaudeCodeTeamMemoryACLUpdated object` - - An RBAC group was added to or removed from the Claude Code team-memory ACL. - - - `action: "removed" or "set" or "unspecified"` - - Whether the group was set (added/updated) or removed + - `type: optional "claude_code_security_webhook_created"` - - `"removed"` + default: claude_code_security_webhook_created - - `"set"` + - `ClaudeCodeSecurityWebhookDeleted object` - - `"unspecified"` + A Claude Code Security outbound webhook was deleted. - `actor: object or object or object or 8 more` @@ -26362,18 +26189,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` + - `webhook_id: string` - Tagged ID of the RBAC group + Tagged ID of the webhook - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `access_level: optional string or null` - - Access level granted (when action=set) - - `created_at: optional string` When this activity occurred. @@ -26388,17 +26211,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_access_level: optional string or null` + - `scan_project_id: optional string or null` - Access level the group had before this change; absent when the group was not previously in the access list. For removals this is the access level that was removed. + Tagged ID of the scan project (null for organization-wide webhooks) - - `type: optional "claude_code_team_memory_acl_updated"` + - `type: optional "claude_code_security_webhook_deleted"` - default: claude_code_team_memory_acl_updated + default: claude_code_security_webhook_deleted - - `ClaudeCodeTeamMemoryUpdated object` + - `ClaudeCodeSecurityWebhookSecretUpdated object` - Claude Code team memory shared with the organization was updated. + The HMAC signing secret for a Claude Code Security webhook was rotated. - `actor: object or object or object or 8 more` @@ -26611,9 +26434,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `webhook_id: string` - True when the entire team memory store for this scope was deleted in one request. + Tagged ID of the webhook - `id: optional string` @@ -26625,26 +26448,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of team memory entries removed. - - - `keys_written: optional array of string` - - Withdrawn — never populated. See `keys_written_count`. - - - `keys_written_count: optional number or null` - - Number of team memory entries created or updated. - - - `new_checksum: optional string or null` - - Checksum of the team memory after this change. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -26653,37 +26456,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_checksum: optional string or null` - - Checksum of the team memory before this change; null when it did not exist. - - - `repo: optional string or null` - - Withdrawn — never populated. - - - `type: optional "claude_code_team_memory_updated"` - - default: claude_code_team_memory_updated - - - `version: optional number or null` - - Version number of the team memory store after this change. - - - `ClaudeCodeTeamOnboardingGuideUpdated object` - - A Claude Code team onboarding guide was created, updated, or deleted. - - - `action: "created" or "deleted" or "unspecified" or "updated"` + - `scan_project_id: optional string or null` - The state change applied to the onboarding guide. + Tagged ID of the scan project (null for organization-wide webhooks) - - `"created"` + - `type: optional "claude_code_security_webhook_secret_updated"` - - `"deleted"` + default: claude_code_security_webhook_secret_updated - - `"unspecified"` + - `ClaudeCodeSecurityWebhookUpdated object` - - `"updated"` + A Claude Code Security outbound webhook was updated. - `actor: object or object or object or 8 more` @@ -26896,9 +26679,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `guide_short_code: string` + - `webhook_id: string` - Short code identifying the onboarding guide — the public URL handle shown in the share link. + Tagged ID of the webhook - `id: optional string` @@ -26910,37 +26693,35 @@ compliance activities that can be filtered by various criteria. format: date-time - - `guide_id: optional string or null` - - Tagged ID of the onboarding guide. + - `organization_id: optional string or null` - - `guide_name: optional string or null` + Organization ID this activity is associated with - Withdrawn — never populated. + - `organization_uuid: optional string or null` - - `new_checksum: optional string or null` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - Checksum of the guide content after this change; null when the guide was deleted. + - `scan_project_id: optional string or null` - - `organization_id: optional string or null` + Tagged ID of the scan project (null for organization-wide webhooks) - Organization ID this activity is associated with + - `type: optional "claude_code_security_webhook_updated"` - - `organization_uuid: optional string or null` + default: claude_code_security_webhook_updated - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `ClaudeCodeTeamMemoryACLUpdated object` - - `previous_checksum: optional string or null` + An RBAC group was added to or removed from the Claude Code team-memory ACL. - Checksum of the guide content before this change; null when the guide did not exist. + - `action: "removed" or "set" or "unspecified"` - - `type: optional "claude_code_team_onboarding_guide_updated"` + Whether the group was set (added/updated) or removed - default: claude_code_team_onboarding_guide_updated + - `"removed"` - - `ClaudeCodeUserMarketplacesUpdated object` + - `"set"` - A user's Claude Code plugin marketplace selections were updated on Anthropic servers. + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -27153,40 +26934,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `group_id: string` - True when all of the user's marketplace selections were removed in one request. + Tagged ID of the RBAC group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_level: optional string or null` + + Access level granted (when action=set) + - `created_at: optional string` When this activity occurred. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of marketplace selections removed. - - - `keys_written: optional array of string` - - Withdrawn — never populated. See `keys_written_count`. - - - `keys_written_count: optional number or null` - - Number of marketplace selections added or whose source changed. - - - `new_value: optional string or null` - - Withdrawn — never populated. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -27195,17 +26960,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional string or null` + - `previous_access_level: optional string or null` - Withdrawn — never populated. + Access level the group had before this change; absent when the group was not previously in the access list. For removals this is the access level that was removed. - - `type: optional "claude_code_user_marketplaces_updated"` + - `type: optional "claude_code_team_memory_acl_updated"` - default: claude_code_user_marketplaces_updated + default: claude_code_team_memory_acl_updated - - `ClaudeCodeUserMemoryUpdated object` + - `ClaudeCodeTeamMemoryUpdated object` - A user's synced private Claude Code memory was updated or deleted on Anthropic servers. + Claude Code team memory shared with the organization was updated. - `actor: object or object or object or 8 more` @@ -27420,7 +27185,7 @@ compliance activities that can be filtered by various criteria. - `deleted_all: boolean` - True when the user's entire synced memory for this scope was deleted in one request. + True when the entire team memory store for this scope was deleted in one request. - `id: optional string` @@ -27438,7 +27203,7 @@ compliance activities that can be filtered by various criteria. - `keys_deleted_count: optional number or null` - Number of memory file paths removed. + Number of team memory entries removed. - `keys_written: optional array of string` @@ -27446,11 +27211,11 @@ compliance activities that can be filtered by various criteria. - `keys_written_count: optional number or null` - Number of memory file paths created or updated. + Number of team memory entries created or updated. - `new_checksum: optional string or null` - Checksum of the user's synced memory after this change. + Checksum of the team memory after this change. - `organization_id: optional string or null` @@ -27462,19 +27227,35 @@ compliance activities that can be filtered by various criteria. - `previous_checksum: optional string or null` - Checksum of the user's synced memory before this change; null when the store did not exist. + Checksum of the team memory before this change; null when it did not exist. - `repo: optional string or null` Withdrawn — never populated. - - `type: optional "claude_code_user_memory_updated"` + - `type: optional "claude_code_team_memory_updated"` - default: claude_code_user_memory_updated + default: claude_code_team_memory_updated - - `ClaudeCodeUserPluginsUpdated object` + - `version: optional number or null` - A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers. + Version number of the team memory store after this change. + + - `ClaudeCodeTeamOnboardingGuideUpdated object` + + A Claude Code team onboarding guide was created, updated, or deleted. + + - `action: "created" or "deleted" or "unspecified" or "updated"` + + The state change applied to the onboarding guide. + + - `"created"` + + - `"deleted"` + + - `"unspecified"` + + - `"updated"` - `actor: object or object or object or 8 more` @@ -27687,9 +27468,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deleted_all: boolean` + - `guide_short_code: string` - True when all of the user's plugin selections were removed in one request. + Short code identifying the onboarding guide — the public URL handle shown in the share link. - `id: optional string` @@ -27701,25 +27482,17 @@ compliance activities that can be filtered by various criteria. format: date-time - - `keys_deleted: optional array of string` - - Withdrawn — never populated. See `keys_deleted_count`. - - - `keys_deleted_count: optional number or null` - - Number of plugin selections removed. - - - `keys_written: optional array of string` + - `guide_id: optional string or null` - Withdrawn — never populated. See `keys_written_count`. + Tagged ID of the onboarding guide. - - `keys_written_count: optional number or null` + - `guide_name: optional string or null` - Number of plugin selections added or whose enabled state changed. + Withdrawn — never populated. - - `new_value: optional string or null` + - `new_checksum: optional string or null` - The targeted plugin's new enabled state, when a single plugin's state changed. + Checksum of the guide content after this change; null when the guide was deleted. - `organization_id: optional string or null` @@ -27729,17 +27502,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional string or null` + - `previous_checksum: optional string or null` - The targeted plugin's previous enabled state, when a single plugin's state changed; null when the plugin did not previously exist or multiple plugins changed. + Checksum of the guide content before this change; null when the guide did not exist. - - `type: optional "claude_code_user_plugins_updated"` + - `type: optional "claude_code_team_onboarding_guide_updated"` - default: claude_code_user_plugins_updated + default: claude_code_team_onboarding_guide_updated - - `ClaudeCodeUserSettingsUpdated object` + - `ClaudeCodeUserMarketplacesUpdated object` - A user's synced Claude Code settings were updated or deleted on Anthropic servers. + A user's Claude Code plugin marketplace selections were updated on Anthropic servers. - `actor: object or object or object or 8 more` @@ -27954,7 +27727,7 @@ compliance activities that can be filtered by various criteria. - `deleted_all: boolean` - True when the user's entire synced settings store was deleted in one request. + True when all of the user's marketplace selections were removed in one request. - `id: optional string` @@ -27972,7 +27745,7 @@ compliance activities that can be filtered by various criteria. - `keys_deleted_count: optional number or null` - Number of settings entries removed. + Number of marketplace selections removed. - `keys_written: optional array of string` @@ -27980,11 +27753,11 @@ compliance activities that can be filtered by various criteria. - `keys_written_count: optional number or null` - Number of settings entries created or updated. + Number of marketplace selections added or whose source changed. - - `new_checksum: optional string or null` + - `new_value: optional string or null` - Checksum of the user's synced settings after this change. + Withdrawn — never populated. - `organization_id: optional string or null` @@ -27994,17 +27767,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_checksum: optional string or null` + - `previous_value: optional string or null` - Checksum of the user's synced settings before this change; null when the store did not exist. + Withdrawn — never populated. - - `type: optional "claude_code_user_settings_updated"` + - `type: optional "claude_code_user_marketplaces_updated"` - default: claude_code_user_settings_updated + default: claude_code_user_marketplaces_updated - - `ClaudeFileAccessFailed object` + - `ClaudeCodeUserMemoryUpdated object` - A user was denied access to a file in Claude.ai. + A user's synced private Claude Code memory was updated or deleted on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28217,27 +27990,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` + - `deleted_all: boolean` - The file the user was denied access to, e.g. "claude_file_01HX...". + True when the user's entire synced memory for this scope was deleted in one request. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_id: optional string or null` + - `created_at: optional string` - The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + When this activity occurred. - - `claude_project_id: optional string or null` + format: date-time - The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `keys_deleted: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_deleted_count`. - When this activity occurred. + - `keys_deleted_count: optional number or null` - format: date-time + Number of memory file paths removed. + + - `keys_written: optional array of string` + + Withdrawn — never populated. See `keys_written_count`. + + - `keys_written_count: optional number or null` + + Number of memory file paths created or updated. + + - `new_checksum: optional string or null` + + Checksum of the user's synced memory after this change. - `organization_id: optional string or null` @@ -28247,19 +28032,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_access_failed"` + - `previous_checksum: optional string or null` - default: claude_file_access_failed + Checksum of the user's synced memory before this change; null when the store did not exist. - - `filename: optional string or null` + - `repo: optional string or null` - **Deprecated** + Withdrawn — never populated. - Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + - `type: optional "claude_code_user_memory_updated"` - - `ClaudeFileExported object` + default: claude_code_user_memory_updated - A file was exported from Claude to an external storage destination. + - `ClaudeCodeUserPluginsUpdated object` + + A user's Claude Code plugin selections — which plugins are installed and enabled — were updated on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28472,35 +28259,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `export_destination: "google_drive" or "unspecified"` + - `deleted_all: boolean` - The external destination the file was exported to. + True when all of the user's plugin selections were removed in one request. - - `"google_drive"` + - `id: optional string` - - `"unspecified"` + Unique identifier for the activity e.g. 'activity_abcd1234' - - `filename: string` + - `created_at: optional string` - Name of the exported file. + When this activity occurred. - - `id: optional string` + format: date-time - Unique identifier for the activity e.g. 'activity_abcd1234' + - `keys_deleted: optional array of string` - - `claude_chat_id: optional string or null` + Withdrawn — never populated. See `keys_deleted_count`. - The chat conversation the file was exported from, if the export originated in a chat, e.g. "claude_chat_01HX...". + - `keys_deleted_count: optional number or null` - - `claude_file_id: optional string or null` + Number of plugin selections removed. - The exported file, e.g. "claude_file_01HX...", if the file has a stored file record; files that exist only inside a session have no file ID. + - `keys_written: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_written_count`. - When this activity occurred. + - `keys_written_count: optional number or null` - format: date-time + Number of plugin selections added or whose enabled state changed. + + - `new_value: optional string or null` + + The targeted plugin's new enabled state, when a single plugin's state changed. - `organization_id: optional string or null` @@ -28510,13 +28301,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_exported"` + - `previous_value: optional string or null` - default: claude_file_exported + The targeted plugin's previous enabled state, when a single plugin's state changed; null when the plugin did not previously exist or multiple plugins changed. - - `ClaudeFileViewed object` + - `type: optional "claude_code_user_plugins_updated"` - A user viewed a file in Claude.ai. + default: claude_code_user_plugins_updated + + - `ClaudeCodeUserSettingsUpdated object` + + A user's synced Claude Code settings were updated or deleted on Anthropic servers. - `actor: object or object or object or 8 more` @@ -28729,27 +28524,39 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` + - `deleted_all: boolean` - The file that was viewed, e.g. "claude_file_01HX...". + True when the user's entire synced settings store was deleted in one request. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_artifact_id: optional string or null` + - `created_at: optional string` - The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + When this activity occurred. - - `claude_project_id: optional string or null` + format: date-time - The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `keys_deleted: optional array of string` - - `created_at: optional string` + Withdrawn — never populated. See `keys_deleted_count`. - When this activity occurred. + - `keys_deleted_count: optional number or null` - format: date-time + Number of settings entries removed. + + - `keys_written: optional array of string` + + Withdrawn — never populated. See `keys_written_count`. + + - `keys_written_count: optional number or null` + + Number of settings entries created or updated. + + - `new_checksum: optional string or null` + + Checksum of the user's synced settings after this change. - `organization_id: optional string or null` @@ -28759,19 +28566,27 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_viewed"` + - `previous_checksum: optional string or null` - default: claude_file_viewed + Checksum of the user's synced settings before this change; null when the store did not exist. - - `filename: optional string or null` + - `type: optional "claude_code_user_settings_updated"` - **Deprecated** + default: claude_code_user_settings_updated - Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + - `ClaudeEnterpriseUpgradeCreditUpdated object` - - `ClaudeProjectSyncSourceCreated object` + An organization admin cancelled, or turned back on, the monthly usage credit the organization receives for upgrading from the Team plan to the Enterprise plan, together with the recurring monthly charge that accompanies it. - A sync source was connected to a Claude project's knowledge base. + - `action: "cancelled" or "resumed" or "unspecified"` + + Whether the credit was cancelled or turned back on + + - `"cancelled"` + + - `"resumed"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -28984,18 +28799,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` - - Tagged ID of the project the sync source was connected to. - - - `claude_project_sync_source_id: string` - - Tagged ID of the per-project sync source that was created. - - - `provider: string` - - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -29014,17 +28817,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_project_sync_source_created"` + - `type: optional "claude_enterprise_upgrade_credit_updated"` - default: claude_project_sync_source_created + default: claude_enterprise_upgrade_credit_updated - - `ClaudeProjectSyncSourceDeleted object` + - `ClaudeFileAccessFailed object` - A sync source was disconnected from a Claude project's knowledge base. + A user was denied access to a file in Claude.ai. - `actor: object or object or object or 8 more` @@ -29237,21 +29036,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `claude_file_id: string` - Tagged ID of the project the sync source was disconnected from. + The file the user was denied access to, e.g. "claude_file_01HX...". - - `claude_project_sync_source_id: string` + - `id: optional string` - Tagged ID of the per-project sync source that was deleted. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `provider: string` + - `claude_artifact_id: optional string or null` - The external provider backing the sync source. Always `unspecified` for deletion events. + The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". - - `id: optional string` + - `claude_project_id: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The project the file was accessed through, if any, e.g. "claude_proj_01HX...". - `created_at: optional string` @@ -29267,13 +29066,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_project_sync_source_deleted"` + - `type: optional "claude_file_access_failed"` - default: claude_project_sync_source_deleted + default: claude_file_access_failed - - `ClaudeProjectSyncSourceUpdated object` + - `filename: optional string or null` - A Claude project sync source's configuration was updated. + **Deprecated** + + Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. + + - `ClaudeFileExported object` + + A file was exported from Claude to an external storage destination. - `actor: object or object or object or 8 more` @@ -29486,25 +29291,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_project_id: string` + - `export_destination: "google_drive" or "unspecified"` - Tagged ID of the project the sync source belongs to. + The external destination the file was exported to. - - `claude_project_sync_source_id: string` + - `"google_drive"` - Tagged ID of the per-project sync source that was updated. + - `"unspecified"` - - `provider: string` + - `filename: string` - The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + Name of the exported file. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `config_changed: optional boolean or null` + - `claude_chat_id: optional string or null` - Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. + The chat conversation the file was exported from, if the export originated in a chat, e.g. "claude_chat_01HX...". + + - `claude_file_id: optional string or null` + + The exported file, e.g. "claude_file_01HX...", if the file has a stored file record; files that exist only inside a session have no file ID. - `created_at: optional string` @@ -29520,17 +29329,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `resource_descriptor: optional string or null` - - A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - - `type: optional "claude_project_sync_source_updated"` + - `type: optional "claude_file_exported"` - default: claude_project_sync_source_updated + default: claude_file_exported - - `ClaudeUserSeatTierUpdated object` + - `ClaudeFileViewed object` - An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed. + A user viewed a file in Claude.ai. - `actor: object or object or object or 8 more` @@ -29743,28 +29548,28 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_email: string` - - Email address of the member at the time of the change. - - - `user_id: string` + - `claude_file_id: string` - Tagged ID of the member whose seat tier changed. + The file that was viewed, e.g. "claude_file_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_artifact_id: optional string or null` + + The artifact the file was accessed through, if any, e.g. "claude_artifact_01HX...". + + - `claude_project_id: optional string or null` + + The project the file was accessed through, if any, e.g. "claude_proj_01HX...". + - `created_at: optional string` When this activity occurred. format: date-time - - `current_seat_tier: optional string or null` - - The member's seat tier after this change, or null if the seat was removed. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -29773,17 +29578,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_seat_tier: optional string or null` + - `type: optional "claude_file_viewed"` - The member's seat tier before this change, or null if no seat was assigned. + default: claude_file_viewed - - `type: optional "claude_user_seat_tier_updated"` + - `filename: optional string or null` - default: claude_user_seat_tier_updated + **Deprecated** - - `CliPluginExecPolicyUpdated object` + Deprecated — DO NOT USE. Always empty; the file's display name is intentionally omitted. - Admin set or cleared the per-op permission ceiling for a plugin CLI. + - `ClaudeProjectSyncSourceCreated object` + + A sync source was connected to a Claude project's knowledge base. - `actor: object or object or object or 8 more` @@ -29996,25 +29803,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cli_name: string` - - CLI name as declared by the plugin manifest - - - `marketplace_id: string` - - Marketplace ID owning the plugin - - - `op_name: string` + - `claude_project_id: string` - Op name (or '*' for the per-CLI default) + Tagged ID of the project the sync source was connected to. - - `plugin_id: string` + - `claude_project_sync_source_id: string` - Plugin ID resolved from the URL + Tagged ID of the per-project sync source that was created. - - `plugin_name: string` + - `provider: string` - Plugin name within its marketplace + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. - `id: optional string` @@ -30026,10 +29825,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `max_permission: optional string or null` - - New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -30038,17 +29833,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_max_permission: optional string or null` + - `resource_descriptor: optional string or null` - Max permission the op had before this change ('allow' | 'ask' | 'blocked'), or null when no policy existed for the op + A short provider-specific identifier for the external resource that was connected, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `type: optional "cli_plugin_exec_policy_updated"` + - `type: optional "claude_project_sync_source_created"` - default: cli_plugin_exec_policy_updated + default: claude_project_sync_source_created - - `ClaudeCommandCreated object` + - `ClaudeProjectSyncSourceDeleted object` - Command was created. + A sync source was disconnected from a Claude project's knowledge base. - `actor: object or object or object or 8 more` @@ -30261,13 +30056,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `claude_project_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the project the sync source was disconnected from. - - `command_id: optional string or null` + - `claude_project_sync_source_id: string` - - `command_name: optional string or null` + Tagged ID of the per-project sync source that was deleted. + + - `provider: string` + + The external provider backing the sync source. Always `unspecified` for deletion events. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -30283,13 +30086,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_created"` + - `type: optional "claude_project_sync_source_deleted"` - default: claude_command_created + default: claude_project_sync_source_deleted - - `ClaudeCommandDeleted object` + - `ClaudeProjectSyncSourceUpdated object` - Command was deleted. + A Claude project sync source's configuration was updated. - `actor: object or object or object or 8 more` @@ -30502,13 +30305,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_project_id: string` + + Tagged ID of the project the sync source belongs to. + + - `claude_project_sync_source_id: string` + + Tagged ID of the per-project sync source that was updated. + + - `provider: string` + + The external provider backing the sync source, e.g. `github`, `google_drive`, `outline`, `slack`, `salesforce`, `google_calendar`, `gmail`, `asana`, or `mcp_resources`. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `command_id: optional string or null` + - `config_changed: optional boolean or null` - - `command_name: optional string or null` + Whether the update changed the stored sync-source configuration, including sync settings such as path filters. False for a re-sync or a metadata-only refresh of the same resource. - `created_at: optional string` @@ -30524,13 +30339,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_deleted"` + - `resource_descriptor: optional string or null` - default: claude_command_deleted + A short provider-specific identifier for the external resource after the update, e.g. `owner/repo` for GitHub or a file ID for Google Drive. - - `ClaudeCommandReplaced object` + - `type: optional "claude_project_sync_source_updated"` - Command was replaced. + default: claude_project_sync_source_updated + + - `ClaudeUserSeatTierUpdated object` + + An organization member's seat tier was changed. A null `previous_seat_tier` means the member previously had no seat assigned; a null `current_seat_tier` means the seat was removed. - `actor: object or object or object or 8 more` @@ -30743,13 +30562,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `user_email: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Email address of the member at the time of the change. - - `command_id: optional string or null` + - `user_id: string` - - `command_name: optional string or null` + Tagged ID of the member whose seat tier changed. + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -30757,6 +30580,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_seat_tier: optional string or null` + + The member's seat tier after this change, or null if the seat was removed. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -30765,13 +30592,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_command_replaced"` + - `previous_seat_tier: optional string or null` - default: claude_command_replaced + The member's seat tier before this change, or null if no seat was assigned. - - `ComplianceAPIAccessed object` + - `type: optional "claude_user_seat_tier_updated"` - Logging event auto-generated for each compliance API request. + default: claude_user_seat_tier_updated + + - `CliPluginExecPolicyUpdated object` + + Admin set or cleared the per-op permission ceiling for a plugin CLI. - `actor: object or object or object or 8 more` @@ -30984,23 +30815,25 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `request_id: string` + - `cli_name: string` - - `request_method: "DELETE" or "GET" or "POST" or "PUT"` + CLI name as declared by the plugin manifest - - `"DELETE"` + - `marketplace_id: string` - - `"GET"` + Marketplace ID owning the plugin - - `"POST"` + - `op_name: string` - - `"PUT"` + Op name (or '*' for the per-CLI default) - - `status_code: number` + - `plugin_id: string` - HTTP status code + Plugin ID resolved from the URL - - `url: string` + - `plugin_name: string` + + Plugin name within its marketplace - `id: optional string` @@ -31012,6 +30845,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `max_permission: optional string or null` + + New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -31020,17 +30857,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `request_body: optional string or null` + - `previous_max_permission: optional string or null` - Serialized JSON request body + Max permission the op had before this change ('allow' | 'ask' | 'blocked'), or null when no policy existed for the op - - `type: optional "compliance_api_accessed"` + - `type: optional "cli_plugin_exec_policy_updated"` - default: compliance_api_accessed + default: cli_plugin_exec_policy_updated - - `CoworkSessionUpdated object` + - `ClaudeCommandCreated object` - A Cowork session was updated. + Command was created. - `actor: object or object or object or 8 more` @@ -31243,17 +31080,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `cowork_session_id: string` - - Tagged ID of the updated session, e.g. "sess_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_id: optional string or null` + - `command_id: optional string or null` - Tagged ID of the project the session was moved to, if any, e.g. "claude_proj_01HX...". Absent when the session was removed from its project. + - `command_name: optional string or null` - `created_at: optional string` @@ -31269,13 +31102,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "cowork_session_updated"` + - `type: optional "claude_command_created"` - default: cowork_session_updated + default: claude_command_created - - `DesignProjectArtifactPublished object` + - `ClaudeCommandDeleted object` - A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings. + Command was deleted. - `actor: object or object or object or 8 more` @@ -31488,24 +31321,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project whose content was published, e.g. "design_proj_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `command_id: optional string or null` + + - `command_name: optional string or null` + - `created_at: optional string` When this activity occurred. format: date-time - - `is_public: optional boolean or null` - - True when the published artifact is publicly viewable after this call (anyone with the link). False when it is not — by default, a newly published artifact is visible only to the person who published it. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -31514,17 +31343,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_artifact_published"` + - `type: optional "claude_command_deleted"` - default: design_project_artifact_published + default: claude_command_deleted - - `DesignProjectCreated object` + - `ClaudeCommandReplaced object` - A Claude Design project was created. + Command was replaced. - `actor: object or object or object or 8 more` @@ -31737,18 +31562,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `creation_method: string` - - How the project was created: "direct", "duplicate", "remix", or "template_from_project". - - - `design_project_id: string` - - The Design project that was created, e.g. "design_proj_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `command_id: optional string or null` + + - `command_name: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -31763,21 +31584,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project type: "project", "template", or "design_system". - - - `source_project_id: optional string or null` - - The source project this was created from, when created via duplicate, remix, or template-from-project. Unset for direct creation. - - - `type: optional "design_project_created"` + - `type: optional "claude_command_replaced"` - default: design_project_created + default: claude_command_replaced - - `DesignProjectDeleted object` + - `ComplianceAPIAccessed object` - A Claude Design project was deleted. + Logging event auto-generated for each compliance API request. - `actor: object or object or object or 8 more` @@ -31990,9 +31803,31 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` + - `request_id: string` - The Design project that was deleted, e.g. "design_proj_01HX...". + Identifier of the request, as returned in the response's request-id header + + - `request_method: "DELETE" or "GET" or "POST" or 2 more` + + HTTP method of the request + + - `"DELETE"` + + - `"GET"` + + - `"POST"` + + - `"PUT"` + + - `"unspecified"` + + - `status_code: number` + + HTTP status code + + - `url: string` + + Full URL that was requested, including any query string - `id: optional string` @@ -32012,13 +31847,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "design_project_deleted"` + - `request_body: optional string or null` - default: design_project_deleted + Serialized JSON request body - - `DesignProjectMemberAdded object` + - `type: optional "compliance_api_accessed"` - A member was granted access to a Claude Design project. + default: compliance_api_accessed + + - `CoworkSessionUpdated object` + + A Cowork session was updated. - `actor: object or object or object or 8 more` @@ -32231,26 +32070,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project the member was added to, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` - - The kind of member that was added: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). - - - `role: string` + - `cowork_session_id: string` - The role the member was granted: "viewer", "commenter", or "editor". Access-group ("compartment") members are always view-only. + Tagged ID of the updated session, e.g. "sess_01HX...". - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_id: optional string or null` + + Tagged ID of the project the session was moved to, if any, e.g. "claude_proj_01HX...". Absent when the session was removed from its project. + - `created_at: optional string` When this activity occurred. @@ -32265,17 +32096,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_member_added"` + - `type: optional "cowork_session_updated"` - default: design_project_member_added + default: cowork_session_updated - - `DesignProjectMemberRemoved object` + - `DesignProjectArtifactPublished object` - A member's access to a Claude Design project was revoked. + A Claude Design project's content was published as a claude.ai artifact, making a snapshot of one of its files viewable outside the project's sharing settings. - `actor: object or object or object or 8 more` @@ -32490,15 +32317,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project the member was removed from, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` - - The kind of member that was removed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + The Design project whose content was published, e.g. "design_proj_01HX...". - `id: optional string` @@ -32510,6 +32329,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `is_public: optional boolean or null` + + True when the published artifact is publicly viewable after this call (anyone with the link). False when it is not — by default, a newly published artifact is visible only to the person who published it. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -32522,13 +32345,13 @@ compliance activities that can be filtered by various criteria. The project's type: "project", "template", or "design_system". - - `type: optional "design_project_member_removed"` + - `type: optional "design_project_artifact_published"` - default: design_project_member_removed + default: design_project_artifact_published - - `DesignProjectMemberRoleUpdated object` + - `DesignProjectCreated object` - A Claude Design project member's role was changed. + A Claude Design project was created. - `actor: object or object or object or 8 more` @@ -32741,21 +32564,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `design_project_id: string` - - The Design project the member belongs to, e.g. "design_proj_01HX...". - - - `principal_id: string` - - The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - - `principal_type: string` + - `creation_method: string` - The kind of member whose role was changed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + How the project was created: "direct", "duplicate", "remix", or "template_from_project". - - `role: string` + - `design_project_id: string` - The member's role after the change: "viewer", "commenter", or "editor". + The Design project that was created, e.g. "design_proj_01HX...". - `id: optional string` @@ -32775,21 +32590,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_role: optional string or null` + - `project_type: optional string or null` - The member's role before the change. + The project type: "project", "template", or "design_system". - - `project_type: optional string or null` + - `source_project_id: optional string or null` - The project's type: "project", "template", or "design_system". + The source project this was created from, when created via duplicate, remix, or template-from-project. Unset for direct creation. - - `type: optional "design_project_member_role_updated"` + - `type: optional "design_project_created"` - default: design_project_member_role_updated + default: design_project_created - - `DesignProjectPublished object` + - `DesignProjectDeleted object` - A Claude Design template or design system was published, making it discoverable by everyone in its organization. + A Claude Design project was deleted. - `actor: object or object or object or 8 more` @@ -33004,7 +32819,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was published, e.g. "design_proj_01HX...". + The Design project that was deleted, e.g. "design_proj_01HX...". - `id: optional string` @@ -33024,17 +32839,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` - - The project's type: "template" or "design_system". - - - `type: optional "design_project_published"` + - `type: optional "design_project_deleted"` - default: design_project_published + default: design_project_deleted - - `DesignProjectSharingUpdated object` + - `DesignProjectMemberAdded object` - A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added). + A member was granted access to a Claude Design project. - `actor: object or object or object or 8 more` @@ -33249,15 +33060,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project whose sharing settings changed, e.g. "design_proj_01HX...". + The Design project the member was added to, e.g. "design_proj_01HX...". - - `new_link_permission: string` + - `principal_id: string` - What people opening the project through its link may do after the change: "view", "comment", or "edit". + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". - - `new_scope: string` + - `principal_type: string` - Who the project link is set to work for after the change: "invited" (only the owner and individually invited members) or "org" (anyone in the project's organization, where the organization's own sharing settings allow org-wide visibility). This records the project's stored setting as changed by the actor; organization-level settings can further restrict who the link actually admits, and changes to those settings are not project events. Projects created before link sharing was restricted may also report a legacy "public" value. + The kind of member that was added: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + + - `role: string` + + The role the member was granted: "viewer", "commenter", or "editor". Access-group ("compartment") members are always view-only. - `id: optional string` @@ -33277,25 +33092,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_link_permission: optional string or null` - - What people opening the project through its link could do before the change. - - - `previous_scope: optional string or null` - - Who the project link was set to work for before the change — the stored setting, with the same organization-level caveat as new_scope. May include the legacy "public" value. - - `project_type: optional string or null` The project's type: "project", "template", or "design_system". - - `type: optional "design_project_sharing_updated"` + - `type: optional "design_project_member_added"` - default: design_project_sharing_updated + default: design_project_member_added - - `DesignProjectUnpublished object` + - `DesignProjectMemberRemoved object` - A Claude Design template or design system was unpublished, removing it from its organization's shared gallery. + A member's access to a Claude Design project was revoked. - `actor: object or object or object or 8 more` @@ -33510,7 +33317,15 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was unpublished, e.g. "design_proj_01HX...". + The Design project the member was removed from, e.g. "design_proj_01HX...". + + - `principal_id: string` + + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". + + - `principal_type: string` + + The kind of member that was removed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). - `id: optional string` @@ -33532,15 +33347,15 @@ compliance activities that can be filtered by various criteria. - `project_type: optional string or null` - The project's type: "template" or "design_system". + The project's type: "project", "template", or "design_system". - - `type: optional "design_project_unpublished"` + - `type: optional "design_project_member_removed"` - default: design_project_unpublished + default: design_project_member_removed - - `DesignProjectUpdated object` + - `DesignProjectMemberRoleUpdated object` - A Claude Design project's metadata was updated. + A Claude Design project member's role was changed. - `actor: object or object or object or 8 more` @@ -33755,7 +33570,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was updated, e.g. "design_proj_01HX...". + The Design project the member belongs to, e.g. "design_proj_01HX...". + + - `principal_id: string` + + The member's identifier: a tagged user ID (e.g. "user_01HX...") for "account", the group's identifier for "compartment", or the service's identifier for "trusted_service". + + - `principal_type: string` + + The kind of member whose role was changed: "account" (a user), "compartment" (a named access group), or "trusted_service" (an authorized agent). + + - `role: string` + + The member's role after the change: "viewer", "commenter", or "editor". - `id: optional string` @@ -33775,21 +33602,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `project_type: optional string or null` + - `previous_role: optional string or null` - The project's type after the update: "project", "template", or "design_system". Present only when the update changed it. + The member's role before the change. - - `type: optional "design_project_updated"` + - `project_type: optional string or null` - default: design_project_updated + The project's type: "project", "template", or "design_system". - - `updated_fields: optional array of string` + - `type: optional "design_project_member_role_updated"` - Names of the fields changed by this update, e.g. "name", "description", "project_type", "design_systems". + default: design_project_member_role_updated - - `DesignProjectVersionRestored object` + - `DesignProjectPublished object` - A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files. + A Claude Design template or design system was published, making it discoverable by everyone in its organization. - `actor: object or object or object or 8 more` @@ -34004,7 +33831,7 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project that was restored, e.g. "design_proj_01HX...". + The Design project that was published, e.g. "design_proj_01HX...". - `id: optional string` @@ -34026,19 +33853,15 @@ compliance activities that can be filtered by various criteria. - `project_type: optional string or null` - The project's type: "project", "template", or "design_system". - - - `type: optional "design_project_version_restored"` + The project's type: "template" or "design_system". - default: design_project_version_restored + - `type: optional "design_project_published"` - - `DesignProjectViewed object` + default: design_project_published - A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader. + - `DesignProjectSharingUpdated object` - This activity type is retired: project content reads are no longer - recorded. Events of this type may still appear in feeds for reads that - occurred while it was active. + A Claude Design project's link-sharing settings were changed — who the project's link works for, and what people opening it through the link may do. Access granted to individual members is reported separately (see design_project_member_added). - `actor: object or object or object or 8 more` @@ -34253,19 +34076,19 @@ compliance activities that can be filtered by various criteria. - `design_project_id: string` - The Design project whose content was read, e.g. "design_proj_01HX...". + The Design project whose sharing settings changed, e.g. "design_proj_01HX...". - - `surface: string` + - `new_link_permission: string` - Which read surface recorded this open: "project" (the project was opened), "project_data" (the project's full contents were read or made readable — either a direct data read, which also includes the project's conversations when the reader's access extends to them, or a render-token request, which exposes the project's files for the token's lifetime; the two share this value and are not distinguished), "file" (one of the project's files was read), "version" (a saved version of the project's files, including their contents, was read — version-history browsing that lists names without contents is not recorded), or "export" (an authenticated export of the project's contents was requested). + What people opening the project through its link may do after the change: "view", "comment", or "edit". - - `id: optional string` + - `new_scope: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Who the project link is set to work for after the change: "invited" (only the owner and individually invited members) or "org" (anyone in the project's organization, where the organization's own sharing settings allow org-wide visibility). This records the project's stored setting as changed by the actor; organization-level settings can further restrict who the link actually admits, and changes to those settings are not project events. Projects created before link sharing was restricted may also report a legacy "public" value. - - `access_via: optional string or null` + - `id: optional string` - How the viewer was authorized to open the project: "owner" (the project's owner), "member_grant" (an individually invited member), "org_link" (org-wide link sharing), "trusted_service" (an authorized agent), or "design_system_reference" (an indirect read of a design system through a project that uses it). + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -34281,17 +34104,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `previous_link_permission: optional string or null` + + What people opening the project through its link could do before the change. + + - `previous_scope: optional string or null` + + Who the project link was set to work for before the change — the stored setting, with the same organization-level caveat as new_scope. May include the legacy "public" value. + - `project_type: optional string or null` The project's type: "project", "template", or "design_system". - - `type: optional "design_project_viewed"` + - `type: optional "design_project_sharing_updated"` - default: design_project_viewed + default: design_project_sharing_updated - - `DesktopExtensionAllowlisted object` + - `DesignProjectUnpublished object` - A desktop extension was added to an org's allowlist. + A Claude Design template or design system was unpublished, removing it from its organization's shared gallery. - `actor: object or object or object or 8 more` @@ -34504,9 +34335,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - Allowlisted DXT extension ID + The Design project that was unpublished, e.g. "design_proj_01HX...". - `id: optional string` @@ -34526,13 +34357,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_allowlisted"` + - `project_type: optional string or null` - default: desktop_extension_allowlisted + The project's type: "template" or "design_system". - - `DesktopExtensionBlocklisted object` + - `type: optional "design_project_unpublished"` - A desktop extension was added to the global blocklist. + default: design_project_unpublished + + - `DesignProjectUpdated object` + + A Claude Design project's metadata was updated. - `actor: object or object or object or 8 more` @@ -34745,9 +34580,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - Blocklisted DXT extension ID + The Design project that was updated, e.g. "design_proj_01HX...". - `id: optional string` @@ -34767,13 +34602,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_blocklisted"` + - `project_type: optional string or null` - default: desktop_extension_blocklisted + The project's type after the update: "project", "template", or "design_system". Present only when the update changed it. - - `DesktopExtensionDeleted object` + - `type: optional "design_project_updated"` - A desktop extension was deleted, either globally by an admin or org-scoped by an org owner. + default: design_project_updated + + - `updated_fields: optional array of string` + + Names of the fields changed by this update, e.g. "name", "description", "project_type", "design_systems". + + - `DesignProjectVersionRestored object` + + A Claude Design project's working tree was rolled back to a previously saved version, replacing its current files with that version's files. - `actor: object or object or object or 8 more` @@ -34986,9 +34829,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - DXT extension ID + The Design project that was restored, e.g. "design_proj_01HX...". - `id: optional string` @@ -35008,17 +34851,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_deleted"` + - `project_type: optional string or null` - default: desktop_extension_deleted + The project's type: "project", "template", or "design_system". - - `version: optional string or null` + - `type: optional "design_project_version_restored"` - Specific version deleted (null if all versions) + default: design_project_version_restored - - `DesktopExtensionRemovedFromAllowlist object` + - `DesignProjectViewed object` - A desktop extension was removed from an org's allowlist. + A Claude Design project's content was read. The surface field records which kind of read — a project open, a full-content read, a single-file read, a saved-version read, or an export request. The actor is the reader. + + This activity type is retired: project content reads are no longer + recorded. Events of this type may still appear in feeds for reads that + occurred while it was active. - `actor: object or object or object or 8 more` @@ -35231,14 +35078,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `extension_id: string` + - `design_project_id: string` - DXT extension ID removed from allowlist + The Design project whose content was read, e.g. "design_proj_01HX...". + + - `surface: string` + + Which read surface recorded this open: "project" (the project was opened), "project_data" (the project's full contents were read or made readable — either a direct data read, which also includes the project's conversations when the reader's access extends to them, or a render-token request, which exposes the project's files for the token's lifetime; the two share this value and are not distinguished), "file" (one of the project's files was read), "version" (a saved version of the project's files, including their contents, was read — version-history browsing that lists names without contents is not recorded), or "export" (an authenticated export of the project's contents was requested). - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `access_via: optional string or null` + + How the viewer was authorized to open the project: "owner" (the project's owner), "member_grant" (an individually invited member), "org_link" (org-wide link sharing), "trusted_service" (an authorized agent), or "design_system_reference" (an indirect read of a design system through a project that uses it). + - `created_at: optional string` When this activity occurred. @@ -35253,13 +35108,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_removed_from_allowlist"` + - `project_type: optional string or null` - default: desktop_extension_removed_from_allowlist + The project's type: "project", "template", or "design_system". - - `DesktopExtensionUnblocked object` + - `type: optional "design_project_viewed"` - A desktop extension was removed from the global blocklist. + default: design_project_viewed + + - `DesktopExtensionAllowlisted object` + + A desktop extension was added to an org's allowlist. - `actor: object or object or object or 8 more` @@ -35474,7 +35333,7 @@ compliance activities that can be filtered by various criteria. - `extension_id: string` - Unblocked DXT extension ID + Allowlisted DXT extension ID - `id: optional string` @@ -35494,13 +35353,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_unblocked"` + - `type: optional "desktop_extension_allowlisted"` - default: desktop_extension_unblocked + default: desktop_extension_allowlisted - - `DesktopExtensionUploaded object` + - `DesktopExtensionBlocklisted object` - A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner. + A desktop extension was added to the global blocklist. - `actor: object or object or object or 8 more` @@ -35715,11 +35574,7 @@ compliance activities that can be filtered by various criteria. - `extension_id: string` - DXT extension ID - - - `version: string` - - Version string from the manifest + Blocklisted DXT extension ID - `id: optional string` @@ -35739,13 +35594,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_uploaded"` + - `type: optional "desktop_extension_blocklisted"` - default: desktop_extension_uploaded + default: desktop_extension_blocklisted - - `DesktopExtensionVersionUploaded object` + - `DesktopExtensionDeleted object` - A new version of an existing org-owned desktop extension was uploaded. + A desktop extension was deleted, either globally by an admin or org-scoped by an org owner. - `actor: object or object or object or 8 more` @@ -35962,10 +35817,6 @@ compliance activities that can be filtered by various criteria. DXT extension ID - - `version: string` - - Version string from the manifest - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -35984,14 +35835,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "desktop_extension_version_uploaded"` + - `type: optional "desktop_extension_deleted"` - default: desktop_extension_version_uploaded + default: desktop_extension_deleted - - `InferenceHooksConfigDeleted object` + - `version: optional string or null` - Inference hooks configuration was removed for the - organization. + Specific version deleted (null if all versions) + + - `DesktopExtensionRemovedFromAllowlist object` + + A desktop extension was removed from an org's allowlist. - `actor: object or object or object or 8 more` @@ -36204,6 +36058,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `extension_id: string` + + DXT extension ID removed from allowlist + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -36222,14 +36080,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "inference_hooks_config_deleted"` + - `type: optional "desktop_extension_removed_from_allowlist"` - default: inference_hooks_config_deleted + default: desktop_extension_removed_from_allowlist - - `InferenceHooksConfigUpdated object` + - `DesktopExtensionUnblocked object` - Inference hooks configuration was created or updated for the - organization. + A desktop extension was removed from the global blocklist. - `actor: object or object or object or 8 more` @@ -36442,29 +36299,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - Whether Inference hooks enforcement is enabled after this change. - - - `enforcement_mode: string` - - Whether Inference hooks inspects both prompts and responses (prompt_and_response) or prompts only (prompt_only). - - - `fail_mode: string` - - Whether requests are allowed (fail_open) or blocked (fail_closed) when the Inference hooks endpoint cannot be reached. - - - `final_verdict_timeout_ms: number` - - Milliseconds inference waits for the Inference hooks verdict on the response. - - - `prompt_verdict_timeout_ms: number` - - Milliseconds inference waits for the Inference hooks verdict on the prompt. - - - `webhook_url: string` + - `extension_id: string` - The endpoint that inspected prompts and responses are sent to. + Unblocked DXT extension ID - `id: optional string` @@ -36476,20 +36313,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `deny_message: optional string or null` - - Administrator-written text shown to users at the end of the error message when a request is blocked by the organization's Inference hooks policy, as configured after this change. Null when the built-in default message is in effect; an empty string when the administrator configured an empty message, in which case no text is appended. - - - `deny_message_enabled: optional boolean` - - Whether the organization has the appended deny message turned on, as configured after this change. When on, the administrator-written message (or the built-in default, when none is configured) is appended to the error users see when a request is blocked by the organization's Inference hooks policy; no text is appended when the administrator-written message is empty, or when this is off. - - default: true - - - `extra_header_names: optional array of string or null` - - Names of the custom HTTP headers attached to every Inference hooks request after this change, or null when this update did not change headers. Header values are write-only and are not recorded. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -36498,28 +36321,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reset_circuit_breaker: optional boolean` - - Whether this update carried an explicit request to clear the circuit breaker. A tripped breaker otherwise survives configuration updates; it also clears whenever an update enables enforcement. - - default: false - - - `rollout_percentage: optional number or null` - - Percentage of requests (0-100) inspected by Inference hooks after this change, or null when this update did not change it. 0 disables inspection; 100 inspects every request. - - - `shadow_mode: optional boolean or null` - - Whether the organization's Inference hooks run in shadow mode after this change, or null when this update did not change it. In shadow mode, prompts are still sent to the organization's endpoint and verdicts are recorded, but requests are never blocked. - - - `type: optional "inference_hooks_config_updated"` + - `type: optional "desktop_extension_unblocked"` - default: inference_hooks_config_updated + default: desktop_extension_unblocked - - `InferenceHooksSigningSecretGenerated object` + - `DesktopExtensionUploaded object` - A request signing secret was generated for the organization's - Inference hooks configuration. + A desktop extension was uploaded, either globally by an admin or org-scoped by an org owner. - `actor: object or object or object or 8 more` @@ -36732,9 +36540,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `rotated: boolean` + - `extension_id: string` - Whether this generation replaced an existing signing secret (true) or created the organization's first one (false). Replacing a secret invalidates the previous one immediately. + DXT extension ID + + - `version: string` + + Version string from the manifest - `id: optional string` @@ -36754,13 +36566,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "inference_hooks_signing_secret_generated"` + - `type: optional "desktop_extension_uploaded"` - default: inference_hooks_signing_secret_generated + default: desktop_extension_uploaded - - `DomainClaimInitiated object` + - `DesktopExtensionVersionUploaded object` - Domain capture claim initiated over personal accounts on verified domains. + A new version of an existing org-owned desktop extension was uploaded. - `actor: object or object or object or 8 more` @@ -36973,6 +36785,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `extension_id: string` + + DXT extension ID + + - `version: string` + + Version string from the manifest + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -36991,13 +36811,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "domain_claim_initiated"` + - `type: optional "desktop_extension_version_uploaded"` - default: domain_claim_initiated + default: desktop_extension_version_uploaded - - `EndUserInviteRequested object` + - `InferenceHooksConfigDeleted object` - Non-admin member submitted an invite request for a new org member. + Inference hooks configuration was removed for the + organization. - `actor: object or object or object or 8 more` @@ -37210,8 +37031,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37230,13 +37049,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "end_user_invite_requested"` + - `type: optional "inference_hooks_config_deleted"` - default: end_user_invite_requested + default: inference_hooks_config_deleted - - `ExtraUsageBillingEnabled object` + - `InferenceHooksConfigUpdated object` - Usage credit billing was enabled for an organization. + Inference hooks configuration was created or updated for the + organization. - `actor: object or object or object or 8 more` @@ -37449,6 +37269,30 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + + Whether Inference hooks enforcement is enabled after this change. + + - `enforcement_mode: string` + + Whether Inference hooks inspects both prompts and responses (prompt_and_response) or prompts only (prompt_only). + + - `fail_mode: string` + + Whether requests are allowed (fail_open) or blocked (fail_closed) when the Inference hooks endpoint cannot be reached. + + - `final_verdict_timeout_ms: number` + + Milliseconds inference waits for the Inference hooks verdict on the response. + + - `prompt_verdict_timeout_ms: number` + + Milliseconds inference waits for the Inference hooks verdict on the prompt. + + - `webhook_url: string` + + The endpoint that inspected prompts and responses are sent to. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37459,6 +37303,20 @@ compliance activities that can be filtered by various criteria. format: date-time + - `deny_message: optional string or null` + + Administrator-written text shown to users at the end of the error message when a request is blocked by the organization's Inference hooks policy, as configured after this change. Null when the built-in default message is in effect; an empty string when the administrator configured an empty message, in which case no text is appended. + + - `deny_message_enabled: optional boolean` + + Whether the organization has the appended deny message turned on, as configured after this change. When on, the administrator-written message (or the built-in default, when none is configured) is appended to the error users see when a request is blocked by the organization's Inference hooks policy; no text is appended when the administrator-written message is empty, or when this is off. + + default: true + + - `extra_header_names: optional array of string or null` + + Names of the custom HTTP headers attached to every Inference hooks request after this change, or null when this update did not change headers. Header values are write-only and are not recorded. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -37467,13 +37325,28 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "extra_usage_billing_enabled"` + - `reset_circuit_breaker: optional boolean` - default: extra_usage_billing_enabled + Whether this update carried an explicit request to clear the circuit breaker. A tripped breaker otherwise survives configuration updates; it also clears whenever an update enables enforcement. - - `ExtraUsageCreditGranted object` + default: false - A promotional usage credit grant was claimed. + - `rollout_percentage: optional number or null` + + Percentage of requests (0-100) inspected by Inference hooks after this change, or null when this update did not change it. 0 disables inspection; 100 inspects every request. + + - `shadow_mode: optional boolean or null` + + Whether the organization's Inference hooks run in shadow mode after this change, or null when this update did not change it. In shadow mode, prompts are still sent to the organization's endpoint and verdicts are recorded, but requests are never blocked. + + - `type: optional "inference_hooks_config_updated"` + + default: inference_hooks_config_updated + + - `InferenceHooksSigningSecretGenerated object` + + A request signing secret was generated for the organization's + Inference hooks configuration. - `actor: object or object or object or 8 more` @@ -37686,6 +37559,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `rotated: boolean` + + Whether this generation replaced an existing signing secret (true) or created the organization's first one (false). Replacing a secret invalidates the previous one immediately. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -37704,13 +37581,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "extra_usage_credit_granted"` + - `type: optional "inference_hooks_signing_secret_generated"` - default: extra_usage_credit_granted + default: inference_hooks_signing_secret_generated - - `ExtraUsageSpendLimitCreated object` + - `DomainClaimInitiated object` - Usage credit spend limit was created. + Domain capture claim initiated over personal accounts on verified domains. - `actor: object or object or object or 8 more` @@ -37927,24 +37804,12 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `amount: optional number or null` - - The monthly credit limit amount in minor units (e.g. cents). - - `created_at: optional string` When this activity occurred. format: date-time - - `is_enabled: optional boolean or null` - - Whether the spend limit is enabled. - - - `limit_type: optional string or null` - - The type of spend limit created (e.g. organization, seat_tier, member, service, group). - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -37953,23 +37818,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - Tagged ID of the spend limit. - - - `type: optional "extra_usage_spend_limit_created"` - - default: extra_usage_spend_limit_created - - - `user_id: optional string or null` - - **Deprecated** + - `type: optional "domain_claim_initiated"` - Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + default: domain_claim_initiated - - `ExtraUsageSpendLimitDeleted object` + - `EndUserInviteRequested object` - Usage credit spend limit was deleted. + Non-admin member submitted an invite request for a new org member. - `actor: object or object or object or 8 more` @@ -38182,6 +38037,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invitee_email: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -38200,23 +38057,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `spend_limit_id: optional string or null` - - Tagged ID of the spend limit. - - - `type: optional "extra_usage_spend_limit_deleted"` - - default: extra_usage_spend_limit_deleted - - - `user_id: optional string or null` - - **Deprecated** + - `type: optional "end_user_invite_requested"` - Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + default: end_user_invite_requested - - `ExtraUsageSpendLimitIncreaseRequestApproved object` + - `ExtraUsageBillingEnabled object` - A usage credit spend limit increase request was approved. + Usage credit billing was enabled for an organization. - `actor: object or object or object or 8 more` @@ -38433,8 +38280,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `amount: optional number or null` - - `created_at: optional string` When this activity occurred. @@ -38449,19 +38294,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `requester_user_id: optional string or null` - - - `spend_limit_id: optional string or null` - - - `spend_limit_increase_request_id: optional string or null` - - - `type: optional "extra_usage_spend_limit_increase_request_approved"` + - `type: optional "extra_usage_billing_enabled"` - default: extra_usage_spend_limit_increase_request_approved + default: extra_usage_billing_enabled - - `ExtraUsageSpendLimitIncreaseRequestDenied object` + - `ExtraUsageCreditGranted object` - A usage credit spend limit increase request was denied. + A promotional usage credit grant was claimed. - `actor: object or object or object or 8 more` @@ -38692,17 +38531,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `requester_user_id: optional string or null` - - - `spend_limit_increase_request_id: optional string or null` - - - `type: optional "extra_usage_spend_limit_increase_request_denied"` + - `type: optional "extra_usage_credit_granted"` - default: extra_usage_spend_limit_increase_request_denied + default: extra_usage_credit_granted - - `ExtraUsageSpendLimitUpdated object` + - `ExtraUsageSpendLimitCreated object` - Usage credit spend limit was updated. + Usage credit spend limit was created. - `actor: object or object or object or 8 more` @@ -38921,7 +38756,7 @@ compliance activities that can be filtered by various criteria. - `amount: optional number or null` - The new monthly credit limit amount in minor units (e.g. cents). + The monthly credit limit amount in minor units (e.g. cents). - `created_at: optional string` @@ -38935,7 +38770,7 @@ compliance activities that can be filtered by various criteria. - `limit_type: optional string or null` - The type of spend limit updated (e.g. organization, seat_tier, member, service, group). + The type of spend limit created (e.g. organization, seat_tier, member, service, group). - `organization_id: optional string or null` @@ -38949,9 +38784,9 @@ compliance activities that can be filtered by various criteria. Tagged ID of the spend limit. - - `type: optional "extra_usage_spend_limit_updated"` + - `type: optional "extra_usage_spend_limit_created"` - default: extra_usage_spend_limit_updated + default: extra_usage_spend_limit_created - `user_id: optional string or null` @@ -38959,9 +38794,9 @@ compliance activities that can be filtered by various criteria. Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. - - `ClaudeFileDeleted object` + - `ExtraUsageSpendLimitDeleted object` - A file was deleted. + Usage credit spend limit was deleted. - `actor: object or object or object or 8 more` @@ -39174,10 +39009,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` - - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -39196,13 +39027,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_deleted"` + - `spend_limit_id: optional string or null` - default: claude_file_deleted + Tagged ID of the spend limit. - - `ClaudeFileUploaded object` + - `type: optional "extra_usage_spend_limit_deleted"` - A file was uploaded. + default: extra_usage_spend_limit_deleted + + - `user_id: optional string or null` + + **Deprecated** + + Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + + - `ExtraUsageSpendLimitIncreaseRequestApproved object` + + A usage credit spend limit increase request was approved. - `actor: object or object or object or 8 more` @@ -39415,21 +39256,11 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `claude_file_id: string` - - - `filename: string or null` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_chat_id: optional string or null` - - Chat ID if known at upload time (null for the upload-then-attach flow). To find which chats a file was later attached to, use `GET /v1/compliance/apps/chats/files/{claude_file_id}`. - - - `claude_project_id: optional string or null` - - Project ID if file was uploaded to a project + - `amount: optional number or null` - `created_at: optional string` @@ -39445,13 +39276,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_file_uploaded"` + - `requester_user_id: optional string or null` - default: claude_file_uploaded + - `spend_limit_id: optional string or null` - - `GheConfigurationCreated object` + - `spend_limit_increase_request_id: optional string or null` - Admin created a GHE configuration. + - `type: optional "extra_usage_spend_limit_increase_request_approved"` + + default: extra_usage_spend_limit_increase_request_approved + + - `ExtraUsageSpendLimitIncreaseRequestDenied object` + + A usage credit spend limit increase request was denied. - `actor: object or object or object or 8 more` @@ -39664,10 +39501,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` - - ID of the GHE configuration - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -39678,14 +39511,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `display_name: optional string or null` - - Display name given to the configuration - - - `hostname: optional string or null` - - Hostname of the GitHub Enterprise instance - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -39694,17 +39519,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` + - `requester_user_id: optional string or null` - Custom port, if not the HTTPS default + - `spend_limit_increase_request_id: optional string or null` - - `type: optional "ghe_configuration_created"` + - `type: optional "extra_usage_spend_limit_increase_request_denied"` - default: ghe_configuration_created + default: extra_usage_spend_limit_increase_request_denied - - `GheConfigurationDeleted object` + - `ExtraUsageSpendLimitUpdated object` - Admin deleted a GHE configuration. + Usage credit spend limit was updated. - `actor: object or object or object or 8 more` @@ -39917,27 +39742,27 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` - - ID of the GHE configuration - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `amount: optional number or null` + + The new monthly credit limit amount in minor units (e.g. cents). + - `created_at: optional string` When this activity occurred. format: date-time - - `display_name: optional string or null` + - `is_enabled: optional boolean or null` - Display name the configuration had when deleted + Whether the spend limit is enabled. - - `hostname: optional string or null` + - `limit_type: optional string or null` - Hostname of the GitHub Enterprise instance + The type of spend limit updated (e.g. organization, seat_tier, member, service, group). - `organization_id: optional string or null` @@ -39947,17 +39772,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` + - `spend_limit_id: optional string or null` - Custom port, if not the HTTPS default + Tagged ID of the spend limit. - - `type: optional "ghe_configuration_deleted"` + - `type: optional "extra_usage_spend_limit_updated"` - default: ghe_configuration_deleted + default: extra_usage_spend_limit_updated - - `GheConfigurationUpdated object` + - `user_id: optional string or null` - Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced. + **Deprecated** + + Deprecated. Tagged ID of the admin who performed the action — not the target member. Use `spend_limit_id` to look up the target member. + + - `ClaudeFileDeleted object` + + A file was deleted. - `actor: object or object or object or 8 more` @@ -40170,9 +40001,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `ghe_configuration_id: string` + - `claude_file_id: string` - ID of the GHE configuration + - `filename: string or null` - `id: optional string` @@ -40184,38 +40015,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `custom_ca_certificate_updated: optional boolean or null` - - Whether the custom CA certificate was replaced in this update - - - `display_name: optional string or null` - - New display name, when it changed - - - `github_app_client_id: optional string or null` - - New GitHub App client ID, when it changed - - - `github_app_client_secret_updated: optional boolean or null` - - Whether the GitHub App client secret was replaced in this update - - - `github_app_id: optional number or null` - - New GitHub App ID, when it changed - - - `github_app_private_key_updated: optional boolean or null` - - Whether the GitHub App private key was replaced in this update - - - `hostname: optional string or null` - - Hostname of the GitHub Enterprise instance (immutable; included for context) - - - `is_active: optional boolean or null` - - New active state, when it changed - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40224,45 +40023,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `port: optional number or null` - - New port, when it changed - - - `previous_display_name: optional string or null` - - Display name before the change, when it changed - - - `previous_github_app_client_id: optional string or null` - - GitHub App client ID before the change, when it changed - - - `previous_github_app_id: optional number or null` - - GitHub App ID before the change, when it changed - - - `previous_is_active: optional boolean or null` - - Active state before the change, when it changed - - - `previous_port: optional number or null` - - Port before the change, when it changed - - - `read_replica_hostnames_updated: optional boolean or null` - - Whether the read replica hostnames were replaced in this update - - - `type: optional "ghe_configuration_updated"` - - default: ghe_configuration_updated - - - `webhook_secret_updated: optional boolean or null` + - `type: optional "claude_file_deleted"` - Whether the webhook secret was replaced in this update + default: claude_file_deleted - - `GheUserConnected object` + - `ClaudeFileUploaded object` - User connected to a GHE instance. + A file was uploaded. - `actor: object or object or object or 8 more` @@ -40475,20 +40242,28 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `claude_file_id: string` + + - `filename: string or null` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_chat_id: optional string or null` + + Chat ID if known at upload time (null for the upload-then-attach flow). To find which chats a file was later attached to, use `GET /v1/compliance/apps/chats/files/{claude_file_id}`. + + - `claude_project_id: optional string or null` + + Project ID if file was uploaded to a project + - `created_at: optional string` When this activity occurred. format: date-time - - `ghe_configuration_id: optional string or null` - - ID of the GHE configuration - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40497,13 +40272,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_user_connected"` + - `type: optional "claude_file_uploaded"` - default: ghe_user_connected + default: claude_file_uploaded - - `GheUserDisconnected object` + - `GheConfigurationCreated object` - User disconnected from a GHE instance. + Admin created a GHE configuration. - `actor: object or object or object or 8 more` @@ -40716,6 +40491,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `ghe_configuration_id: string` + + ID of the GHE configuration + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -40726,9 +40505,13 @@ compliance activities that can be filtered by various criteria. format: date-time - - `ghe_configuration_id: optional string or null` + - `display_name: optional string or null` - ID of the GHE configuration + Display name given to the configuration + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance - `organization_id: optional string or null` @@ -40738,13 +40521,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_user_disconnected"` + - `port: optional number or null` - default: ghe_user_disconnected + Custom port, if not the HTTPS default - - `GheWebhookSignatureInvalid object` + - `type: optional "ghe_configuration_created"` - Webhook signature validation failed. + default: ghe_configuration_created + + - `GheConfigurationDeleted object` + + Admin deleted a GHE configuration. - `actor: object or object or object or 8 more` @@ -40971,6 +40758,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `display_name: optional string or null` + + Display name the configuration had when deleted + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -40979,13 +40774,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "ghe_webhook_signature_invalid"` + - `port: optional number or null` - default: ghe_webhook_signature_invalid + Custom port, if not the HTTPS default - - `ClaudeGitHubIntegrationCreated object` + - `type: optional "ghe_configuration_deleted"` - A GitHub integration was enabled for the organization. + default: ghe_configuration_deleted + + - `GheConfigurationUpdated object` + + Admin updated a GHE configuration. Previous/new field pairs are recorded only for settings that changed in the update; secret credentials are never recorded, only whether they were replaced. - `actor: object or object or object or 8 more` @@ -41198,7 +40997,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` + - `ghe_configuration_id: string` + + ID of the GHE configuration - `id: optional string` @@ -41210,33 +41011,85 @@ compliance activities that can be filtered by various criteria. format: date-time - - `enabled: optional boolean or null` + - `custom_ca_certificate_updated: optional boolean or null` - Whether the integration is enabled after this change. + Whether the custom CA certificate was replaced in this update + + - `display_name: optional string or null` + + New display name, when it changed + + - `github_app_client_id: optional string or null` + + New GitHub App client ID, when it changed + + - `github_app_client_secret_updated: optional boolean or null` + + Whether the GitHub App client secret was replaced in this update + + - `github_app_id: optional number or null` + + New GitHub App ID, when it changed + + - `github_app_private_key_updated: optional boolean or null` + + Whether the GitHub App private key was replaced in this update + + - `hostname: optional string or null` + + Hostname of the GitHub Enterprise instance (immutable; included for context) + + - `is_active: optional boolean or null` + + New active state, when it changed - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` + - `port: optional number or null` - Whether the integration was enabled before this change; null when the integration had never been configured. + New port, when it changed - - `repository_name: optional string or null` + - `previous_display_name: optional string or null` - - `type: optional "claude_github_integration_created"` + Display name before the change, when it changed - default: claude_github_integration_created + - `previous_github_app_client_id: optional string or null` - - `ClaudeGitHubIntegrationDeleted object` + GitHub App client ID before the change, when it changed - A GitHub integration was disabled for the organization. + - `previous_github_app_id: optional number or null` + + GitHub App ID before the change, when it changed + + - `previous_is_active: optional boolean or null` + + Active state before the change, when it changed + + - `previous_port: optional number or null` + + Port before the change, when it changed + + - `read_replica_hostnames_updated: optional boolean or null` + + Whether the read replica hostnames were replaced in this update + + - `type: optional "ghe_configuration_updated"` + + default: ghe_configuration_updated + + - `webhook_secret_updated: optional boolean or null` + + Whether the webhook secret was replaced in this update + + - `GheUserConnected object` + + User connected to a GHE instance. - `actor: object or object or object or 8 more` @@ -41449,8 +41302,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -41461,33 +41312,25 @@ compliance activities that can be filtered by various criteria. format: date-time - - `enabled: optional boolean or null` + - `ghe_configuration_id: optional string or null` - Whether the integration is enabled after this change. + ID of the GHE configuration - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether the integration was enabled before this change; null when the integration had never been configured. - - - `repository_name: optional string or null` - - - `type: optional "claude_github_integration_deleted"` + - `type: optional "ghe_user_connected"` - default: claude_github_integration_deleted + default: ghe_user_connected - - `ClaudeGitHubIntegrationUpdated object` + - `GheUserDisconnected object` - A GitHub integration's configuration was updated. + User disconnected from a GHE instance. - `actor: object or object or object or 8 more` @@ -41700,8 +41543,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `integration_id: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -41712,25 +41553,25 @@ compliance activities that can be filtered by various criteria. format: date-time + - `ghe_configuration_id: optional string or null` + + ID of the GHE configuration + - `organization_id: optional string or null` Organization ID this activity is associated with - - `organization_name: optional string or null` - - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `repository_name: optional string or null` - - - `type: optional "claude_github_integration_updated"` + - `type: optional "ghe_user_disconnected"` - default: claude_github_integration_updated + default: ghe_user_disconnected - - `GitHubTokenImport object` + - `GheWebhookSignatureInvalid object` - A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed). + Webhook signature validation failed. - `actor: object or object or object or 8 more` @@ -41943,29 +41784,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `result: "failed_internal" or "imported" or "rejected_feature_disabled" or 5 more` - - The outcome of the import. - - - `"failed_internal"` - - - `"imported"` - - - `"rejected_feature_disabled"` - - - `"rejected_invalid_credential"` - - - `"rejected_missing_repo_scope"` - - - `"rejected_tenant_not_ready"` - - - `"rejected_zdr_policy"` - - - `"unspecified"` - - - `source: string` + - `ghe_configuration_id: string` - How the token was imported. + ID of the GHE configuration - `id: optional string` @@ -41977,14 +41798,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_username: optional string or null` - - The GitHub username the imported token authenticates as, when known. - - - `granted_scopes: optional string or null` - - The scopes granted to the imported token, when available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -41993,17 +41806,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `token_fingerprint_sha256: optional string or null` - - Org-scoped SHA-256 of the submitted token: `sha256(org_uuid || 0x00 || token)`, lowercase-hex-encoded, where `org_uuid` is the organization's UUID as a dashed lowercase string, `0x00` is a single zero byte, and `token` is the submitted value's raw bytes. Per-org correlation only — the same token in two orgs produces distinct fingerprints. Set only when the submitted value carries a known GitHub PAT prefix (a high-entropy token format); unset for all other submissions, including rejected non-PAT input. - - - `type: optional "github_token_import"` + - `type: optional "ghe_webhook_signature_invalid"` - default: github_token_import + default: ghe_webhook_signature_invalid - - `ClaudeGdriveIntegrationCreated object` + - `ClaudeGitHubIntegrationCreated object` - A Google Drive integration was enabled for the organization. + A GitHub integration was enabled for the organization. - `actor: object or object or object or 8 more` @@ -42228,23 +42037,33 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` + - `enabled: optional boolean or null` + + Whether the integration is enabled after this change. - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_created"` + - `previous_enabled: optional boolean or null` - default: claude_gdrive_integration_created + Whether the integration was enabled before this change; null when the integration had never been configured. - - `ClaudeGdriveIntegrationDeleted object` + - `repository_name: optional string or null` - A Google Drive integration was disabled for the organization. + - `type: optional "claude_github_integration_created"` + + default: claude_github_integration_created + + - `ClaudeGitHubIntegrationDeleted object` + + A GitHub integration was disabled for the organization. - `actor: object or object or object or 8 more` @@ -42469,23 +42288,33 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` + - `enabled: optional boolean or null` + + Whether the integration is enabled after this change. - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_deleted"` + - `previous_enabled: optional boolean or null` - default: claude_gdrive_integration_deleted + Whether the integration was enabled before this change; null when the integration had never been configured. - - `ClaudeGdriveIntegrationUpdated object` + - `repository_name: optional string or null` - A Google Drive integration's configuration was updated. + - `type: optional "claude_github_integration_deleted"` + + default: claude_github_integration_deleted + + - `ClaudeGitHubIntegrationUpdated object` + + A GitHub integration's configuration was updated. - `actor: object or object or object or 8 more` @@ -42710,23 +42539,25 @@ compliance activities that can be filtered by various criteria. format: date-time - - `folder_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with + - `organization_name: optional string or null` + - `organization_uuid: optional string or null` Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_gdrive_integration_updated"` + - `repository_name: optional string or null` - default: claude_gdrive_integration_updated + - `type: optional "claude_github_integration_updated"` - - `GroupCreated object` + default: claude_github_integration_updated - A group was created (RBAC admin or SCIM provisioning). + - `GitHubTokenImport object` + + A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed). - `actor: object or object or object or 8 more` @@ -42939,13 +42770,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` + - `result: "failed_internal" or "imported" or "rejected_feature_disabled" or 5 more` - Tagged ID of the created group + The outcome of the import. - - `group_name: string` + - `"failed_internal"` - Name of the created group + - `"imported"` + + - `"rejected_feature_disabled"` + + - `"rejected_invalid_credential"` + + - `"rejected_missing_repo_scope"` + + - `"rejected_tenant_not_ready"` + + - `"rejected_zdr_policy"` + + - `"unspecified"` + + - `source: string` + + How the token was imported. - `id: optional string` @@ -42957,6 +42804,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_username: optional string or null` + + The GitHub username the imported token authenticates as, when known. + + - `granted_scopes: optional string or null` + + The scopes granted to the imported token, when available. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -42965,13 +42820,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_created"` + - `token_fingerprint_sha256: optional string or null` - default: group_created + Org-scoped SHA-256 of the submitted token: `sha256(org_uuid || 0x00 || token)`, lowercase-hex-encoded, where `org_uuid` is the organization's UUID as a dashed lowercase string, `0x00` is a single zero byte, and `token` is the submitted value's raw bytes. Per-org correlation only — the same token in two orgs produces distinct fingerprints. Set only when the submitted value carries a known GitHub PAT prefix (a high-entropy token format); unset for all other submissions, including rejected non-PAT input. - - `GroupDeleted object` + - `type: optional "github_token_import"` - A group was deleted (RBAC admin or SCIM provisioning). + default: github_token_import + + - `ClaudeGdriveIntegrationCreated object` + + A Google Drive integration was enabled for the organization. - `actor: object or object or object or 8 more` @@ -43184,9 +43043,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the deleted group + - `integration_id: string` - `id: optional string` @@ -43198,6 +43055,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `folder_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43206,13 +43065,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_deleted"` + - `type: optional "claude_gdrive_integration_created"` - default: group_deleted + default: claude_gdrive_integration_created - - `GroupListViewed object` + - `ClaudeGdriveIntegrationDeleted object` - Admin viewed the list of RBAC groups. + A Google Drive integration was disabled for the organization. - `actor: object or object or object or 8 more` @@ -43425,6 +43284,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `integration_id: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -43435,6 +43296,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `folder_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43443,13 +43306,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_list_viewed"` + - `type: optional "claude_gdrive_integration_deleted"` - default: group_list_viewed + default: claude_gdrive_integration_deleted - - `GroupMemberAdded object` + - `ClaudeGdriveIntegrationUpdated object` - One or more members were added to a group. + A Google Drive integration's configuration was updated. - `actor: object or object or object or 8 more` @@ -43662,9 +43525,7 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the group + - `integration_id: string` - `id: optional string` @@ -43676,9 +43537,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members added: user IDs, or service account IDs (svac_...) when a service account was added + - `folder_id: optional string or null` - `organization_id: optional string or null` @@ -43688,13 +43547,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_added"` + - `type: optional "claude_gdrive_integration_updated"` - default: group_member_added + default: claude_gdrive_integration_updated - - `GroupMemberAdditionFailed object` + - `GroupCreated object` - A request to add members to a group failed. Some of the requested members may have been added before the failure. + A group was created (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -43909,7 +43768,11 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group + Tagged ID of the created group + + - `group_name: string` + + Name of the created group - `id: optional string` @@ -43921,10 +43784,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members the request attempted to add - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -43933,13 +43792,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_addition_failed"` + - `type: optional "group_created"` - default: group_member_addition_failed + default: group_created - - `GroupMemberListViewed object` + - `GroupDeleted object` - Admin viewed the members of an RBAC group. + A group was deleted (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -44154,7 +44013,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group + Tagged ID of the deleted group - `id: optional string` @@ -44174,13 +44033,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_list_viewed"` + - `type: optional "group_deleted"` - default: group_member_list_viewed + default: group_deleted - - `GroupMemberRemovalFailed object` + - `GroupListViewed object` - A request to remove members from a group failed. Some of the requested members may have been removed before the failure. + Admin viewed the list of RBAC groups. - `actor: object or object or object or 8 more` @@ -44393,10 +44252,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `group_id: string` - - Tagged ID of the group - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -44407,10 +44262,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `member_ids: optional array of string` - - Tagged IDs of the members the request attempted to remove. These are always recorded as user IDs, since whether a member was a service account is only established once its removal succeeds - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -44419,13 +44270,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_removal_failed"` + - `type: optional "group_list_viewed"` - default: group_member_removal_failed + default: group_list_viewed - - `GroupMemberRemoved object` + - `GroupMemberAdded object` - One or more members were removed from a group. + One or more members were added to a group. - `actor: object or object or object or 8 more` @@ -44654,7 +44505,7 @@ compliance activities that can be filtered by various criteria. - `member_ids: optional array of string` - Tagged IDs of the members removed: user IDs, or service account IDs (svac_...) when a service account was removed. A requested member that was not in the group is listed as a user ID + Tagged IDs of the members added: user IDs, or service account IDs (svac_...) when a service account was added - `organization_id: optional string or null` @@ -44664,13 +44515,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_member_removed"` + - `type: optional "group_member_added"` - default: group_member_removed + default: group_member_added - - `GroupProjectSharesRevoked object` + - `GroupMemberAdditionFailed object` - An RBAC group's project shares in one organization were revoked in bulk. + A request to add members to a group failed. Some of the requested members may have been added before the failure. - `actor: object or object or object or 8 more` @@ -44885,26 +44736,22 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose project shares were revoked. - - - `revoked_count: number` - - Number of distinct projects whose share with this group was revoked. + Tagged ID of the group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `claude_project_ids: optional array of string` - - Tagged IDs of the projects whose share with this group was revoked. - - `created_at: optional string` When this activity occurred. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members the request attempted to add + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -44913,13 +44760,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_project_shares_revoked"` + - `type: optional "group_member_addition_failed"` - default: group_project_shares_revoked + default: group_member_addition_failed - - `GroupSkillSharesRevoked object` + - `GroupMemberListViewed object` - An RBAC group's skill shares in one organization were revoked in bulk. + Admin viewed the members of an RBAC group. - `actor: object or object or object or 8 more` @@ -45134,11 +44981,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose skill shares were revoked. - - - `revoked_count: number` - - Number of distinct skills and plugins whose share with this group was revoked: the combined size of `skill_ids` and `plugin_ids`. + Tagged ID of the group - `id: optional string` @@ -45158,21 +45001,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `plugin_ids: optional array of string` - - Tagged IDs of the plugins whose share with this group was revoked. - - - `skill_ids: optional array of string` - - Tagged IDs of the skills whose share with this group was revoked. - - - `type: optional "group_skill_shares_revoked"` + - `type: optional "group_member_list_viewed"` - default: group_skill_shares_revoked + default: group_member_list_viewed - - `GroupUpdated object` + - `GroupMemberRemovalFailed object` - A group was updated (RBAC admin or SCIM provisioning). + A request to remove members from a group failed. Some of the requested members may have been removed before the failure. - `actor: object or object or object or 8 more` @@ -45387,7 +45222,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the updated group + Tagged ID of the group - `id: optional string` @@ -45399,6 +45234,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members the request attempted to remove. These are always recorded as user IDs, since whether a member was a service account is only established once its removal succeeds + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -45407,13 +45246,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_updated"` + - `type: optional "group_member_removal_failed"` - default: group_updated + default: group_member_removal_failed - - `GroupViewed object` + - `GroupMemberRemoved object` - A group was viewed. + One or more members were removed from a group. - `actor: object or object or object or 8 more` @@ -45628,7 +45467,7 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the viewed group + Tagged ID of the group - `id: optional string` @@ -45640,6 +45479,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `member_ids: optional array of string` + + Tagged IDs of the members removed: user IDs, or service account IDs (svac_...) when a service account was removed. A requested member that was not in the group is listed as a user ID + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -45648,13 +45491,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "group_viewed"` + - `type: optional "group_member_removed"` - default: group_viewed + default: group_member_removed - - `GroupVisibilityUpdated object` + - `GroupProjectSharesRevoked object` - An RBAC group's visibility policy was updated. + An RBAC group's project shares in one organization were revoked in bulk. - `actor: object or object or object or 8 more` @@ -45869,12 +45712,20 @@ compliance activities that can be filtered by various criteria. - `group_id: string` - Tagged ID of the group whose visibility policy was updated. + Tagged ID of the group whose project shares were revoked. + + - `revoked_count: number` + + Number of distinct projects whose share with this group was revoked. - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `claude_project_ids: optional array of string` + + Tagged IDs of the projects whose share with this group was revoked. + - `created_at: optional string` When this activity occurred. @@ -45889,69 +45740,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `policies: optional array of object` - - The group's visibility policy after this update. - - - `audience: "everyone" or "members" or "none" or "unspecified"` - - The audience granted this visibility facet. - - - `"everyone"` - - - `"members"` - - - `"none"` - - - `"unspecified"` - - - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` - - The visibility facet this entry grants. - - - `"discover"` - - - `"share_with"` - - - `"unspecified"` - - - `"view_members"` - - - `previous_policies: optional array of object` - - The group's visibility policy before this update. - - - `audience: "everyone" or "members" or "none" or "unspecified"` - - The audience granted this visibility facet. - - - `"everyone"` - - - `"members"` - - - `"none"` - - - `"unspecified"` - - - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` - - The visibility facet this entry grants. - - - `"discover"` - - - `"share_with"` - - - `"unspecified"` - - - `"view_members"` - - - `type: optional "group_visibility_updated"` + - `type: optional "group_project_shares_revoked"` - default: group_visibility_updated + default: group_project_shares_revoked - - `InferenceHooksCircuitBreakerTripped object` + - `GroupSkillSharesRevoked object` - The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. The tripped state persists until an administrator re-enables Inference hooks inspection (or explicitly resets the circuit breaker). + An RBAC group's skill shares in one organization were revoked in bulk. - `actor: object or object or object or 8 more` @@ -46164,13 +45959,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `fail_mode: string` + - `group_id: string` - The failure handling in effect when the breaker tripped: "fail_open" (requests proceed uninspected) or "fail_closed" (requests are rejected). + Tagged ID of the group whose skill shares were revoked. - - `trigger_reason: string` + - `revoked_count: number` - The kind of failure that crossed the threshold. Currently always "webhook_error": repeated failures of calls to the organization's Inference hooks endpoint. + Number of distinct skills and plugins whose share with this group was revoked: the combined size of `skill_ids` and `plugin_ids`. - `id: optional string` @@ -46190,17 +45985,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `surface: optional string or null` + - `plugin_ids: optional array of string` - The product surface of the request whose failure tripped the breaker, e.g. "claude-ai" or "claude-code". + Tagged IDs of the plugins whose share with this group was revoked. - - `type: optional "inference_hooks_circuit_breaker_tripped"` + - `skill_ids: optional array of string` - default: inference_hooks_circuit_breaker_tripped + Tagged IDs of the skills whose share with this group was revoked. - - `InferenceHooksRequestDenied object` + - `type: optional "group_skill_shares_revoked"` - Inference hooks inspection denied a request. The request was blocked and no model response was produced. + default: group_skill_shares_revoked + + - `GroupUpdated object` + + A group was updated (RBAC admin or SCIM provisioning). - `actor: object or object or object or 8 more` @@ -46413,13 +46212,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `group_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + Tagged ID of the updated group - - `conversation_id: optional string or null` + - `id: optional string` - The conversation the denied request belonged to, when available. The identifier format depends on `surface`. + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -46435,25 +46234,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reference_id: optional string or null` - - The Inference hooks endpoint's own identifier for this scan, when it returned one — lets this denial be matched to the corresponding record in the inspection provider's console. - - - `request_id: optional string or null` - - Anthropic's identifier for the denied request — the same value sent to the Inference hooks endpoint as `request_id`. - - - `surface: optional string or null` - - The product surface the request came from, e.g. "claude-ai" or "claude-code". - - - `type: optional "inference_hooks_request_denied"` + - `type: optional "group_updated"` - default: inference_hooks_request_denied + default: group_updated - - `InferenceHooksRequestFailedOpen object` + - `GroupViewed object` - A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open. + A group was viewed. - `actor: object or object or object or 8 more` @@ -46666,26 +46453,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `reason: "endpoint_error" or "endpoint_timeout" or "internal_error" or "unspecified"` - - Why Inference hooks inspection did not return a verdict. - - - `"endpoint_error"` - - - `"endpoint_timeout"` - - - `"internal_error"` + - `group_id: string` - - `"unspecified"` + Tagged ID of the viewed group - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `conversation_id: optional string or null` - - The conversation the request belonged to, when available. The identifier format depends on `surface`. - - `created_at: optional string` When this activity occurred. @@ -46700,17 +46475,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `surface: optional string or null` - - The product surface the request came from, e.g. "claude-ai" or "claude-code". - - - `type: optional "inference_hooks_request_failed_open"` + - `type: optional "group_viewed"` - default: inference_hooks_request_failed_open + default: group_viewed - - `IntegrationUserConnected object` + - `GroupVisibilityUpdated object` - User connected to an integration. + An RBAC group's visibility policy was updated. - `actor: object or object or object or 8 more` @@ -46923,6 +46694,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `group_id: string` + + Tagged ID of the group whose visibility policy was updated. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -46933,31 +46708,77 @@ compliance activities that can be filtered by various criteria. format: date-time - - `integration_type: optional string or null` + - `organization_id: optional string or null` - - `mcp_server_id: optional string or null` + Organization ID this activity is associated with - ID of the connected remote MCP server, when the integration is a remote MCP server. + - `organization_uuid: optional string or null` - - `mcp_server_name: optional string or null` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - Display name of the connected remote MCP server, when the integration is a remote MCP server. + - `policies: optional array of object` - - `organization_id: optional string or null` + The group's visibility policy after this update. - Organization ID this activity is associated with + - `audience: "everyone" or "members" or "none" or "unspecified"` - - `organization_uuid: optional string or null` + The audience granted this visibility facet. - Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + - `"everyone"` - - `type: optional "integration_user_connected"` + - `"members"` - default: integration_user_connected + - `"none"` - - `IntegrationUserDisconnected object` + - `"unspecified"` - User disconnected from an integration. + - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` + + The visibility facet this entry grants. + + - `"discover"` + + - `"share_with"` + + - `"unspecified"` + + - `"view_members"` + + - `previous_policies: optional array of object` + + The group's visibility policy before this update. + + - `audience: "everyone" or "members" or "none" or "unspecified"` + + The audience granted this visibility facet. + + - `"everyone"` + + - `"members"` + + - `"none"` + + - `"unspecified"` + + - `visibility_type: "discover" or "share_with" or "unspecified" or "view_members"` + + The visibility facet this entry grants. + + - `"discover"` + + - `"share_with"` + + - `"unspecified"` + + - `"view_members"` + + - `type: optional "group_visibility_updated"` + + default: group_visibility_updated + + - `InferenceHooksCircuitBreakerTripped object` + + The organization's Inference hooks circuit breaker tripped automatically: calls to the organization's Inference hooks endpoint crossed a failure threshold, and inspection was suspended to protect live traffic. While tripped, requests are handled according to the organization's failure handling setting — allowed through uninspected (fail open) or rejected (fail closed) — and no per-request Inference hooks activities are recorded. The tripped state persists until an administrator re-enables Inference hooks inspection (or explicitly resets the circuit breaker). - `actor: object or object or object or 8 more` @@ -47170,6 +46991,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `fail_mode: string` + + The failure handling in effect when the breaker tripped: "fail_open" (requests proceed uninspected) or "fail_closed" (requests are rejected). + + - `trigger_reason: string` + + The kind of failure that crossed the threshold. Currently always "webhook_error": repeated failures of calls to the organization's Inference hooks endpoint. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -47180,16 +47009,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `integration_type: optional string or null` - - - `mcp_server_id: optional string or null` - - ID of the disconnected remote MCP server, when the integration is a remote MCP server. - - - `mcp_server_name: optional string or null` - - Display name of the disconnected remote MCP server, when the integration is a remote MCP server. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47198,13 +47017,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "integration_user_disconnected"` + - `surface: optional string or null` - default: integration_user_disconnected + The product surface of the request whose failure tripped the breaker, e.g. "claude-ai" or "claude-code". - - `InvoiceCollectionMethodUpdated object` + - `type: optional "inference_hooks_circuit_breaker_tripped"` - Invoice collection method was changed. + default: inference_hooks_circuit_breaker_tripped + + - `InferenceHooksRequestDenied object` + + Inference hooks inspection denied a request. The request was blocked and no model response was produced. - `actor: object or object or object or 8 more` @@ -47421,16 +47244,16 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `conversation_id: optional string or null` + + The conversation the denied request belonged to, when available. The identifier format depends on `surface`. + - `created_at: optional string` When this activity occurred. format: date-time - - `new_collection_method: optional string or null` - - New collection method (e.g. charge_automatically, send_invoice). - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47439,13 +47262,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "invoice_collection_method_updated"` + - `reference_id: optional string or null` - default: invoice_collection_method_updated + The Inference hooks endpoint's own identifier for this scan, when it returned one — lets this denial be matched to the corresponding record in the inspection provider's console. - - `UserLoggedOut object` + - `request_id: optional string or null` - A user signed out of one or all sessions. + Anthropic's identifier for the denied request — the same value sent to the Inference hooks endpoint as `request_id`. + + - `surface: optional string or null` + + The product surface the request came from, e.g. "claude-ai" or "claude-code". + + - `type: optional "inference_hooks_request_denied"` + + default: inference_hooks_request_denied + + - `InferenceHooksRequestFailedOpen object` + + A request proceeded without Inference hooks inspection because a verdict could not be obtained and the organization's Inference hooks configuration is set to fail open. - `actor: object or object or object or 8 more` @@ -47658,10 +47493,26 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `reason: "endpoint_error" or "endpoint_timeout" or "internal_error" or "unspecified"` + + Why Inference hooks inspection did not return a verdict. + + - `"endpoint_error"` + + - `"endpoint_timeout"` + + - `"internal_error"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `conversation_id: optional string or null` + + The conversation the request belonged to, when available. The identifier format depends on `surface`. + - `created_at: optional string` When this activity occurred. @@ -47676,13 +47527,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "user_logged_out"` + - `surface: optional string or null` - default: user_logged_out + The product surface the request came from, e.g. "claude-ai" or "claude-code". - - `LtiLaunchInitiated object` + - `type: optional "inference_hooks_request_failed_open"` - LTI launch was initiated. + default: inference_hooks_request_failed_open + + - `IntegrationUserConnected object` + + User connected to an integration. - `actor: object or object or object or 8 more` @@ -47905,6 +47760,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `integration_type: optional string or null` + + - `mcp_server_id: optional string or null` + + ID of the connected remote MCP server, when the integration is a remote MCP server. + + - `mcp_server_name: optional string or null` + + Display name of the connected remote MCP server, when the integration is a remote MCP server. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -47913,13 +47778,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_launch_initiated"` + - `token_vault_connect_mode: optional string or null` - default: lti_launch_initiated + How a token vault credential sign-in was completed: "authorization_server" for a sign-in at an administrator-provided authorization server, or "mcp_server" for a sign-in at a tool server the organization has not registered as a connector. - - `LtiLaunchSuccess object` + - `type: optional "integration_user_connected"` - LTI launch completed successfully. + default: integration_user_connected + + - `IntegrationUserDisconnected object` + + User disconnected from an integration. - `actor: object or object or object or 8 more` @@ -48142,6 +48011,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `integration_type: optional string or null` + + - `mcp_server_id: optional string or null` + + ID of the disconnected remote MCP server, when the integration is a remote MCP server. + + - `mcp_server_name: optional string or null` + + Display name of the disconnected remote MCP server, when the integration is a remote MCP server. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48150,13 +48029,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_launch_success"` + - `type: optional "integration_user_disconnected"` - default: lti_launch_success + default: integration_user_disconnected - - `LtiPlatformCreated object` + - `InvoiceCollectionMethodUpdated object` - Anthropic staff created an LTI platform integration on behalf of an org. + Invoice collection method was changed. - `actor: object or object or object or 8 more` @@ -48369,14 +48248,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `lti_platform_id: string` - - UUID of the LTI platform - - - `lti_platform_issuer: string` - - Platform issuer URL - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -48387,6 +48258,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `new_collection_method: optional string or null` + + New collection method (e.g. charge_automatically, send_invoice). + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48395,13 +48270,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_platform_created"` + - `type: optional "invoice_collection_method_updated"` - default: lti_platform_created + default: invoice_collection_method_updated - - `LtiPlatformUpdated object` + - `UserLoggedOut object` - Anthropic staff updated an LTI platform integration on behalf of an org. + A user signed out of one or all sessions. - `actor: object or object or object or 8 more` @@ -48614,10 +48489,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `lti_platform_id: string` - - UUID of the LTI platform - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -48628,10 +48499,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `lti_platform_issuer: optional string or null` - - Platform issuer URL - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -48640,13 +48507,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "lti_platform_updated"` + - `type: optional "user_logged_out"` - default: lti_platform_updated + default: user_logged_out - - `MagicLinkLoginFailed object` + - `LtiLaunchInitiated object` - A magic link sign-in attempt failed. + LTI launch was initiated. - `actor: object or object or object or 8 more` @@ -48877,13 +48744,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_failed"` + - `type: optional "lti_launch_initiated"` - default: magic_link_login_failed + default: lti_launch_initiated - - `MagicLinkLoginInitiated object` + - `LtiLaunchSuccess object` - A user requested a magic link sign-in email. + LTI launch completed successfully. - `actor: object or object or object or 8 more` @@ -49114,13 +48981,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_initiated"` + - `type: optional "lti_launch_success"` - default: magic_link_login_initiated + default: lti_launch_success - - `MagicLinkLoginSucceeded object` + - `LtiPlatformCreated object` - A user successfully signed in with a magic link email. + Anthropic staff created an LTI platform integration on behalf of an org. - `actor: object or object or object or 8 more` @@ -49333,15 +49200,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `lti_platform_id: string` - Unique identifier for the activity e.g. 'activity_abcd1234' + UUID of the LTI platform - - `auth_method: optional "magic_link"` + - `lti_platform_issuer: string` - The method the user used to authenticate. May be absent on activities recorded before this field was introduced. + Platform issuer URL + + - `id: optional string` - default: magic_link + Unique identifier for the activity e.g. 'activity_abcd1234' - `created_at: optional string` @@ -49349,10 +49218,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `mfa_method: optional "not_used" or null` - - The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -49361,13 +49226,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "magic_link_login_succeeded"` + - `type: optional "lti_platform_created"` - default: magic_link_login_succeeded + default: lti_platform_created - - `ManagedOrganizationSetupCompleted object` + - `LtiPlatformUpdated object` - Managed (AWS Marketplace) organization setup was completed. + Anthropic staff updated an LTI platform integration on behalf of an org. - `actor: object or object or object or 8 more` @@ -49580,6 +49445,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `lti_platform_id: string` + + UUID of the LTI platform + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -49590,6 +49459,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `lti_platform_issuer: optional string or null` + + Platform issuer URL + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -49598,13 +49471,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "managed_organization_setup_completed"` + - `type: optional "lti_platform_updated"` - default: managed_organization_setup_completed + default: lti_platform_updated - - `MarketplaceCreated object` + - `MagicLinkLoginFailed object` - Admin created an organization marketplace. + A magic link sign-in attempt failed. - `actor: object or object or object or 8 more` @@ -49817,10 +49690,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -49839,13 +49708,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_created"` + - `type: optional "magic_link_login_failed"` - default: marketplace_created + default: magic_link_login_failed - - `MarketplaceDeleted object` + - `MagicLinkLoginInitiated object` - Admin deleted an organization marketplace. + A user requested a magic link sign-in email. - `actor: object or object or object or 8 more` @@ -50058,10 +49927,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -50080,13 +49945,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_deleted"` + - `type: optional "magic_link_login_initiated"` - default: marketplace_deleted + default: magic_link_login_initiated - - `MarketplaceUpdated object` + - `MagicLinkLoginSucceeded object` - Admin updated an organization marketplace. + A user successfully signed in with a magic link email. - `actor: object or object or object or 8 more` @@ -50299,20 +50164,32 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `marketplace_id: string` - - Tagged ID of the marketplace - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `auth_method: optional "magic_link" or "unspecified" or null` + + The method the user used to authenticate. May be absent on activities recorded before this field was introduced. + + - `"magic_link"` + + - `"unspecified"` + - `created_at: optional string` When this activity occurred. format: date-time + - `mfa_method: optional "not_used" or "unspecified" or null` + + The second authentication factor performed during this login, if any. `null` when the second-factor status is not recorded on this event — for example, when authentication was delegated to an external identity provider and any second factor is not visible to Anthropic, or when this event is one step of a multistep login whose MFA is reported on another activity. May be absent on activities recorded before this field was introduced. + + - `"not_used"` + + - `"unspecified"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -50321,13 +50198,250 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_updated"` + - `type: optional "magic_link_login_succeeded"` - default: marketplace_updated + default: magic_link_login_succeeded - - `MarketplaceWebhookDeleted object` + - `ManagedOrganizationSetupCompleted object` - Admin removed the GitHub push webhook for a marketplace. + Managed (AWS Marketplace) organization setup was completed. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "managed_organization_setup_completed"` + + default: managed_organization_setup_completed + + - `MarketplaceCreated object` + + Admin created an organization marketplace. - `actor: object or object or object or 8 more` @@ -50562,13 +50676,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_webhook_deleted"` + - `type: optional "marketplace_created"` - default: marketplace_webhook_deleted + default: marketplace_created - - `MarketplaceWebhookProvisioned object` + - `MarketplaceDeleted object` - Admin provisioned a GitHub push webhook for a marketplace. + Admin deleted an organization marketplace. - `actor: object or object or object or 8 more` @@ -50795,10 +50909,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `github_webhook_id: optional number or null` - - GitHub-assigned webhook ID returned by the hooks API - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -50807,13 +50917,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "marketplace_webhook_provisioned"` + - `type: optional "marketplace_deleted"` - default: marketplace_webhook_provisioned + default: marketplace_deleted - - `McpDirectoryServerPublished object` + - `MarketplaceUpdated object` - The organization published its approved MCP directory listing. + Admin updated an organization marketplace. - `actor: object or object or object or 8 more` @@ -51026,13 +51136,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_directory_server_id: string` - - Tagged ID of the MCP directory listing - - - `mcp_directory_server_name: string` + - `marketplace_id: string` - Display name of the MCP directory listing + Tagged ID of the marketplace - `id: optional string` @@ -51052,13 +51158,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_directory_server_published"` + - `type: optional "marketplace_updated"` - default: mcp_directory_server_published + default: marketplace_updated - - `McpServerCreated object` + - `MarketplaceWebhookDeleted object` - An MCP server was added to the organization. + Admin removed the GitHub push webhook for a marketplace. - `actor: object or object or object or 8 more` @@ -51271,13 +51377,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_server_id: string` - - Tagged ID of the MCP server - - - `mcp_server_name: string` + - `marketplace_id: string` - Display name of the MCP server + Tagged ID of the marketplace - `id: optional string` @@ -51297,13 +51399,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_created"` + - `type: optional "marketplace_webhook_deleted"` - default: mcp_server_created + default: marketplace_webhook_deleted - - `McpServerDeleted object` + - `MarketplaceWebhookProvisioned object` - An MCP server was removed from the organization. + Admin provisioned a GitHub push webhook for a marketplace. - `actor: object or object or object or 8 more` @@ -51516,13 +51618,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `mcp_server_id: string` - - Tagged ID of the MCP server - - - `mcp_server_name: string` + - `marketplace_id: string` - Display name of the MCP server + Tagged ID of the marketplace - `id: optional string` @@ -51534,6 +51632,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `github_webhook_id: optional number or null` + + GitHub-assigned webhook ID returned by the hooks API + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -51542,13 +51644,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_deleted"` + - `type: optional "marketplace_webhook_provisioned"` - default: mcp_server_deleted + default: marketplace_webhook_provisioned - - `McpServerManagedAuthTokenExchanged object` + - `McpDirectoryServerPublished object` - A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests denied by organization policy before a token exchange is attempted are not reported, with the exception of the "connector_scope_not_granted" failures described under error_type. + The organization published its approved MCP directory listing. - `actor: object or object or object or 8 more` @@ -51761,48 +51863,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `managed_auth_mode: string` + - `mcp_directory_server_id: string` - The managed-authorization mode used for the exchange ("claude" or "sso"). + Tagged ID of the MCP directory listing - - `mcp_server_id: string` + - `mcp_directory_server_name: string` - The MCP server the exchange was attempted for, e.g. "mcpsrv_01Ab...". + Display name of the MCP directory listing - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' - - `assertion_jti: optional string or null` - - The JWT ID of the identity assertion presented to the authorization server, when one was minted, for cross-reference with the identity provider's own logs. - - - `authorization_server_issuer: optional string or null` - - The issuer identifier of the authorization server the exchange was attempted against. - - - `correlation_id: optional string or null` - - An opaque identifier customers can quote when contacting Anthropic support about this exchange. - - `created_at: optional string` When this activity occurred. format: date-time - - `error_subtype: optional string or null` - - A more specific classification of the failure, when available. For authorization-server rejections this is the OAuth error code the server returned (for example "invalid_grant"); for identity-provider rejections this is the error code the identity provider returned. Values may be added over time; treat an unrecognized value as a generic failure. - - - `error_type: optional string or null` - - A short classification of why the exchange failed, when outcome is "failure". Values include "authorization_server_rejected", "authorization_server_unavailable", "identity_provider_rejected", "sso_session_invalid", "sso_connection_unsupported", and "connector_scope_not_granted" (the organization's role configuration grants no scopes on this connector, so the request was denied before a token exchange was attempted). Values may be added over time; treat an unrecognized value as a generic failure. - - - `mcp_server_name: optional string or null` - - The MCP server's display name at the time of the exchange, when available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -51811,17 +51889,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `outcome: optional string or null` - - Whether the token exchange succeeded ("success") or was rejected ("failure"). - - - `type: optional "mcp_server_managed_auth_token_exchanged"` + - `type: optional "mcp_directory_server_published"` - default: mcp_server_managed_auth_token_exchanged + default: mcp_directory_server_published - - `McpServerManagedAuthUpdated object` + - `McpServerCreated object` - An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server). + An MCP server was added to the organization. - `actor: object or object or object or 8 more` @@ -52046,36 +52120,12 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `allowed_scopes: optional string or null` - - The OAuth scopes managed authorization may request for the server after the change, as a space-delimited list. Null when no scope restriction is configured (or the server has no managed authorization settings); an empty string when the restriction permits no scopes. - - - `built_in_roles_included: optional boolean or null` - - Whether, after the change, managed authorization extends to members who hold one of the organization's built-in roles (such as User, Admin, or Owner) rather than a custom role, in addition to members whose custom role grants it. This describes whom managed authorization reaches and is reported on every change, independent of how built-in role access is configured. - - `created_at: optional string` When this activity occurred. format: date-time - - `individual_auth_enabled: optional boolean or null` - - Whether members may authorize the server individually, through their own sign-in and consent, after the change. - - - `managed_auth_enabled: optional boolean or null` - - Whether managed authorization is enabled for the server after the change, so that members whose role permits it are authorized through the organization's identity provider. - - - `managed_auth_mode: optional string or null` - - The managed-authorization mode after the change ("claude" or "sso"): how the identity assertion presented on members' behalf is issued. Recorded whenever managed authorization settings exist, whether or not managed authorization is enabled; null when the server has no managed authorization settings after the change. - - - `mcp_server_url: optional string or null` - - Base URL (scheme, host, port, and path only) of the MCP server at the time of the change; null when not available. - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -52084,29 +52134,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_allowed_scopes: optional string or null` - - The OAuth scope restriction before the change, as a space-delimited list; null when no scope restriction was configured. - - - `previous_built_in_roles_included: optional boolean or null` - - Whether managed authorization extended to members holding one of the organization's built-in roles before the change. - - - `previous_individual_auth_enabled: optional boolean or null` - - Whether members could authorize the server individually before the change. - - - `previous_managed_auth_enabled: optional boolean or null` - - Whether managed authorization was enabled for the server before the change. - - - `type: optional "mcp_server_managed_auth_updated"` + - `type: optional "mcp_server_created"` - default: mcp_server_managed_auth_updated + default: mcp_server_created - - `McpServerUpdated object` + - `McpServerDeleted object` - An MCP server's configuration was updated. + An MCP server was removed from the organization. - `actor: object or object or object or 8 more` @@ -52345,13 +52379,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_server_updated"` + - `type: optional "mcp_server_deleted"` - default: mcp_server_updated + default: mcp_server_deleted - - `McpToolPolicyUpdated object` + - `McpServerManagedAuthTokenExchanged object` - The permission restriction for an MCP tool was set or cleared. + A user attempted to obtain an access token for an MCP server via enterprise managed authorization. This event reports the outcomes of attempted token exchanges. Repeated failures with the same cause may be reported once until the cause changes, and requests denied by organization policy before a token exchange is attempted are not reported, with the exception of the "connector_scope_not_granted" failures described under error_type. - `actor: object or object or object or 8 more` @@ -52564,21 +52598,29 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `managed_auth_mode: string` + + The managed-authorization mode used for the exchange ("claude" or "sso"). + - `mcp_server_id: string` - Tagged ID of the MCP server + The MCP server the exchange was attempted for, e.g. "mcpsrv_01Ab...". - - `mcp_server_name: string` + - `id: optional string` - Display name of the MCP server + Unique identifier for the activity e.g. 'activity_abcd1234' - - `tool_name: string` + - `assertion_jti: optional string or null` - Tool name (or '*' for the MCP-server-wide default) + The JWT ID of the identity assertion presented to the authorization server, when one was minted, for cross-reference with the identity provider's own logs. - - `id: optional string` + - `authorization_server_issuer: optional string or null` - Unique identifier for the activity e.g. 'activity_abcd1234' + The issuer identifier of the authorization server the exchange was attempted against. + + - `correlation_id: optional string or null` + + An opaque identifier customers can quote when contacting Anthropic support about this exchange. - `created_at: optional string` @@ -52586,9 +52628,17 @@ compliance activities that can be filtered by various criteria. format: date-time - - `max_permission: optional string or null` + - `error_subtype: optional string or null` - New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + A more specific classification of the failure, when available. For authorization-server rejections this is the OAuth error code the server returned (for example "invalid_grant"); for identity-provider rejections this is the error code the identity provider returned. Values may be added over time; treat an unrecognized value as a generic failure. + + - `error_type: optional string or null` + + A short classification of why the exchange failed, when outcome is "failure". Values include "authorization_server_rejected", "authorization_server_unavailable", "identity_provider_rejected", "sso_session_invalid", "sso_connection_unsupported", and "connector_scope_not_granted" (the organization's role configuration grants no scopes on this connector, so the request was denied before a token exchange was attempted). Values may be added over time; treat an unrecognized value as a generic failure. + + - `mcp_server_name: optional string or null` + + The MCP server's display name at the time of the exchange, when available. - `organization_id: optional string or null` @@ -52598,13 +52648,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "mcp_tool_policy_updated"` + - `outcome: optional string or null` - default: mcp_tool_policy_updated + Whether the token exchange succeeded ("success") or was rejected ("failure"). - - `OrgAnalyticsAPICapabilityUpdated object` + - `type: optional "mcp_server_managed_auth_token_exchanged"` - Organization analytics_api capability was enabled or disabled. + default: mcp_server_managed_auth_token_exchanged + + - `McpServerManagedAuthUpdated object` + + An MCP server's enterprise managed authorization settings were set, changed, or cleared, including when they were supplied while the server was being added or edited. Fields without a "previous_" prefix describe the settings after the change and are null when the server has no managed authorization settings afterwards; "previous_" fields describe the settings before the change and are null when the server had none before (always the case for a newly added server). - `actor: object or object or object or 8 more` @@ -52817,19 +52871,47 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `mcp_server_id: string` + + Tagged ID of the MCP server + + - `mcp_server_name: string` + + Display name of the MCP server + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `allowed_scopes: optional string or null` + + The OAuth scopes managed authorization may request for the server after the change, as a space-delimited list. Null when no scope restriction is configured (or the server has no managed authorization settings); an empty string when the restriction permits no scopes. + + - `built_in_roles_included: optional boolean or null` + + Whether, after the change, managed authorization extends to members who hold one of the organization's built-in roles (such as User, Admin, or Owner) rather than a custom role, in addition to members whose custom role grants it. This describes whom managed authorization reaches and is reported on every change, independent of how built-in role access is configured. + - `created_at: optional string` When this activity occurred. format: date-time - - `current_value: optional boolean or null` + - `individual_auth_enabled: optional boolean or null` - Whether the analytics API capability is enabled immediately after this change + Whether members may authorize the server individually, through their own sign-in and consent, after the change. + + - `managed_auth_enabled: optional boolean or null` + + Whether managed authorization is enabled for the server after the change, so that members whose role permits it are authorized through the organization's identity provider. + + - `managed_auth_mode: optional string or null` + + The managed-authorization mode after the change ("claude" or "sso"): how the identity assertion presented on members' behalf is issued. Recorded whenever managed authorization settings exist, whether or not managed authorization is enabled; null when the server has no managed authorization settings after the change. + + - `mcp_server_url: optional string or null` + + Base URL (scheme, host, port, and path only) of the MCP server at the time of the change; null when not available. - `organization_id: optional string or null` @@ -52839,17 +52921,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` + - `previous_allowed_scopes: optional string or null` - Whether the analytics API capability was enabled immediately before this change + The OAuth scope restriction before the change, as a space-delimited list; null when no scope restriction was configured. - - `type: optional "org_analytics_api_capability_updated"` + - `previous_built_in_roles_included: optional boolean or null` - default: org_analytics_api_capability_updated + Whether managed authorization extended to members holding one of the organization's built-in roles before the change. - - `OrgBulkDeleteInitiated object` + - `previous_individual_auth_enabled: optional boolean or null` - Organization bulk deletion was initiated. + Whether members could authorize the server individually before the change. + + - `previous_managed_auth_enabled: optional boolean or null` + + Whether managed authorization was enabled for the server before the change. + + - `type: optional "mcp_server_managed_auth_updated"` + + default: mcp_server_managed_auth_updated + + - `McpServerUpdated object` + + An MCP server's configuration was updated. - `actor: object or object or object or 8 more` @@ -53062,6 +53156,14 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `mcp_server_id: string` + + Tagged ID of the MCP server + + - `mcp_server_name: string` + + Display name of the MCP server + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -53080,13 +53182,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_bulk_delete_initiated"` + - `type: optional "mcp_server_updated"` - default: org_bulk_delete_initiated + default: mcp_server_updated - - `OrgCapabilityGrantAdded object` + - `McpToolPolicyUpdated object` - A capability grant was added to a workspace or role. + The permission restriction for an MCP tool was set or cleared. - `actor: object or object or object or 8 more` @@ -53299,23 +53401,17 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `grant_type: string` - - The type of capability grant that was added. - - - `principal_id: string` - - Tagged ID of the principal the grant was added to. + - `mcp_server_id: string` - - `principal_type: "rbac_role" or "unspecified" or "workspace"` + Tagged ID of the MCP server - The kind of principal the grant was added to. + - `mcp_server_name: string` - - `"rbac_role"` + Display name of the MCP server - - `"unspecified"` + - `tool_name: string` - - `"workspace"` + Tool name (or '*' for the MCP-server-wide default) - `id: optional string` @@ -53327,6 +53423,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `max_permission: optional string or null` + + New max_permission value ('allow' | 'ask' | 'blocked'), or null when cleared + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53335,13 +53435,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_capability_grant_added"` + - `type: optional "mcp_tool_policy_updated"` - default: org_capability_grant_added + default: mcp_tool_policy_updated - - `OrgCapabilityGrantRemoved object` + - `OrgAnalyticsAPICapabilityUpdated object` - A capability grant was removed from a workspace or role. + Organization analytics_api capability was enabled or disabled. - `actor: object or object or object or 8 more` @@ -53554,24 +53654,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `grant_type: string` - - The type of capability grant that was removed. - - - `principal_id: string` - - Tagged ID of the principal the grant was removed from. - - - `principal_type: "rbac_role" or "unspecified" or "workspace"` - - The kind of principal the grant was removed from. - - - `"rbac_role"` - - - `"unspecified"` - - - `"workspace"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -53582,6 +53664,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Whether the analytics API capability is enabled immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53590,13 +53676,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_capability_grant_removed"` + - `previous_value: optional boolean or null` - default: org_capability_grant_removed + Whether the analytics API capability was enabled immediately before this change - - `OrgClaudeCodeDataSharingDisabled object` + - `type: optional "org_analytics_api_capability_updated"` - Organization Claude Code data sharing was disabled. + default: org_analytics_api_capability_updated + + - `OrgBulkDeleteInitiated object` + + Organization bulk deletion was initiated. - `actor: object or object or object or 8 more` @@ -53819,10 +53909,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -53831,17 +53917,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_data_sharing_disabled"` + - `type: optional "org_bulk_delete_initiated"` - default: org_claude_code_data_sharing_disabled + default: org_bulk_delete_initiated - - `OrgClaudeCodeDataSharingEnabled object` + - `OrgCapabilityGrantAdded object` - Organization Claude Code data sharing was enabled. + A capability grant was added to a workspace or role. - `actor: object or object or object or 8 more` @@ -54054,6 +54136,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `grant_type: string` + + The type of capability grant that was added. + + - `principal_id: string` + + Tagged ID of the principal the grant was added to. + + - `principal_type: "rbac_role" or "unspecified" or "workspace"` + + The kind of principal the grant was added to. + + - `"rbac_role"` + + - `"unspecified"` + + - `"workspace"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -54064,10 +54164,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54076,17 +54172,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_data_sharing_enabled"` + - `type: optional "org_capability_grant_added"` - default: org_claude_code_data_sharing_enabled + default: org_capability_grant_added - - `OrgClaudeCodeDesktopDisabled object` + - `OrgCapabilityGrantRemoved object` - Organization Claude Code Desktop was disabled. + A capability grant was removed from a workspace or role. - `actor: object or object or object or 8 more` @@ -54299,6 +54391,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `grant_type: string` + + The type of capability grant that was removed. + + - `principal_id: string` + + Tagged ID of the principal the grant was removed from. + + - `principal_type: "rbac_role" or "unspecified" or "workspace"` + + The kind of principal the grant was removed from. + + - `"rbac_role"` + + - `"unspecified"` + + - `"workspace"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -54309,10 +54419,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54321,17 +54427,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_claude_code_desktop_disabled"` + - `type: optional "org_capability_grant_removed"` - default: org_claude_code_desktop_disabled + default: org_capability_grant_removed - - `OrgClaudeCodeDesktopEnabled object` + - `OrgClaudeCodeDataSharingDisabled object` - Organization Claude Code Desktop was enabled. + Organization Claude Code data sharing was disabled. - `actor: object or object or object or 8 more` @@ -54570,15 +54672,13 @@ compliance activities that can be filtered by various criteria. Setting value immediately before this change - - `type: optional "org_claude_code_desktop_enabled"` + - `type: optional "org_claude_code_data_sharing_disabled"` - default: org_claude_code_desktop_enabled + default: org_claude_code_data_sharing_disabled - - `OrgClaudeCodeZeroDataRetentionDisabled object` + - `OrgClaudeCodeDataSharingEnabled object` - A primary owner disabled zero data retention for Claude Code, so Claude - Code content is retained according to the organization's data retention - settings. + Organization Claude Code data sharing was enabled. - `actor: object or object or object or 8 more` @@ -54801,6 +54901,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -54809,13 +54913,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_claude_code_zero_data_retention_disabled"` + - `previous_value: optional boolean or null` - default: org_claude_code_zero_data_retention_disabled + Setting value immediately before this change - - `OrgComplianceAPISettingsUpdated object` + - `type: optional "org_claude_code_data_sharing_enabled"` - Organization compliance API settings were updated. + default: org_claude_code_data_sharing_enabled + + - `OrgClaudeCodeDesktopDisabled object` + + Organization Claude Code Desktop was disabled. - `actor: object or object or object or 8 more` @@ -55032,20 +55140,16 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `compliance_api_enabled: optional boolean or null` - - Whether the compliance API is enabled for the organization after this change. - - - `compliance_api_logging_enabled: optional boolean or null` - - Whether compliance activity logging is enabled for the organization after this change. - - `created_at: optional string` When this activity occurred. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -55054,13 +55158,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_compliance_api_settings_updated"` + - `previous_value: optional boolean or null` - default: org_compliance_api_settings_updated + Setting value immediately before this change - - `OrgConnectorDomainGuardUpdated object` + - `type: optional "org_claude_code_desktop_disabled"` - Enterprise admin changed whether connectors are restricted to verified domains. + default: org_claude_code_desktop_disabled + + - `OrgClaudeCodeDesktopEnabled object` + + Organization Claude Code Desktop was enabled. - `actor: object or object or object or 8 more` @@ -55273,8 +55381,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enforced: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -55285,6 +55391,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -55293,13 +55403,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_connector_domain_guard_updated"` + - `previous_value: optional boolean or null` - default: org_connector_domain_guard_updated + Setting value immediately before this change - - `OrgCoworkActWithoutAskingModeDisabled object` + - `type: optional "org_claude_code_desktop_enabled"` - The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval. + default: org_claude_code_desktop_enabled + + - `OrgClaudeCodeZeroDataRetentionDisabled object` + + A primary owner disabled zero data retention for Claude Code, so Claude + Code content is retained according to the organization's data retention + settings. - `actor: object or object or object or 8 more` @@ -55530,13 +55646,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_act_without_asking_mode_disabled"` + - `type: optional "org_claude_code_zero_data_retention_disabled"` - default: org_cowork_act_without_asking_mode_disabled + default: org_claude_code_zero_data_retention_disabled - - `OrgCoworkActWithoutAskingModeEnabled object` + - `OrgComplianceAPISettingsUpdated object` - The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval. + Organization compliance API settings were updated. - `actor: object or object or object or 8 more` @@ -55753,6 +55869,14 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `compliance_api_enabled: optional boolean or null` + + Whether the compliance API is enabled for the organization after this change. + + - `compliance_api_logging_enabled: optional boolean or null` + + Whether compliance activity logging is enabled for the organization after this change. + - `created_at: optional string` When this activity occurred. @@ -55767,13 +55891,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_act_without_asking_mode_enabled"` + - `type: optional "org_compliance_api_settings_updated"` - default: org_cowork_act_without_asking_mode_enabled + default: org_compliance_api_settings_updated - - `OrgCoworkAgentDisabled object` + - `OrgConnectorDomainGuardUpdated object` - Organization Cowork Agent was disabled. + Enterprise admin changed whether connectors are restricted to verified domains. - `actor: object or object or object or 8 more` @@ -55986,6 +56110,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enforced: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -55996,10 +56122,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56008,17 +56130,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_agent_disabled"` + - `type: optional "org_connector_domain_guard_updated"` - default: org_cowork_agent_disabled + default: org_connector_domain_guard_updated - - `OrgCoworkAgentEnabled object` + - `OrgCoworkActWithoutAskingModeDisabled object` - Organization Cowork Agent was enabled. + The "Act without asking" mode in Cowork was disabled for the organization, so members can no longer let Claude act without asking for approval. - `actor: object or object or object or 8 more` @@ -56241,10 +56359,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56253,17 +56367,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_agent_enabled"` + - `type: optional "org_cowork_act_without_asking_mode_disabled"` - default: org_cowork_agent_enabled + default: org_cowork_act_without_asking_mode_disabled - - `OrgCoworkAutoModeDisabled object` + - `OrgCoworkActWithoutAskingModeEnabled object` - The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check. + The "Act without asking" mode in Cowork was enabled for the organization, allowing members to let Claude act without asking for approval. - `actor: object or object or object or 8 more` @@ -56494,13 +56604,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_auto_mode_disabled"` + - `type: optional "org_cowork_act_without_asking_mode_enabled"` - default: org_cowork_auto_mode_disabled + default: org_cowork_act_without_asking_mode_enabled - - `OrgCoworkAutoModeEnabled object` + - `OrgCoworkAgentDisabled object` - The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check. + Organization Cowork Agent was disabled. - `actor: object or object or object or 8 more` @@ -56723,6 +56833,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -56731,13 +56845,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_auto_mode_enabled"` + - `previous_value: optional boolean or null` - default: org_cowork_auto_mode_enabled + Setting value immediately before this change - - `OrgCoworkDisabled object` + - `type: optional "org_cowork_agent_disabled"` - Organization cowork was disabled. + default: org_cowork_agent_disabled + + - `OrgCoworkAgentEnabled object` + + Organization Cowork Agent was enabled. - `actor: object or object or object or 8 more` @@ -56976,13 +57094,13 @@ compliance activities that can be filtered by various criteria. Setting value immediately before this change - - `type: optional "org_cowork_disabled"` + - `type: optional "org_cowork_agent_enabled"` - default: org_cowork_disabled + default: org_cowork_agent_enabled - - `OrgCoworkEnabled object` + - `OrgCoworkAutoModeDisabled object` - Organization cowork was enabled. + The "Auto" permission mode in Cowork was disabled for the organization, so members can no longer let Claude approve its own actions after a safety check. - `actor: object or object or object or 8 more` @@ -57205,10 +57323,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -57217,17 +57331,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_cowork_enabled"` + - `type: optional "org_cowork_auto_mode_disabled"` - default: org_cowork_enabled + default: org_cowork_auto_mode_disabled - - `OrgCoworkMcpAlwaysAllowDisabled object` + - `OrgCoworkAutoModeEnabled object` - The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting. + The "Auto" permission mode in Cowork was enabled for the organization, allowing members to let Claude approve its own actions after a safety check. - `actor: object or object or object or 8 more` @@ -57458,13 +57568,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_mcp_always_allow_disabled"` + - `type: optional "org_cowork_auto_mode_enabled"` - default: org_cowork_mcp_always_allow_disabled + default: org_cowork_auto_mode_enabled - - `OrgCoworkMcpAlwaysAllowEnabled object` + - `OrgCoworkDisabled object` - The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting. + Organization cowork was disabled. - `actor: object or object or object or 8 more` @@ -57687,6 +57797,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -57695,13 +57809,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_mcp_always_allow_enabled"` + - `previous_value: optional boolean or null` - default: org_cowork_mcp_always_allow_enabled + Setting value immediately before this change - - `OrgCoworkOtlpSettingsUpdated object` + - `type: optional "org_cowork_disabled"` - The organization's Cowork OpenTelemetry monitoring export settings were updated. + default: org_cowork_disabled + + - `OrgCoworkEnabled object` + + Organization cowork was enabled. - `actor: object or object or object or 8 more` @@ -57924,21 +58042,9 @@ compliance activities that can be filtered by various criteria. format: date-time - - `new_otlp_content_capture: optional array of string or null` - - The organization's content-capture settings after the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings are not set or were not modified by this update. - - - `new_otlp_endpoint: optional string or null` - - The OpenTelemetry export endpoint after the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint is unset or was not itself modified by this update. - - - `new_otlp_protocol: optional string or null` - - The OpenTelemetry export protocol after the change. Null if the protocol is unset or was not itself modified by this update. - - - `new_otlp_resource_attributes: optional string or null` + - `current_value: optional boolean or null` - The OpenTelemetry resource attributes after the change. Null if the attributes are unset or were not themselves modified by this update. + Setting value immediately after this change - `organization_id: optional string or null` @@ -57948,37 +58054,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `otlp_headers_change: optional "cleared" or "set" or null` - - Whether the OpenTelemetry export headers were set or cleared. 'set' is recorded for any non-empty submission, including resubmission of an unchanged value. Header values are never included. - - - `"cleared"` - - - `"set"` - - - `previous_otlp_content_capture: optional array of string or null` - - The organization's content-capture settings before the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings were not previously set or were not modified by this update. - - - `previous_otlp_endpoint: optional string or null` - - The OpenTelemetry export endpoint before the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint was previously unset or was not itself modified by this update. - - - `previous_otlp_protocol: optional string or null` - - The OpenTelemetry export protocol before the change. Null if the protocol was previously unset or was not itself modified by this update. - - - `previous_otlp_resource_attributes: optional string or null` + - `previous_value: optional boolean or null` - The OpenTelemetry resource attributes before the change. Null if the attributes were previously unset or were not themselves modified by this update. + Setting value immediately before this change - - `type: optional "org_cowork_otlp_settings_updated"` + - `type: optional "org_cowork_enabled"` - default: org_cowork_otlp_settings_updated + default: org_cowork_enabled - - `OrgCoworkRemoteDisabled object` + - `OrgCoworkMcpAlwaysAllowDisabled object` - Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments. + The "Always allow" option for connector tools in Cowork was disabled for the organization, so each use of a connector tool that can make changes requires approval. Read-only connector tools are not affected by this setting. - `actor: object or object or object or 8 more` @@ -58209,13 +58295,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_remote_disabled"` + - `type: optional "org_cowork_mcp_always_allow_disabled"` - default: org_cowork_remote_disabled + default: org_cowork_mcp_always_allow_disabled - - `OrgCoworkRemoteEnabled object` + - `OrgCoworkMcpAlwaysAllowEnabled object` - Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments. + The "Always allow" option for connector tools in Cowork was enabled for the organization, letting members approve a connector tool that can make changes once and allow its later uses automatically. Read-only connector tools are not affected by this setting. - `actor: object or object or object or 8 more` @@ -58446,13 +58532,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_cowork_remote_enabled"` + - `type: optional "org_cowork_mcp_always_allow_enabled"` - default: org_cowork_remote_enabled + default: org_cowork_mcp_always_allow_enabled - - `OrgCreationBlocked object` + - `OrgCoworkOtlpSettingsUpdated object` - Organization creation was blocked. + The organization's Cowork OpenTelemetry monitoring export settings were updated. - `actor: object or object or object or 8 more` @@ -58675,6 +58761,22 @@ compliance activities that can be filtered by various criteria. format: date-time + - `new_otlp_content_capture: optional array of string or null` + + The organization's content-capture settings after the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings are not set or were not modified by this update. + + - `new_otlp_endpoint: optional string or null` + + The OpenTelemetry export endpoint after the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint is unset or was not itself modified by this update. + + - `new_otlp_protocol: optional string or null` + + The OpenTelemetry export protocol after the change. Null if the protocol is unset or was not itself modified by this update. + + - `new_otlp_resource_attributes: optional string or null` + + The OpenTelemetry resource attributes after the change. Null if the attributes are unset or were not themselves modified by this update. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -58683,15 +58785,37 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `reason: optional string or null` + - `otlp_headers_change: optional "cleared" or "set" or null` - - `type: optional "org_creation_blocked"` + Whether the OpenTelemetry export headers were set or cleared. 'set' is recorded for any non-empty submission, including resubmission of an unchanged value. Header values are never included. - default: org_creation_blocked + - `"cleared"` - - `OrgDataExportAccessed object` + - `"set"` - Organization data export file was accessed/downloaded via signed URL. + - `previous_otlp_content_capture: optional array of string or null` + + The organization's content-capture settings before the change, as a sorted list of category names. An empty list means content capture is explicitly turned off. Null if the settings were not previously set or were not modified by this update. + + - `previous_otlp_endpoint: optional string or null` + + The OpenTelemetry export endpoint before the change. Credentials in the URL userinfo or query string are removed; path segments are retained. Null if the endpoint was previously unset or was not itself modified by this update. + + - `previous_otlp_protocol: optional string or null` + + The OpenTelemetry export protocol before the change. Null if the protocol was previously unset or was not itself modified by this update. + + - `previous_otlp_resource_attributes: optional string or null` + + The OpenTelemetry resource attributes before the change. Null if the attributes were previously unset or were not themselves modified by this update. + + - `type: optional "org_cowork_otlp_settings_updated"` + + default: org_cowork_otlp_settings_updated + + - `OrgCoworkRemoteDisabled object` + + Running Cowork in the cloud was disabled for the organization, so members can no longer run Cowork sessions in Anthropic-hosted remote environments. - `actor: object or object or object or 8 more` @@ -58914,14 +59038,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was downloaded. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -58930,13 +59046,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_export_accessed"` + - `type: optional "org_cowork_remote_disabled"` - default: org_data_export_accessed + default: org_cowork_remote_disabled - - `OrgDataExportCompleted object` + - `OrgCoworkRemoteEnabled object` - Organization data export was completed. + Running Cowork in the cloud was enabled for the organization, allowing members to run Cowork sessions in Anthropic-hosted remote environments. - `actor: object or object or object or 8 more` @@ -59159,14 +59275,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was exported. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59175,13 +59283,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_export_completed"` + - `type: optional "org_cowork_remote_enabled"` - default: org_data_export_completed + default: org_cowork_remote_enabled - - `OrgDataExportStarted object` + - `OrgCreationBlocked object` - Organization data export was started. + Organization creation was blocked. - `actor: object or object or object or 8 more` @@ -59404,14 +59512,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `export_type: optional "conversations" or "workbench" or null` - - Which data set was exported. Absent on records written before this field was introduced. - - - `"conversations"` - - - `"workbench"` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59420,21 +59520,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `scope: optional "member_own_data" or "organization" or null` - - Breadth of the export — the whole organization, or only the requesting member's own data. Absent on records written before this field was introduced. - - - `"member_own_data"` - - - `"organization"` + - `reason: optional string or null` - - `type: optional "org_data_export_started"` + - `type: optional "org_creation_blocked"` - default: org_data_export_started + default: org_creation_blocked - - `OrgDataResidencyUpdated object` + - `OrgDataExportAccessed object` - The organization's inference data residency settings were updated. + Organization data export file was accessed/downloaded via signed URL. - `actor: object or object or object or 8 more` @@ -59647,22 +59741,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `updates: array of object` - - - `current_value: string or null` - - Setting value immediately after this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. - - - `previous_value: string or null` - - Setting value immediately before this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. - - - `type: "allowed_inference_geos" or "default_inference_geo"` - - - `"allowed_inference_geos"` - - - `"default_inference_geo"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -59673,6 +59751,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was downloaded. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59681,13 +59767,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_data_residency_updated"` + - `type: optional "org_data_export_accessed"` - default: org_data_residency_updated + default: org_data_export_accessed - - `OrgDeletedViaBulk object` + - `OrgDataExportCompleted object` - Organization was deleted via bulk operation. + Organization data export was completed. - `actor: object or object or object or 8 more` @@ -59910,6 +59996,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was exported. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -59918,13 +60012,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_deleted_via_bulk"` + - `type: optional "org_data_export_completed"` - default: org_deleted_via_bulk + default: org_data_export_completed - - `OrgDeletionRequested object` + - `OrgDataExportStarted object` - Organization deletion was requested. + Organization data export was started. - `actor: object or object or object or 8 more` @@ -60147,6 +60241,14 @@ compliance activities that can be filtered by various criteria. format: date-time + - `export_type: optional "conversations" or "workbench" or null` + + Which data set was exported. Absent on records written before this field was introduced. + + - `"conversations"` + + - `"workbench"` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -60155,13 +60257,21 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_deletion_requested"` + - `scope: optional "member_own_data" or "organization" or null` - default: org_deletion_requested + Breadth of the export — the whole organization, or only the requesting member's own data. Absent on records written before this field was introduced. - - `OrgDirectoryResyncCompleted object` + - `"member_own_data"` - Organization directory resync completed successfully. + - `"organization"` + + - `type: optional "org_data_export_started"` + + default: org_data_export_started + + - `OrgDataResidencyUpdated object` + + The organization's inference data residency settings were updated. - `actor: object or object or object or 8 more` @@ -60374,7 +60484,21 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` + - `updates: array of object` + + - `current_value: string or null` + + Setting value immediately after this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. + + - `previous_value: string or null` + + Setting value immediately before this change. For allowed_inference_geos: a comma-separated list of geo codes (e.g. 'global,us'), or the literal 'unrestricted'. For default_inference_geo: a single geo code. + + - `type: "allowed_inference_geos" or "default_inference_geo"` + + - `"allowed_inference_geos"` + + - `"default_inference_geo"` - `id: optional string` @@ -60394,13 +60518,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_completed"` + - `type: optional "org_data_residency_updated"` - default: org_directory_resync_completed + default: org_data_residency_updated - - `OrgDirectoryResyncFailed object` + - `OrgDeletedViaBulk object` - Organization directory resync failed. + Organization was deleted via bulk operation. - `actor: object or object or object or 8 more` @@ -60613,8 +60737,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -60633,13 +60755,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_failed"` + - `type: optional "org_deleted_via_bulk"` - default: org_directory_resync_failed + default: org_deleted_via_bulk - - `OrgDirectoryResyncStarted object` + - `OrgDeletionRequested object` - Organization directory resync was started asynchronously. + Organization deletion was requested. - `actor: object or object or object or 8 more` @@ -60852,10 +60974,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resync_uuid: string` - - - `sync_destinations: array of string` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -60874,13 +60992,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_resync_started"` + - `type: optional "org_deletion_requested"` - default: org_directory_resync_started + default: org_deletion_requested - - `OrgDirectorySyncActivated object` + - `OrgDirectoryResyncCompleted object` - Organization directory sync was activated. + Organization directory resync completed successfully. - `actor: object or object or object or 8 more` @@ -61093,6 +61211,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61111,13 +61231,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_activated"` + - `type: optional "org_directory_resync_completed"` - default: org_directory_sync_activated + default: org_directory_resync_completed - - `OrgDirectorySyncAddInitiated object` + - `OrgDirectoryResyncFailed object` - Organization directory sync setup was initiated. + Organization directory resync failed. - `actor: object or object or object or 8 more` @@ -61330,6 +61450,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61348,13 +61470,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_add_initiated"` + - `type: optional "org_directory_resync_failed"` - default: org_directory_sync_add_initiated + default: org_directory_resync_failed - - `OrgDirectorySyncDeleted object` + - `OrgDirectoryResyncStarted object` - Organization directory sync was deleted. + Organization directory resync was started asynchronously. - `actor: object or object or object or 8 more` @@ -61567,6 +61689,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resync_uuid: string` + + - `sync_destinations: array of string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -61585,13 +61711,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_directory_sync_deleted"` + - `type: optional "org_directory_resync_started"` - default: org_directory_sync_deleted + default: org_directory_resync_started - - `OrgDiscoverabilityDisabled object` + - `OrgDirectorySyncActivated object` - Admin disabled organization discoverability. + Organization directory sync was activated. - `actor: object or object or object or 8 more` @@ -61822,13 +61948,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_disabled"` + - `type: optional "org_directory_sync_activated"` - default: org_discoverability_disabled + default: org_directory_sync_activated - - `OrgDiscoverabilityEnabled object` + - `OrgDirectorySyncAddInitiated object` - Admin enabled organization discoverability. + Organization directory sync setup was initiated. - `actor: object or object or object or 8 more` @@ -62059,13 +62185,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_enabled"` + - `type: optional "org_directory_sync_add_initiated"` - default: org_discoverability_enabled + default: org_directory_sync_add_initiated - - `OrgDiscoverabilitySettingsUpdated object` + - `OrgDirectorySyncDeleted object` - Admin updated organization discoverability settings. + Organization directory sync was deleted. - `actor: object or object or object or 8 more` @@ -62296,13 +62422,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_discoverability_settings_updated"` + - `type: optional "org_directory_sync_deleted"` - default: org_discoverability_settings_updated + default: org_directory_sync_deleted - - `OrgDomainAddInitiated object` + - `OrgDiscoverabilityDisabled object` - Organization domain verification was initiated. + Admin disabled organization discoverability. - `actor: object or object or object or 8 more` @@ -62533,13 +62659,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_add_initiated"` + - `type: optional "org_discoverability_disabled"` - default: org_domain_add_initiated + default: org_discoverability_disabled - - `OrgDomainRemoved object` + - `OrgDiscoverabilityEnabled object` - Organization domain was removed. + Admin enabled organization discoverability. - `actor: object or object or object or 8 more` @@ -62762,8 +62888,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `domain: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -62772,13 +62896,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_removed"` + - `type: optional "org_discoverability_enabled"` - default: org_domain_removed + default: org_discoverability_enabled - - `OrgDomainVerified object` + - `OrgDiscoverabilitySettingsUpdated object` - Organization domain was verified. + Admin updated organization discoverability settings. - `actor: object or object or object or 8 more` @@ -63001,8 +63125,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `domain: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63011,13 +63133,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_domain_verified"` + - `type: optional "org_discoverability_settings_updated"` - default: org_domain_verified + default: org_discoverability_settings_updated - - `OrgExternalKeyCreated object` + - `OrgDomainAddInitiated object` - A CMEK external key config was created. + Organization domain verification was initiated. - `actor: object or object or object or 8 more` @@ -63230,22 +63352,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the created external key config - - - `provider: "aws" or "azure" or "gcp" or "unspecified"` - - KMS provider backing the key - - - `"aws"` - - - `"azure"` - - - `"gcp"` - - - `"unspecified"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63264,13 +63370,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_created"` + - `type: optional "org_domain_add_initiated"` - default: org_external_key_created + default: org_domain_add_initiated - - `OrgExternalKeyDeleted object` + - `OrgDomainRemoved object` - A CMEK external key config was deleted. + Organization domain was removed. - `actor: object or object or object or 8 more` @@ -63483,10 +63589,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the deleted external key config - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63497,6 +63599,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `domain: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63505,13 +63609,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_deleted"` + - `type: optional "org_domain_removed"` - default: org_external_key_deleted + default: org_domain_removed - - `OrgExternalKeyUpdated object` + - `OrgDomainVerified object` - A CMEK external key config was updated. + Organization domain was verified. - `actor: object or object or object or 8 more` @@ -63724,10 +63828,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `external_key_id: string` - - Tagged ID of the updated external key config - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -63738,6 +63838,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `domain: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -63746,37 +63848,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_updated"` - - default: org_external_key_updated - - - `updates: optional array of object` - - The field-level changes applied in this update - - - `current_value: string` - - Field value immediately after this change - - - `previous_value: string` - - Field value immediately before this change - - - `type: "display_name" or "geo" or "provider_config" or "unspecified"` - - The external key config field that changed - - - `"display_name"` - - - `"geo"` - - - `"provider_config"` + - `type: optional "org_domain_verified"` - - `"unspecified"` + default: org_domain_verified - - `OrgExternalKeyValidated object` + - `OrgExternalKeyCreated object` - A CMEK external key config was validated against the customer's KMS. + A CMEK external key config was created. - `actor: object or object or object or 8 more` @@ -63991,15 +64069,17 @@ compliance activities that can be filtered by various criteria. - `external_key_id: string` - Tagged ID of the validated external key config + Tagged ID of the created external key config - - `validation_result: "failure" or "success" or "unspecified"` + - `provider: "aws" or "azure" or "gcp" or "unspecified"` - Outcome of the encrypt/decrypt roundtrip + KMS provider backing the key - - `"failure"` + - `"aws"` - - `"success"` + - `"azure"` + + - `"gcp"` - `"unspecified"` @@ -64021,14 +64101,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_external_key_validated"` + - `type: optional "org_external_key_created"` - default: org_external_key_validated + default: org_external_key_created - - `OrgHipaaSelfServeEnabled object` + - `OrgExternalKeyDeleted object` - A primary owner click-accepted the BAA and enabled HIPAA protections - for the organization via the self-serve flow. + A CMEK external key config was deleted. - `actor: object or object or object or 8 more` @@ -64241,11 +64320,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `baa_content_hash: string` - - - `baa_version_label: string` + - `external_key_id: string` - - `setup_guide_content_hash: string` + Tagged ID of the deleted external key config - `id: optional string` @@ -64265,13 +64342,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_hipaa_self_serve_enabled"` + - `type: optional "org_external_key_deleted"` - default: org_hipaa_self_serve_enabled + default: org_external_key_deleted - - `OrgIPRestrictionCreated object` + - `OrgExternalKeyUpdated object` - Organization IP restriction was created. + A CMEK external key config was updated. - `actor: object or object or object or 8 more` @@ -64484,6 +64561,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `external_key_id: string` + + Tagged ID of the updated external key config + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64502,13 +64583,37 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_created"` + - `type: optional "org_external_key_updated"` - default: org_ip_restriction_created + default: org_external_key_updated - - `OrgIPRestrictionDeleted object` + - `updates: optional array of object` - Organization IP restriction was deleted. + The field-level changes applied in this update + + - `current_value: string` + + Field value immediately after this change + + - `previous_value: string` + + Field value immediately before this change + + - `type: "display_name" or "geo" or "provider_config" or "unspecified"` + + The external key config field that changed + + - `"display_name"` + + - `"geo"` + + - `"provider_config"` + + - `"unspecified"` + + - `OrgExternalKeyValidated object` + + A CMEK external key config was validated against the customer's KMS. - `actor: object or object or object or 8 more` @@ -64721,6 +64826,20 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `external_key_id: string` + + Tagged ID of the validated external key config + + - `validation_result: "failure" or "success" or "unspecified"` + + Outcome of the encrypt/decrypt roundtrip + + - `"failure"` + + - `"success"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64739,13 +64858,14 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_deleted"` + - `type: optional "org_external_key_validated"` - default: org_ip_restriction_deleted + default: org_external_key_validated - - `OrgIPRestrictionUpdated object` + - `OrgHipaaSelfServeEnabled object` - Organization IP restriction was updated. + A primary owner click-accepted the BAA and enabled HIPAA protections + for the organization via the self-serve flow. - `actor: object or object or object or 8 more` @@ -64958,6 +65078,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `baa_content_hash: string` + + - `baa_version_label: string` + + - `setup_guide_content_hash: string` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -64976,13 +65102,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_ip_restriction_updated"` + - `type: optional "org_hipaa_self_serve_enabled"` - default: org_ip_restriction_updated + default: org_hipaa_self_serve_enabled - - `OrgInviteLinkDisabled object` + - `OrgIPRestrictionCreated object` - Organization invite link was disabled. + Organization IP restriction was created. - `actor: object or object or object or 8 more` @@ -65213,13 +65339,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_disabled"` + - `type: optional "org_ip_restriction_created"` - default: org_invite_link_disabled + default: org_ip_restriction_created - - `OrgInviteLinkGenerated object` + - `OrgIPRestrictionDeleted object` - Organization invite link was generated. + Organization IP restriction was deleted. - `actor: object or object or object or 8 more` @@ -65450,13 +65576,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_generated"` + - `type: optional "org_ip_restriction_deleted"` - default: org_invite_link_generated + default: org_ip_restriction_deleted - - `OrgInviteLinkRegenerated object` + - `OrgIPRestrictionUpdated object` - Organization invite link was regenerated (previous link invalidated). + Organization IP restriction was updated. - `actor: object or object or object or 8 more` @@ -65687,13 +65813,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_link_regenerated"` + - `type: optional "org_ip_restriction_updated"` - default: org_invite_link_regenerated + default: org_ip_restriction_updated - - `OrgInviteViewed object` + - `OrgInviteLinkDisabled object` - An organization invite was viewed. + Organization invite link was disabled. - `actor: object or object or object or 8 more` @@ -65906,10 +66032,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invite_id: string` - - Tagged ID of the viewed invite - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -65928,13 +66050,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invite_viewed"` + - `type: optional "org_invite_link_disabled"` - default: org_invite_viewed + default: org_invite_link_disabled - - `OrgInvitesListed object` + - `OrgInviteLinkGenerated object` - Organization invites were listed. + Organization invite link was generated. - `actor: object or object or object or 8 more` @@ -66165,13 +66287,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_invites_listed"` + - `type: optional "org_invite_link_generated"` - default: org_invites_listed + default: org_invite_link_generated - - `OrgJoinProposalDecided object` + - `OrgInviteLinkRegenerated object` - Approve or reject decision on a parent-org join proposal. + Organization invite link was regenerated (previous link invalidated). - `actor: object or object or object or 8 more` @@ -66384,8 +66506,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `approved: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -66404,13 +66524,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_proposal_decided"` + - `type: optional "org_invite_link_regenerated"` - default: org_join_proposal_decided + default: org_invite_link_regenerated - - `OrgJoinRequestApproved object` + - `OrgInviteViewed object` - Admin approved a join request. + An organization invite was viewed. - `actor: object or object or object or 8 more` @@ -66623,6 +66743,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invite_id: string` + + Tagged ID of the viewed invite + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -66641,13 +66765,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_approved"` + - `type: optional "org_invite_viewed"` - default: org_join_request_approved + default: org_invite_viewed - - `OrgJoinRequestCreated object` + - `OrgInvitesListed object` - User requested to join an organization. + Organization invites were listed. - `actor: object or object or object or 8 more` @@ -66878,13 +67002,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_created"` + - `type: optional "org_invites_listed"` - default: org_join_request_created + default: org_invites_listed - - `OrgJoinRequestDismissed object` + - `OrgJoinProposalDecided object` - Admin dismissed a join request. + Approve or reject decision on a parent-org join proposal. - `actor: object or object or object or 8 more` @@ -67097,6 +67221,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `approved: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -67115,13 +67241,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_dismissed"` + - `type: optional "org_join_proposal_decided"` - default: org_join_request_dismissed + default: org_join_proposal_decided - - `OrgJoinRequestInstantApproved object` + - `OrgJoinRequestApproved object` - Join request was instantly approved. + Admin approved a join request. - `actor: object or object or object or 8 more` @@ -67352,13 +67478,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_request_instant_approved"` + - `type: optional "org_join_request_approved"` - default: org_join_request_instant_approved + default: org_join_request_approved - - `OrgJoinRequestsBulkDismissed object` + - `OrgJoinRequestCreated object` - Admin bulk-dismissed join requests. + User requested to join an organization. - `actor: object or object or object or 8 more` @@ -67589,13 +67715,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_join_requests_bulk_dismissed"` + - `type: optional "org_join_request_created"` - default: org_join_requests_bulk_dismissed + default: org_join_request_created - - `OrgMagicLinkSecondFactorToggled object` + - `OrgJoinRequestDismissed object` - Organization magic link second factor was toggled. + Admin dismissed a join request. - `actor: object or object or object or 8 more` @@ -67808,8 +67934,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -67828,13 +67952,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_magic_link_second_factor_toggled"` + - `type: optional "org_join_request_dismissed"` - default: org_magic_link_second_factor_toggled + default: org_join_request_dismissed - - `OrgMemberInvitesDisabled object` + - `OrgJoinRequestInstantApproved object` - Admin disabled member invites for the organization. + Join request was instantly approved. - `actor: object or object or object or 8 more` @@ -68065,13 +68189,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_member_invites_disabled"` + - `type: optional "org_join_request_instant_approved"` - default: org_member_invites_disabled + default: org_join_request_instant_approved - - `OrgMemberInvitesEnabled object` + - `OrgJoinRequestsBulkDismissed object` - Admin enabled member invites for the organization. + Admin bulk-dismissed join requests. - `actor: object or object or object or 8 more` @@ -68302,13 +68426,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_member_invites_enabled"` + - `type: optional "org_join_requests_bulk_dismissed"` - default: org_member_invites_enabled + default: org_join_requests_bulk_dismissed - - `OrgMembersExported object` + - `OrgMagicLinkSecondFactorToggled object` - Organization members list was exported as CSV. + Organization magic link second factor was toggled. - `actor: object or object or object or 8 more` @@ -68521,6 +68645,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -68539,23 +68665,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_members_exported"` - - default: org_members_exported - - - `OrgModelDefaultUpdated object` - - An organization or role default model setting was changed by an administrator. - - - `action: "cleared" or "set" or "unspecified"` - - Whether the default model was set or cleared + - `type: optional "org_magic_link_second_factor_toggled"` - - `"cleared"` + default: org_magic_link_second_factor_toggled - - `"set"` + - `OrgMemberInvitesDisabled object` - - `"unspecified"` + Admin disabled member invites for the organization. - `actor: object or object or object or 8 more` @@ -68768,24 +68884,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `override_user_selection: boolean` - - Whether the default is enforced as a fixed default, resetting members' own model selections at the start of each new conversation - - - `principal_id: string` - - Tagged ID of the organization or role the default applies to - - - `principal_type: "org" or "rbac_role" or "unspecified"` - - Whether the default applies to the whole organization or to a single role - - - `"org"` - - - `"rbac_role"` - - - `"unspecified"` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -68796,26 +68894,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `default_model: optional string or null` - - The model set as the default, when the action is set - - - `model_access: optional array of object` - - The per-model access overrides set for this principal; absent when no overrides are configured - - - `api_name: string` - - The model the decision applies to - - - `enabled: boolean` - - Whether members with this principal may select the model - - - `max_effort_level: optional string or null` - - The highest effort level members may select for this model, when capped - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -68824,13 +68902,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_model_default_updated"` + - `type: optional "org_member_invites_disabled"` - default: org_model_default_updated + default: org_member_invites_disabled - - `OrgParentJoinProposalCreated object` + - `OrgMemberInvitesEnabled object` - Organization parent join proposal was created. + Admin enabled member invites for the organization. - `actor: object or object or object or 8 more` @@ -69061,13 +69139,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_parent_join_proposal_created"` + - `type: optional "org_member_invites_enabled"` - default: org_parent_join_proposal_created + default: org_member_invites_enabled - - `OrgParentSearchPerformed object` + - `OrgMembersExported object` - Organization parent search was performed. + Organization members list was exported as CSV. - `actor: object or object or object or 8 more` @@ -69298,13 +69376,23 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_parent_search_performed"` + - `type: optional "org_members_exported"` - default: org_parent_search_performed + default: org_members_exported - - `OrgSSOAddInitiated object` + - `OrgModelDefaultUpdated object` - Organization SSO setup was initiated. + An organization or role default model setting was changed by an administrator. + + - `action: "cleared" or "set" or "unspecified"` + + Whether the default model was set or cleared + + - `"cleared"` + + - `"set"` + + - `"unspecified"` - `actor: object or object or object or 8 more` @@ -69517,6 +69605,24 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `override_user_selection: boolean` + + Whether the default is enforced as a fixed default, resetting members' own model selections at the start of each new conversation + + - `principal_id: string` + + Tagged ID of the organization or role the default applies to + + - `principal_type: "org" or "rbac_role" or "unspecified"` + + Whether the default applies to the whole organization or to a single role + + - `"org"` + + - `"rbac_role"` + + - `"unspecified"` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -69527,6 +69633,26 @@ compliance activities that can be filtered by various criteria. format: date-time + - `default_model: optional string or null` + + The model set as the default, when the action is set + + - `model_access: optional array of object` + + The per-model access overrides set for this principal; absent when no overrides are configured + + - `api_name: string` + + The model the decision applies to + + - `enabled: boolean` + + Whether members with this principal may select the model + + - `max_effort_level: optional string or null` + + The highest effort level members may select for this model, when capped + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -69535,13 +69661,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_add_initiated"` + - `type: optional "org_model_default_updated"` - default: org_sso_add_initiated + default: org_model_default_updated - - `OrgSSOConnectionActivated object` + - `OrgParentJoinProposalCreated object` - Organization SSO connection was activated. + Organization parent join proposal was created. - `actor: object or object or object or 8 more` @@ -69758,10 +69884,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - - `connection_type: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -69776,13 +69898,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_activated"` + - `type: optional "org_parent_join_proposal_created"` - default: org_sso_connection_activated + default: org_parent_join_proposal_created - - `OrgSSOConnectionDeactivated object` + - `OrgParentSearchPerformed object` - Organization SSO connection was deactivated. + Organization parent search was performed. - `actor: object or object or object or 8 more` @@ -69999,8 +70121,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -70015,13 +70135,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_deactivated"` + - `type: optional "org_parent_search_performed"` - default: org_sso_connection_deactivated + default: org_parent_search_performed - - `OrgSSOConnectionDeleted object` + - `OrgSSOAddInitiated object` - Organization SSO connection was deleted. + Organization SSO setup was initiated. - `actor: object or object or object or 8 more` @@ -70238,8 +70358,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `connection_id: optional string or null` - - `created_at: optional string` When this activity occurred. @@ -70254,13 +70372,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_connection_deleted"` + - `type: optional "org_sso_add_initiated"` - default: org_sso_connection_deleted + default: org_sso_add_initiated - - `OrgSSOGroupRoleMappingsUpdated object` + - `OrgSSOConnectionActivated object` - Organization SSO group role mappings were updated. + Organization SSO connection was activated. - `actor: object or object or object or 8 more` @@ -70477,6 +70595,10 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + + - `connection_type: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -70491,13 +70613,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_group_role_mappings_updated"` + - `type: optional "org_sso_connection_activated"` - default: org_sso_group_role_mappings_updated + default: org_sso_connection_activated - - `OrgSSOProvisioningModeChanged object` + - `OrgSSOConnectionDeactivated object` - Organization SSO provisioning mode was changed. + Organization SSO connection was deactivated. - `actor: object or object or object or 8 more` @@ -70714,14 +70836,14 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + - `created_at: optional string` When this activity occurred. format: date-time - - `new_mode: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -70730,15 +70852,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mode: optional string or null` - - - `type: optional "org_sso_provisioning_mode_changed"` + - `type: optional "org_sso_connection_deactivated"` - default: org_sso_provisioning_mode_changed + default: org_sso_connection_deactivated - - `OrgSSOScimWelcomeEmailToggled object` + - `OrgSSOConnectionDeleted object` - Organization SCIM-provisioned welcome email was toggled. + Organization SSO connection was deleted. - `actor: object or object or object or 8 more` @@ -70951,12 +71071,12 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' + - `connection_id: optional string or null` + - `created_at: optional string` When this activity occurred. @@ -70971,17 +71091,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether the SCIM welcome email was enabled before this change. - - - `type: optional "org_sso_scim_welcome_email_toggled"` + - `type: optional "org_sso_connection_deleted"` - default: org_sso_scim_welcome_email_toggled + default: org_sso_connection_deleted - - `OrgSSOSeatTierAssignmentToggled object` + - `OrgSSOGroupRoleMappingsUpdated object` - Organization SSO seat tier assignment was toggled. + Organization SSO group role mappings were updated. - `actor: object or object or object or 8 more` @@ -71194,8 +71310,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `enabled: boolean` - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -71214,17 +71328,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_enabled: optional boolean or null` - - Whether SSO seat tier assignment was enabled before this change. - - - `type: optional "org_sso_seat_tier_assignment_toggled"` + - `type: optional "org_sso_group_role_mappings_updated"` - default: org_sso_seat_tier_assignment_toggled + default: org_sso_group_role_mappings_updated - - `OrgSSOSeatTierMappingsUpdated object` + - `OrgSSOProvisioningModeChanged object` - Organization SSO seat tier mappings were updated. + Organization SSO provisioning mode was changed. - `actor: object or object or object or 8 more` @@ -71447,17 +71557,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_mappings: optional array of object or null` - - Identity provider group to seat tier mappings after this change. - - - `idp_group_name: string` - - Name of the identity provider group. - - - `seat_tier: optional string or null` - - Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `new_mode: optional string or null` - `organization_id: optional string or null` @@ -71467,25 +71567,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_mappings: optional array of object or null` - - Identity provider group to seat tier mappings before this change. - - - `idp_group_name: string` - - Name of the identity provider group. - - - `seat_tier: optional string or null` - - Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `previous_mode: optional string or null` - - `type: optional "org_sso_seat_tier_mappings_updated"` + - `type: optional "org_sso_provisioning_mode_changed"` - default: org_sso_seat_tier_mappings_updated + default: org_sso_provisioning_mode_changed - - `OrgSSOToggled object` + - `OrgSSOScimWelcomeEmailToggled object` - Organization SSO was toggled on or off. + Organization SCIM-provisioned welcome email was toggled. - `actor: object or object or object or 8 more` @@ -71718,13 +71808,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sso_toggled"` + - `previous_enabled: optional boolean or null` - default: org_sso_toggled + Whether the SCIM welcome email was enabled before this change. - - `OrgSyncDeletingSynchronizedFilesStarted object` + - `type: optional "org_sso_scim_welcome_email_toggled"` - Organization started deleting synchronized files. + default: org_sso_scim_welcome_email_toggled + + - `OrgSSOSeatTierAssignmentToggled object` + + Organization SSO seat tier assignment was toggled. - `actor: object or object or object or 8 more` @@ -71937,6 +72031,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -71955,13 +72051,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sync_deleting_synchronized_files_started"` + - `previous_enabled: optional boolean or null` - default: org_sync_deleting_synchronized_files_started + Whether SSO seat tier assignment was enabled before this change. - - `OrgSyncSynchronizedFilesDeleted object` + - `type: optional "org_sso_seat_tier_assignment_toggled"` - Organization synchronized files were deleted. + default: org_sso_seat_tier_assignment_toggled + + - `OrgSSOSeatTierMappingsUpdated object` + + Organization SSO seat tier mappings were updated. - `actor: object or object or object or 8 more` @@ -72184,6 +72284,18 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_mappings: optional array of object or null` + + Identity provider group to seat tier mappings after this change. + + - `idp_group_name: string` + + Name of the identity provider group. + + - `seat_tier: optional string or null` + + Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -72192,13 +72304,25 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_sync_synchronized_files_deleted"` + - `previous_mappings: optional array of object or null` - default: org_sync_synchronized_files_deleted + Identity provider group to seat tier mappings before this change. - - `OrgTaintAdded object` + - `idp_group_name: string` - A taint was added to an organization. + Name of the identity provider group. + + - `seat_tier: optional string or null` + + Seat tier assigned to members of the identity provider group, or null if the mapping assigns no seat. + + - `type: optional "org_sso_seat_tier_mappings_updated"` + + default: org_sso_seat_tier_mappings_updated + + - `OrgSSOToggled object` + + Organization SSO was toggled on or off. - `actor: object or object or object or 8 more` @@ -72411,6 +72535,8 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `enabled: boolean` + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -72429,19 +72555,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `taint: optional string or null` - - - `type: optional "org_taint_added"` - - default: org_taint_added - - - `workspace_id: optional string or null` + - `type: optional "org_sso_toggled"` - Tagged ID of the workspace the taint was applied to. Unset when applied at organization scope. + default: org_sso_toggled - - `OrgTaintRemoved object` + - `OrgSyncDeletingSynchronizedFilesStarted object` - A taint was removed from an organization. + Organization started deleting synchronized files. - `actor: object or object or object or 8 more` @@ -72672,15 +72792,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `taint: optional string or null` - - - `type: optional "org_taint_removed"` + - `type: optional "org_sync_deleting_synchronized_files_started"` - default: org_taint_removed + default: org_sync_deleting_synchronized_files_started - - `OrgUserDeleted object` + - `OrgSyncSynchronizedFilesDeleted object` - User was removed from organization. + Organization synchronized files were deleted. - `actor: object or object or object or 8 more` @@ -72903,10 +73021,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `deleted_user_email: optional string or null` - - - `deleted_user_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -72915,13 +73029,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_deleted"` + - `type: optional "org_sync_synchronized_files_deleted"` - default: org_user_deleted + default: org_sync_synchronized_files_deleted - - `OrgUserInviteAccepted object` + - `OrgTaintAdded object` - Organization user invite was accepted. + A taint was added to an organization. - `actor: object or object or object or 8 more` @@ -73144,8 +73258,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invite_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -73154,17 +73266,19 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `rbac_group_ids: optional array of string or null` + - `taint: optional string or null` - RBAC group IDs the user was added to on acceptance, as confirmed by the group service (absent on rows written before this was recorded, and when the invite carried no groups) + - `type: optional "org_taint_added"` - - `type: optional "org_user_invite_accepted"` + default: org_taint_added - default: org_user_invite_accepted + - `workspace_id: optional string or null` - - `OrgUserInviteDeleted object` + Tagged ID of the workspace the taint was applied to. Unset when applied at organization scope. - Organization user invite was deleted. + - `OrgTaintRemoved object` + + A taint was removed from an organization. - `actor: object or object or object or 8 more` @@ -73387,8 +73501,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invite_id: optional string or null` - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -73397,13 +73509,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_deleted"` + - `taint: optional string or null` - default: org_user_invite_deleted + - `type: optional "org_taint_removed"` - - `OrgUserInviteReSent object` + default: org_taint_removed - Organization user invite was re-sent. + - `OrgUserDeleted object` + + User was removed from organization. - `actor: object or object or object or 8 more` @@ -73626,15 +73740,9 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invited_email: optional string or null` - - - `invited_role: optional string or null` - - Role the invited user will receive on joining - - - `invited_seat_tier: optional string or null` + - `deleted_user_email: optional string or null` - Seat tier the invited user will receive on joining + - `deleted_user_id: optional string or null` - `organization_id: optional string or null` @@ -73644,13 +73752,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_re_sent"` + - `type: optional "org_user_deleted"` - default: org_user_invite_re_sent + default: org_user_deleted - - `OrgUserInviteRejected object` + - `OrgUserInviteAccepted object` - Organization user invite was rejected. + Organization user invite was accepted. - `actor: object or object or object or 8 more` @@ -73883,13 +73991,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_rejected"` + - `rbac_group_ids: optional array of string or null` - default: org_user_invite_rejected + RBAC group IDs the user was added to on acceptance, as confirmed by the group service (absent on rows written before this was recorded, and when the invite carried no groups) - - `OrgUserInviteSent object` + - `type: optional "org_user_invite_accepted"` - Organization user invite was sent. + default: org_user_invite_accepted + + - `OrgUserInviteDeleted object` + + Organization user invite was deleted. - `actor: object or object or object or 8 more` @@ -74112,17 +74224,7 @@ compliance activities that can be filtered by various criteria. format: date-time - - `invited_email: optional string or null` - - - `invited_rbac_group_ids: optional array of string or null` - - RBAC group IDs the invited user will be added to on joining - - - `invited_role: optional string or null` - - - `invited_seat_tier: optional string or null` - - Seat tier the invited user will receive on joining + - `invite_id: optional string or null` - `organization_id: optional string or null` @@ -74132,13 +74234,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_invite_sent"` + - `type: optional "org_user_invite_deleted"` - default: org_user_invite_sent + default: org_user_invite_deleted - - `OrgUserLeft object` + - `OrgUserInviteReSent object` - User removed themselves from organization. + Organization user invite was re-sent. - `actor: object or object or object or 8 more` @@ -74361,6 +74463,16 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invited_email: optional string or null` + + - `invited_role: optional string or null` + + Role the invited user will receive on joining + + - `invited_seat_tier: optional string or null` + + Seat tier the invited user will receive on joining + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74369,15 +74481,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_role: optional string or null` - - - `type: optional "org_user_left"` + - `type: optional "org_user_invite_re_sent"` - default: org_user_left + default: org_user_invite_re_sent - - `OrgUserTrustedDevicesRevoked object` + - `OrgUserInviteRejected object` - An organization admin revoked a member's trusted devices and signed the member out of all active sessions. + Organization user invite was rejected. - `actor: object or object or object or 8 more` @@ -74590,22 +74700,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `completed: boolean` - - Whether the operation completed fully. False records an attempt that revoked the counted credentials but failed before finishing. - - - `devices_revoked_count: number` - - Number of trusted devices revoked - - - `sessions_revoked_count: number` - - Number of active sessions the member was signed out of - - - `user_id: string` - - Tagged ID of the member whose trusted devices were revoked - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -74616,6 +74710,8 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invite_id: optional string or null` + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74624,13 +74720,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_trusted_devices_revoked"` + - `type: optional "org_user_invite_rejected"` - default: org_user_trusted_devices_revoked + default: org_user_invite_rejected - - `OrgUserViewed object` + - `OrgUserInviteSent object` - An organization user was viewed. + Organization user invite was sent. - `actor: object or object or object or 8 more` @@ -74843,10 +74939,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `user_id: string` - - Tagged ID of the viewed user - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -74857,6 +74949,18 @@ compliance activities that can be filtered by various criteria. format: date-time + - `invited_email: optional string or null` + + - `invited_rbac_group_ids: optional array of string or null` + + RBAC group IDs the invited user will be added to on joining + + - `invited_role: optional string or null` + + - `invited_seat_tier: optional string or null` + + Seat tier the invited user will receive on joining + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -74865,13 +74969,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_user_viewed"` + - `type: optional "org_user_invite_sent"` - default: org_user_viewed + default: org_user_invite_sent - - `OrgUsersListed object` + - `OrgUserLeft object` - Organization users were listed. + User removed themselves from organization. - `actor: object or object or object or 8 more` @@ -75102,13 +75206,15 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "org_users_listed"` + - `previous_role: optional string or null` - default: org_users_listed + - `type: optional "org_user_left"` - - `OrgWorkAcrossAppsDisabled object` + default: org_user_left - Organization Work Across Apps was disabled. + - `OrgUserTrustedDevicesRevoked object` + + An organization admin revoked a member's trusted devices and signed the member out of all active sessions. - `actor: object or object or object or 8 more` @@ -75321,6 +75427,22 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `completed: boolean` + + Whether the operation completed fully. False records an attempt that revoked the counted credentials but failed before finishing. + + - `devices_revoked_count: number` + + Number of trusted devices revoked + + - `sessions_revoked_count: number` + + Number of active sessions the member was signed out of + + - `user_id: string` + + Tagged ID of the member whose trusted devices were revoked + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -75331,10 +75453,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -75343,17 +75461,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_work_across_apps_disabled"` + - `type: optional "org_user_trusted_devices_revoked"` - default: org_work_across_apps_disabled + default: org_user_trusted_devices_revoked - - `OrgWorkAcrossAppsEnabled object` + - `OrgUserViewed object` - Organization Work Across Apps was enabled. + An organization user was viewed. - `actor: object or object or object or 8 more` @@ -75566,6 +75680,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `user_id: string` + + Tagged ID of the viewed user + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -75576,10 +75694,6 @@ compliance activities that can be filtered by various criteria. format: date-time - - `current_value: optional boolean or null` - - Setting value immediately after this change - - `organization_id: optional string or null` Organization ID this activity is associated with @@ -75588,17 +75702,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: optional boolean or null` - - Setting value immediately before this change - - - `type: optional "org_work_across_apps_enabled"` + - `type: optional "org_user_viewed"` - default: org_work_across_apps_enabled + default: org_user_viewed - - `OrganizationAddressUpdated object` + - `OrgUsersListed object` - The organization's billing or shipping address was updated. + Organization users were listed. - `actor: object or object or object or 8 more` @@ -75815,14 +75925,6 @@ compliance activities that can be filtered by various criteria. Unique identifier for the activity e.g. 'activity_abcd1234' - - `billing_address_updated: optional boolean` - - default: false - - - `billing_name_updated: optional boolean` - - default: false - - `created_at: optional string` When this activity occurred. @@ -75837,21 +75939,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `shipping_address_updated: optional boolean` - - default: false - - - `shipping_name_updated: optional boolean` - - default: false + - `type: optional "org_users_listed"` - - `type: optional "organization_address_updated"` + default: org_users_listed - default: organization_address_updated + - `OrgWorkAcrossAppsDisabled object` - - `OrganizationIconDeleted object` - - Organization's custom icon deleted. + The organization's "Let Claude work across apps" setting was turned off. - `actor: object or object or object or 8 more` @@ -76074,6 +76168,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -76082,13 +76180,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "organization_icon_deleted"` + - `previous_value: optional boolean or null` - default: organization_icon_deleted + Setting value immediately before this change - - `OrganizationIconUpdated object` + - `type: optional "org_work_across_apps_disabled"` - Organization's custom icon uploaded or replaced. + default: org_work_across_apps_disabled + + - `OrgWorkAcrossAppsEnabled object` + + The organization's "Let Claude work across apps" setting was turned on. - `actor: object or object or object or 8 more` @@ -76311,6 +76413,10 @@ compliance activities that can be filtered by various criteria. format: date-time + - `current_value: optional boolean or null` + + Setting value immediately after this change + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -76319,13 +76425,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "organization_icon_updated"` + - `previous_value: optional boolean or null` - default: organization_icon_updated + Setting value immediately before this change - - `ClaudeOrganizationSettingsUpdated object` + - `type: optional "org_work_across_apps_enabled"` - Organization settings were updated. + default: org_work_across_apps_enabled + + - `OrganizationAddressUpdated object` + + The organization's billing or shipping address was updated. - `actor: object or object or object or 8 more` @@ -76538,1584 +76648,3060 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `updates: array of object or object or object or 84 more` + - `id: optional string` - - `OrganizationName object` + Unique identifier for the activity e.g. 'activity_abcd1234' - The organization name setting was changed. + - `billing_address_updated: optional boolean` - - `current_value: string or null` + default: false - Setting value immediately after this change + - `billing_name_updated: optional boolean` - - `previous_value: string or null` + default: false - Setting value immediately before this change + - `created_at: optional string` - - `type: optional "name"` + When this activity occurred. - default: name + format: date-time - - `OrganizationCapabilities object` + - `organization_id: optional string or null` - The organization capabilities setting was changed. + Organization ID this activity is associated with - - `current_value: array of string or null` + - `organization_uuid: optional string or null` - Setting value immediately after this change + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: array of string or null` + - `shipping_address_updated: optional boolean` - Setting value immediately before this change + default: false - - `type: optional "capabilities"` + - `shipping_name_updated: optional boolean` - default: capabilities + default: false - - `OrganizationRedactContent object` + - `type: optional "organization_address_updated"` - The organization content-redaction setting was changed. + default: organization_address_updated - - `current_value: boolean or null` + - `OrganizationIconDeleted object` - Setting value immediately after this change + Organization's custom icon deleted. - - `previous_value: boolean or null` + - `actor: object or object or object or 8 more` - Setting value immediately before this change + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `type: optional "redact_content"` + - `APIActor object` - default: redact_content + - `api_key_id: string` - - `PublicProjectsEnabled object` + - `ip_address: string` - The public projects setting was changed for the organization. + - `user_agent: string` - - `current_value: boolean or null` + - `type: optional "api_actor"` - Setting value immediately after this change + default: api_actor - - `previous_value: boolean or null` + - `UserActor object` - Setting value immediately before this change + - `email_address: string` - - `type: optional "public_projects_enabled"` + format: email - default: public_projects_enabled + - `ip_address: string` - - `WebSearchEnabled object` + - `user_agent: string` - The web search setting was changed. + - `user_id: string` - - `current_value: boolean or null` + - `type: optional "user_actor"` - Setting value immediately after this change + default: user_actor - - `previous_value: boolean or null` + - `UnauthenticatedUserActor object` - Setting value immediately before this change + - `ip_address: string` - - `type: optional "web_search_enabled"` + - `user_agent: string` - default: web_search_enabled + - `type: optional "unauthenticated_user_actor"` - - `GeolocationEnabled object` + default: unauthenticated_user_actor - The geolocation setting was changed. + - `unauthenticated_email_address: optional string or null` - - `current_value: boolean or null` + format: email - Setting value immediately after this change + - `AnthropicActor object` - - `previous_value: boolean or null` + - `email_address: optional string or null` - Setting value immediately before this change + format: email - - `type: optional "geolocation_enabled"` + - `type: optional "anthropic_actor"` - default: geolocation_enabled + default: anthropic_actor - - `OrgMemoryEnabledSetting object` + - `SystemActor object` - The memory setting was changed for the organization. + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `current_value: boolean or null` + - `service: optional string or null` - Setting value immediately after this change + Name of the automated process that performed the action, when known. - - `previous_value: boolean or null` + - `type: optional "system_actor"` - Setting value immediately before this change + default: system_actor - - `type: optional "enabled_saffron"` + - `AdminAPIKeyActor object` - default: enabled_saffron + - `admin_api_key_id: string` - - `DataRetentionPeriods object` + - `ip_address: string` - The data retention periods setting was changed for the organization. + - `user_agent: string` - - `current_value: array of object or null` + - `type: optional "admin_api_key_actor"` - Setting value immediately after this change + default: admin_api_key_actor - - `data_type: "all" or "artifact_private" or "artifact_shared" or 2 more` + - `ServiceAccountActor object` - - `"all"` + - `ip_address: string` - - `"artifact_private"` + - `service_account_id: string` - - `"artifact_shared"` + - `user_agent: string` - - `"chat"` + - `type: optional "service_account_actor"` - - `"project"` + default: service_account_actor - - `duration: number` + - `ScimDirectorySyncActor object` - maximum: 2147483647, minimum: -2147483648 + - `directory_id: string` - - `timescale: "day" or "indefinite" or "month"` + - `workos_event_id: string` - - `"day"` + - `idp_connection_type: optional string or null` - - `"indefinite"` + - `type: optional "scim_directory_sync_actor"` - - `"month"` + default: scim_directory_sync_actor - - `previous_value: array of object or null` + - `FederatedIdentityActor object` - Setting value immediately before this change + A federated external workload authenticated via a verified OIDC token. - - `data_type: "all" or "artifact_private" or "artifact_shared" or 2 more` + Carries the verified issuer, subject, and audience claims from the + presented JWT. - - `"all"` + - `issuer: string` - - `"artifact_private"` + - `subject: string` - - `"artifact_shared"` + - `audience: optional array of string` - - `"chat"` + - `ip_address: optional string or null` - - `"project"` + - `type: optional "federated_identity_actor"` - - `duration: number` + default: federated_identity_actor - maximum: 2147483647, minimum: -2147483648 + - `user_agent: optional string or null` - - `timescale: "day" or "indefinite" or "month"` + - `FederatedActor object` - - `"day"` + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. - - `"indefinite"` + - `provider: object or object or object or object` - - `"month"` + Asserting party: the AWS account the organization is bound to. - - `type: optional "data_retention_periods"` + - `FederatedActorAwsProvider object` - default: data_retention_periods + Asserting party: the AWS account the organization is bound to. - - `MembersLimit object` + - `account_id: string` - The members limit setting was changed for the organization. + - `signed_principal: string` - - `current_value: number or null` + The AWS-signed ARN of the IAM principal that requested the token. - Setting value immediately after this change + - `type: optional "aws"` - - `previous_value: number or null` + default: aws - Setting value immediately before this change + - `FederatedActorAzureProvider object` - - `type: optional "members_limit"` + Asserting party: the Azure subscription the organization is bound to. - default: members_limit + - `subscription_id: string` - - `ClaudeAPIInArtifactsEnabled object` + - `type: optional "azure"` - The Claude API in Artifacts setting was changed. + default: azure - - `current_value: boolean or null` + - `FederatedActorGcpProvider object` - Setting value immediately after this change + Asserting party: the GCP project the organization is bound to. - - `previous_value: boolean or null` + - `project_number: string` - Setting value immediately before this change + - `type: optional "gcp"` - - `type: optional "claude_api_in_artifacts_enabled"` + default: gcp - default: claude_api_in_artifacts_enabled + - `FederatedActorOidcProvider object` - - `SupportContactMode object` + Asserting party: a customer-registered OIDC federation issuer. - The support contact routing mode setting was changed for the organization. + - `issuer: optional string or null` - - `current_value: "ai_support_only" or "human_support_restricted" or null` + The federation issuer's URL. Null when the presented credential failed verification. - Setting value immediately after this change + - `type: optional "oidc"` - - `"ai_support_only"` + default: oidc - - `"human_support_restricted"` + - `ip_address: optional string or null` - - `previous_value: "ai_support_only" or "human_support_restricted" or null` + - `subject: optional string or null` - Setting value immediately before this change + The provider's verified identifier for the caller; its form depends on the provider. - - `"ai_support_only"` + - `type: optional "federated_actor"` - - `"human_support_restricted"` + default: federated_actor - - `type: optional "support_contact_mode"` + - `user_agent: optional string or null` - default: support_contact_mode + - `AttestedDeviceActor object` - - `SupportContactAlwaysIncludeAdminsOwners object` + An attested mobile device authenticated via Apple App Attest. - The support contact always-include-admins-owners setting was changed for the organization. + - `external_client_id: string` - - `current_value: boolean or null` + - `kid_hash: string` - Setting value immediately after this change + - `ip_address: optional string or null` - - `previous_value: boolean or null` + - `type: optional "attested_device_actor"` - Setting value immediately before this change + default: attested_device_actor - - `type: optional "support_contact_always_include_admins_owners"` + - `user_agent: optional string or null` - default: support_contact_always_include_admins_owners + - `id: optional string` - - `SupportContactDesignatedGroups object` + Unique identifier for the activity e.g. 'activity_abcd1234' - The support contact designated groups setting was changed for the organization. + - `created_at: optional string` - - `current_value: array of string or null` + When this activity occurred. - Setting value immediately after this change + format: date-time - - `previous_value: array of string or null` + - `organization_id: optional string or null` - Setting value immediately before this change + Organization ID this activity is associated with - - `type: optional "support_contact_designated_groups"` + - `organization_uuid: optional string or null` - default: support_contact_designated_groups + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `SubscriptionItemQuotas object` + - `type: optional "organization_icon_deleted"` - The organization's subscription seat quotas were changed. + default: organization_icon_deleted - - `current_value: map[number] or null` + - `OrganizationIconUpdated object` - Seat-type to quantity mapping immediately after this change. A null quantity means the item is unlimited/unmetered. + Organization's custom icon uploaded or replaced. - - `previous_value: map[number] or null` + - `actor: object or object or object or 8 more` - Seat-type to quantity mapping immediately before this change. A null quantity means the item was unlimited/unmetered. + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `type: optional "subscription_item_quotas"` + - `APIActor object` - default: subscription_item_quotas + - `api_key_id: string` - - `MembersBulkSeatTierAssignment object` + - `ip_address: string` - All organization members were assigned the specified seat tier. + - `user_agent: string` - - `current_value: string or null` + - `type: optional "api_actor"` - The seat tier every member was assigned to + default: api_actor - - `member_count: optional number or null` + - `UserActor object` - Number of members whose seat tier was changed + - `email_address: string` - - `previous_value: optional string or null` + format: email - Not populated; members may have held differing seat tiers before the bulk assignment + - `ip_address: string` - - `type: optional "members_bulk_seat_tier_assignment"` + - `user_agent: string` - default: members_bulk_seat_tier_assignment + - `user_id: string` - - `ClaudeCodeWebEnabled object` + - `type: optional "user_actor"` - The Claude Code on the web setting was changed for the organization. + default: user_actor - - `current_value: boolean or null` + - `UnauthenticatedUserActor object` - Setting value immediately after this change + - `ip_address: string` - - `previous_value: boolean or null` + - `user_agent: string` - Setting value immediately before this change + - `type: optional "unauthenticated_user_actor"` - - `type: optional "claude_code_web_enabled"` + default: unauthenticated_user_actor - default: claude_code_web_enabled + - `unauthenticated_email_address: optional string or null` - - `ClaudeCodeDesktopBypassPermissionsEnabled object` + format: email - The Claude Code Desktop bypass-permissions mode setting was changed for the organization. + - `AnthropicActor object` - - `current_value: boolean or null` + - `email_address: optional string or null` - Setting value immediately after this change + format: email - - `previous_value: boolean or null` + - `type: optional "anthropic_actor"` - Setting value immediately before this change + default: anthropic_actor - - `type: optional "claude_code_desktop_bypass_permissions_enabled"` + - `SystemActor object` - default: claude_code_desktop_bypass_permissions_enabled + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `ClaudeCodeDesktopAutoPermissionsEnabled object` + - `service: optional string or null` - The Claude Code Desktop auto-permissions mode setting was changed for the organization. + Name of the automated process that performed the action, when known. - - `current_value: boolean or null` + - `type: optional "system_actor"` - Setting value immediately after this change + default: system_actor - - `previous_value: boolean or null` + - `AdminAPIKeyActor object` - Setting value immediately before this change + - `admin_api_key_id: string` - - `type: optional "claude_code_desktop_auto_permissions_enabled"` + - `ip_address: string` - default: claude_code_desktop_auto_permissions_enabled + - `user_agent: string` - - `SkillsEnabled object` + - `type: optional "admin_api_key_actor"` - The Claude.ai skills setting was changed for the organization. + default: admin_api_key_actor - - `current_value: boolean or null` + - `ServiceAccountActor object` - Setting value immediately after this change + - `ip_address: string` - - `previous_value: boolean or null` + - `service_account_id: string` - Setting value immediately before this change + - `user_agent: string` - - `type: optional "skills_enabled"` + - `type: optional "service_account_actor"` - default: skills_enabled + default: service_account_actor - - `WorkbenchCompletionFeedbackEnabled object` + - `ScimDirectorySyncActor object` - The Workbench completion feedback setting was changed for the organization. + - `directory_id: string` - - `current_value: boolean or null` + - `workos_event_id: string` - Setting value immediately after this change + - `idp_connection_type: optional string or null` - - `previous_value: boolean or null` + - `type: optional "scim_directory_sync_actor"` - Setting value immediately before this change + default: scim_directory_sync_actor - - `type: optional "workbench_completion_feedback_enabled"` + - `FederatedIdentityActor object` - default: workbench_completion_feedback_enabled + A federated external workload authenticated via a verified OIDC token. - - `ClaudeAICompletionFeedbackEnabled object` + Carries the verified issuer, subject, and audience claims from the + presented JWT. - The Claude.ai completion feedback setting was changed for the organization. + - `issuer: string` - - `current_value: boolean or null` + - `subject: string` - Setting value immediately after this change + - `audience: optional array of string` - - `previous_value: boolean or null` + - `ip_address: optional string or null` - Setting value immediately before this change + - `type: optional "federated_identity_actor"` - - `type: optional "claude_ai_completion_feedback_enabled"` + default: federated_identity_actor - default: claude_ai_completion_feedback_enabled + - `user_agent: optional string or null` - - `ClaudeAIIntegrationSharingEnabled object` + - `FederatedActor object` - The Claude.ai integration sharing setting was changed for the organization. + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. - - `current_value: boolean or null` + - `provider: object or object or object or object` - Setting value immediately after this change + Asserting party: the AWS account the organization is bound to. - - `previous_value: boolean or null` + - `FederatedActorAwsProvider object` - Setting value immediately before this change + Asserting party: the AWS account the organization is bound to. - - `type: optional "claude_ai_integration_sharing_enabled"` + - `account_id: string` - default: claude_ai_integration_sharing_enabled + - `signed_principal: string` - - `ClaudeAIChatSharingEnabled object` + The AWS-signed ARN of the IAM principal that requested the token. - The Claude.ai chat sharing setting was changed for the organization. + - `type: optional "aws"` - - `current_value: boolean or null` + default: aws - Setting value immediately after this change + - `FederatedActorAzureProvider object` - - `previous_value: boolean or null` + Asserting party: the Azure subscription the organization is bound to. - Setting value immediately before this change + - `subscription_id: string` - - `type: optional "claude_ai_chat_sharing_enabled"` + - `type: optional "azure"` - default: claude_ai_chat_sharing_enabled + default: azure - - `ClaudeAiccrSharingEnabled object` + - `FederatedActorGcpProvider object` - The Claude.ai remote Claude Code session sharing setting was changed for the organization. + Asserting party: the GCP project the organization is bound to. - - `current_value: boolean or null` + - `project_number: string` - Setting value immediately after this change + - `type: optional "gcp"` - - `previous_value: boolean or null` + default: gcp - Setting value immediately before this change + - `FederatedActorOidcProvider object` - - `type: optional "claude_ai_ccr_sharing_enabled"` + Asserting party: a customer-registered OIDC federation issuer. - default: claude_ai_ccr_sharing_enabled + - `issuer: optional string or null` - - `ClaudeAiccrSupportSharingEnabled object` + The federation issuer's URL. Null when the presented credential failed verification. - The Anthropic support access setting for Claude Code sessions was changed for the organization. + - `type: optional "oidc"` - - `current_value: boolean or null` + default: oidc - Setting value immediately after this change + - `ip_address: optional string or null` - - `previous_value: boolean or null` + - `subject: optional string or null` - Setting value immediately before this change + The provider's verified identifier for the caller; its form depends on the provider. - - `type: optional "claude_ai_ccr_support_sharing_enabled"` + - `type: optional "federated_actor"` - default: claude_ai_ccr_support_sharing_enabled + default: federated_actor - - `BatchesDownloadUiVisibility object` + - `user_agent: optional string or null` - The batches download UI visibility setting was changed for the organization. + - `AttestedDeviceActor object` - - `current_value: "all" or "none" or "selected" or null` + An attested mobile device authenticated via Apple App Attest. - Setting value immediately after this change + - `external_client_id: string` - - `"all"` + - `kid_hash: string` - - `"none"` + - `ip_address: optional string or null` - - `"selected"` + - `type: optional "attested_device_actor"` - - `previous_value: "all" or "none" or "selected" or null` + default: attested_device_actor - Setting value immediately before this change + - `user_agent: optional string or null` - - `"all"` + - `id: optional string` - - `"none"` + Unique identifier for the activity e.g. 'activity_abcd1234' - - `"selected"` + - `created_at: optional string` - - `type: optional "batches_download_ui_visibility"` + When this activity occurred. - default: batches_download_ui_visibility + format: date-time - - `AllowedInviteDomains object` + - `organization_id: optional string or null` - The allowed invite domains setting was changed for the organization. + Organization ID this activity is associated with - - `current_value: array of string or null` + - `organization_uuid: optional string or null` - Setting value immediately after this change + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `previous_value: array of string or null` + - `type: optional "organization_icon_updated"` - Setting value immediately before this change + default: organization_icon_updated - - `type: optional "allowed_invite_domains"` + - `ClaudeOrganizationSettingsUpdated object` - default: allowed_invite_domains + Organization settings were updated. - - `WebSearchAPISettingsChanged object` + - `actor: object or object or object or 8 more` - The web search API setting was changed for the organization. + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - - `current_value: object or null` + - `APIActor object` - Setting value immediately after this change + - `api_key_id: string` - - `domain_filters: object or null` + - `ip_address: string` - Allowed/blocked domain filters shared by web_search and web_fetch tools. + - `user_agent: string` - - `allowed_domains: optional array of string or null` + - `type: optional "api_actor"` - - `blocked_domains: optional array of string or null` + default: api_actor - - `is_enabled: boolean` + - `UserActor object` - - `previous_value: object or null` + - `email_address: string` - Setting value immediately before this change + format: email - - `domain_filters: object or null` + - `ip_address: string` - Allowed/blocked domain filters shared by web_search and web_fetch tools. + - `user_agent: string` - - `allowed_domains: optional array of string or null` + - `user_id: string` - - `blocked_domains: optional array of string or null` + - `type: optional "user_actor"` - - `is_enabled: boolean` + default: user_actor - - `type: optional "web_search_api_settings"` + - `UnauthenticatedUserActor object` - default: web_search_api_settings + - `ip_address: string` - - `WebFetchAPISettingsChanged object` + - `user_agent: string` - The web fetch API setting was changed for the organization. + - `type: optional "unauthenticated_user_actor"` - - `current_value: object or null` + default: unauthenticated_user_actor - Setting value immediately after this change + - `unauthenticated_email_address: optional string or null` - - `domain_filters: object or null` + format: email - Allowed/blocked domain filters shared by web_search and web_fetch tools. + - `AnthropicActor object` - - `allowed_domains: optional array of string or null` + - `email_address: optional string or null` - - `blocked_domains: optional array of string or null` + format: email - - `is_enabled: boolean` + - `type: optional "anthropic_actor"` - - `previous_value: object or null` + default: anthropic_actor - Setting value immediately before this change + - `SystemActor object` - - `domain_filters: object or null` + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - Allowed/blocked domain filters shared by web_search and web_fetch tools. + - `service: optional string or null` - - `allowed_domains: optional array of string or null` + Name of the automated process that performed the action, when known. - - `blocked_domains: optional array of string or null` + - `type: optional "system_actor"` - - `is_enabled: boolean` + default: system_actor - - `type: optional "web_fetch_api_settings"` + - `AdminAPIKeyActor object` - default: web_fetch_api_settings + - `admin_api_key_id: string` - - `DefaultWorkspaceSettings object` + - `ip_address: string` - The default workspace setting was changed for the organization. + - `user_agent: string` - - `current_value: object or null` + - `type: optional "admin_api_key_actor"` - Setting value immediately after this change + default: admin_api_key_actor - - `enable_api_keys: optional boolean` + - `ServiceAccountActor object` - default: true + - `ip_address: string` - - `previous_value: object or null` + - `service_account_id: string` - Setting value immediately before this change + - `user_agent: string` - - `enable_api_keys: optional boolean` + - `type: optional "service_account_actor"` - default: true + default: service_account_actor - - `type: optional "default_workspace_settings"` + - `ScimDirectorySyncActor object` - default: default_workspace_settings + - `directory_id: string` - - `BatchesDownloadUiEnabledWorkspaceIDs object` + - `workos_event_id: string` - The batches download UI enabled workspace IDs setting was changed for the organization. + - `idp_connection_type: optional string or null` - - `current_value: array of string or null` + - `type: optional "scim_directory_sync_actor"` - Setting value immediately after this change + default: scim_directory_sync_actor - - `previous_value: array of string or null` + - `FederatedIdentityActor object` - Setting value immediately before this change + A federated external workload authenticated via a verified OIDC token. - - `type: optional "batches_download_ui_enabled_workspace_ids"` + Carries the verified issuer, subject, and audience claims from the + presented JWT. - default: batches_download_ui_enabled_workspace_ids + - `issuer: string` - - `ClaudeCodeManagedSettings object` + - `subject: string` - The organization's Claude Code managed settings were changed. + - `audience: optional array of string` - The full previous and current settings content is provided in the - `previous_value` and `current_value` fields. + - `ip_address: optional string or null` - - `current_value: optional map[unknown] or null` + - `type: optional "federated_identity_actor"` - - `current_version: optional number or null` + default: federated_identity_actor - - `previous_value: optional map[unknown] or null` + - `user_agent: optional string or null` - - `previous_version: optional number or null` + - `FederatedActor object` - - `settings_uuid: optional string or null` + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. - - `type: optional "claude_code_managed_settings"` + - `provider: object or object or object or object` - default: claude_code_managed_settings + Asserting party: the AWS account the organization is bound to. - - `AccountSessionDurationSeconds object` + - `FederatedActorAwsProvider object` - Tracks changes to the enterprise account session duration setting (in seconds). + Asserting party: the AWS account the organization is bound to. - - `current_value: number or null` + - `account_id: string` - Setting value immediately after this change + - `signed_principal: string` - - `previous_value: number or null` + The AWS-signed ARN of the IAM principal that requested the token. - Setting value immediately before this change + - `type: optional "aws"` - - `type: optional "account_session_duration_seconds"` + default: aws - default: account_session_duration_seconds + - `FederatedActorAzureProvider object` - - `VcsConnections object` + Asserting party: the Azure subscription the organization is bound to. - Tracks changes to VCS (GitHub, etc.) organization connections. + - `subscription_id: string` - - `current_value: array of object or null` + - `type: optional "azure"` - Setting value immediately after this change + default: azure - - `org_name: string` + - `FederatedActorGcpProvider object` - - `type: "github"` + Asserting party: the GCP project the organization is bound to. - Supported Version Control System providers. + - `project_number: string` - - `metadata: optional map[string] or null` + - `type: optional "gcp"` - - `org_id: optional string or null` + default: gcp - - `previous_value: array of object or null` + - `FederatedActorOidcProvider object` - Setting value immediately before this change + Asserting party: a customer-registered OIDC federation issuer. - - `org_name: string` + - `issuer: optional string or null` - - `type: "github"` + The federation issuer's URL. Null when the presented credential failed verification. - Supported Version Control System providers. + - `type: optional "oidc"` - - `metadata: optional map[string] or null` + default: oidc - - `org_id: optional string or null` + - `ip_address: optional string or null` - - `type: optional "vcs_connections"` + - `subject: optional string or null` - default: vcs_connections + The provider's verified identifier for the caller; its form depends on the provider. - - `DisabledAdminRequestTypes object` + - `type: optional "federated_actor"` - Tracks changes to which admin request types are disabled. + default: federated_actor - - `current_value: array of string or null` + - `user_agent: optional string or null` - Setting value immediately after this change + - `AttestedDeviceActor object` - - `previous_value: array of string or null` + An attested mobile device authenticated via Apple App Attest. - Setting value immediately before this change + - `external_client_id: string` - - `type: optional "disabled_admin_request_types"` + - `kid_hash: string` - default: disabled_admin_request_types + - `ip_address: optional string or null` - - `MemberUsageDashboardVisible object` + - `type: optional "attested_device_actor"` - The member usage dashboard visibility setting was changed for the organization. + default: attested_device_actor - - `current_value: boolean or null` + - `user_agent: optional string or null` + + - `updates: array of object or object or object or 84 more` + + - `Name object` + + The organization name setting was changed. + + - `current_value: optional string or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional string or null` Setting value immediately before this change - - `type: optional "member_usage_dashboard_visible"` + - `type: optional "name"` - default: member_usage_dashboard_visible + default: name - - `CodeExecutionNetworkEgressEnabled object` + - `Capabilities object` - The code execution network egress setting was changed for the organization. + The organization capabilities setting was changed. - - `current_value: boolean or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional array of string or null` Setting value immediately before this change - - `type: optional "code_execution_network_egress_enabled"` + - `type: optional "capabilities"` - default: code_execution_network_egress_enabled + default: capabilities - - `CodeExecutionDomainAllowlistChanged object` + - `RedactContent object` - The code execution domain allowlist setting was changed for the organization. + The organization content-redaction setting was changed. - - `current_value: array of string or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "code_execution_domain_allowlist_changed"` + - `type: optional "redact_content"` - default: code_execution_domain_allowlist_changed + default: redact_content - - `CodeExecutionDomainAllowlistTemplateChanged object` + - `PublicProjectsEnabled object` - The code execution domain allowlist template setting was changed for the organization. + The public projects setting was changed for the organization. - - `current_value: "custom" or "full_egress" or "package_managers" or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `"custom"` + - `previous_value: optional boolean or null` - - `"full_egress"` + Setting value immediately before this change - - `"package_managers"` + - `type: optional "public_projects_enabled"` - - `previous_value: "custom" or "full_egress" or "package_managers" or null` + default: public_projects_enabled - Setting value immediately before this change + - `WebSearchEnabled object` - - `"custom"` + The web search setting was changed. - - `"full_egress"` + - `current_value: optional boolean or null` - - `"package_managers"` + Setting value immediately after this change - - `type: optional "code_execution_domain_allowlist_template_changed"` + - `previous_value: optional boolean or null` - default: code_execution_domain_allowlist_template_changed + Setting value immediately before this change - - `ChatEnabled object` + - `type: optional "web_search_enabled"` - The chat setting was changed for the organization. + default: web_search_enabled - - `current_value: boolean or null` + - `GeolocationEnabled object` + + The geolocation setting was changed. + + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "chat_enabled"` + - `type: optional "geolocation_enabled"` - default: chat_enabled + default: geolocation_enabled - - `ClaudeCodeQuickWebSetupEnabled object` + - `EnabledSaffron object` - The Claude Code quick web setup setting was changed for the organization. + The memory setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "claude_code_quick_web_setup_enabled"` + - `type: optional "enabled_saffron"` - default: claude_code_quick_web_setup_enabled + default: enabled_saffron - - `ClaudeCodeTeamMemoryMode object` + - `DataRetentionPeriods object` - The Claude Code team memory mode setting was changed for the organization. + The data retention periods setting was changed for the organization. - - `current_value: "all_org_members" or "github_repo" or "off" or "specific_groups" or null` + - `current_value: optional array of object or null` Setting value immediately after this change - - `"all_org_members"` + - `data_type: "all" or "artifact_private" or "artifact_shared" or 2 more` - - `"github_repo"` + - `"all"` - - `"off"` + - `"artifact_private"` - - `"specific_groups"` + - `"artifact_shared"` + + - `"chat"` + + - `"project"` + + - `duration: number` + + maximum: 2147483647, minimum: -2147483648 + + - `timescale: "day" or "indefinite" or "month"` + + - `"day"` + + - `"indefinite"` + + - `"month"` - - `previous_value: "all_org_members" or "github_repo" or "off" or "specific_groups" or null` + - `previous_value: optional array of object or null` Setting value immediately before this change - - `"all_org_members"` + - `data_type: "all" or "artifact_private" or "artifact_shared" or 2 more` - - `"github_repo"` + - `"all"` - - `"off"` + - `"artifact_private"` - - `"specific_groups"` + - `"artifact_shared"` - - `type: optional "claude_code_team_memory_mode"` + - `"chat"` - default: claude_code_team_memory_mode + - `"project"` - - `BrowserExtensionSettingsUpdated object` + - `duration: number` - The browser extension setting was changed for the organization. + maximum: 2147483647, minimum: -2147483648 - - `current_value: map[unknown] or null` + - `timescale: "day" or "indefinite" or "month"` - Setting value immediately after this change + - `"day"` - - `previous_value: map[unknown] or null` + - `"indefinite"` - Setting value immediately before this change + - `"month"` - - `type: optional "browser_extension_settings"` + - `type: optional "data_retention_periods"` - default: browser_extension_settings + default: data_retention_periods - - `DesktopExtensionAllowlistEnabled object` + - `MembersLimit object` - The desktop extension allowlist setting was changed for the organization. + The members limit setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional number or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional number or null` Setting value immediately before this change - - `type: optional "is_desktop_extension_allowlist_enabled"` + - `type: optional "members_limit"` - default: is_desktop_extension_allowlist_enabled + default: members_limit - - `AllowMemberDataExport object` + - `ClaudeAPIInArtifactsEnabled object` - The per-member self-serve data export setting was changed for the organization. + The Claude API in Artifacts setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "allow_member_data_export"` + - `type: optional "claude_api_in_artifacts_enabled"` - default: allow_member_data_export + default: claude_api_in_artifacts_enabled - - `ClaudeDesignEnabled object` + - `SupportContactMode object` - The Claude Design setting was changed for the organization. + The support contact routing mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional "ai_support_only" or "human_support_restricted" or "unspecified" or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `"ai_support_only"` + + - `"human_support_restricted"` + + - `"unspecified"` + + - `previous_value: optional "ai_support_only" or "human_support_restricted" or "unspecified" or null` Setting value immediately before this change - - `type: optional "claude_ai_design_enabled"` + - `"ai_support_only"` - default: claude_ai_design_enabled + - `"human_support_restricted"` - - `ClaudeScienceEnabled object` + - `"unspecified"` - The setting that turns Claude Science on or off for the organization was changed. + - `type: optional "support_contact_mode"` - - `current_value: boolean or null` + default: support_contact_mode + + - `SupportContactAlwaysIncludeAdminsOwners object` + + The support contact always-include-admins-owners setting was changed for the organization. + + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "claude_science_enabled"` + - `type: optional "support_contact_always_include_admins_owners"` - default: claude_science_enabled + default: support_contact_always_include_admins_owners - - `ClaudeScienceMemoryEnabled object` + - `SupportContactDesignatedGroups object` - The Claude Science memory setting was changed for the organization. + The support contact designated groups setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional array of string or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional array of string or null` Setting value immediately before this change - - `type: optional "claude_science_memory_enabled"` + - `type: optional "support_contact_designated_groups"` - default: claude_science_memory_enabled + default: support_contact_designated_groups - - `ClaudeScienceCustomConnectorsEnabled object` + - `SubscriptionItemQuotas object` - The Claude Science custom connectors setting was changed for the organization. + The organization's subscription seat quotas were changed. - - `current_value: boolean or null` + - `current_value: optional map[number] or null` - Setting value immediately after this change + Seat-type to quantity mapping immediately after this change. A null quantity means the item is unlimited/unmetered. - - `previous_value: boolean or null` + - `previous_value: optional map[number] or null` - Setting value immediately before this change + Seat-type to quantity mapping immediately before this change. A null quantity means the item was unlimited/unmetered. - - `type: optional "claude_science_custom_connectors_enabled"` + - `type: optional "subscription_item_quotas"` - default: claude_science_custom_connectors_enabled + default: subscription_item_quotas - - `ClaudeScienceCustomSkillsEnabled object` + - `MembersBulkSeatTierAssignment object` - The Claude Science custom skills setting was changed for the organization. + All organization members were assigned the specified seat tier. - - `current_value: boolean or null` + - `current_value: optional string or null` + + The seat tier every member was assigned to + + - `member_count: optional number or null` + + Number of members whose seat tier was changed + + - `previous_value: optional string or null` + + Not populated; members may have held differing seat tiers before the bulk assignment + + - `type: optional "members_bulk_seat_tier_assignment"` + + default: members_bulk_seat_tier_assignment + + - `ClaudeCodeWebEnabled object` + + The Claude Code on the web setting was changed for the organization. + + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "claude_science_custom_skills_enabled"` + - `type: optional "claude_code_web_enabled"` - default: claude_science_custom_skills_enabled + default: claude_code_web_enabled - - `ClaudeScienceManagedNetworkAllowlistEnabled object` + - `ClaudeCodeDesktopBypassPermissionsEnabled object` - The Claude Science setting that puts the network allowlist under the organization's management, instead of each member managing their own, was changed for the organization. + The Claude Code Desktop bypass-permissions mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "claude_science_managed_network_allowlist_enabled"` + - `type: optional "claude_code_desktop_bypass_permissions_enabled"` - default: claude_science_managed_network_allowlist_enabled + default: claude_code_desktop_bypass_permissions_enabled - - `ClaudeScienceSSHHostsEnabled object` + - `ClaudeCodeDesktopAutoPermissionsEnabled object` - The Claude Science SSH hosts setting was changed for the organization. + The Claude Code Desktop auto-permissions mode setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "claude_science_ssh_hosts_enabled"` + - `type: optional "claude_code_desktop_auto_permissions_enabled"` - default: claude_science_ssh_hosts_enabled + default: claude_code_desktop_auto_permissions_enabled - - `ClaudeScienceModalEnabled object` + - `SkillsEnabled object` - The Claude Science setting that lets members connect Modal cloud compute was changed for the organization. + The Claude.ai skills setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "claude_science_modal_enabled"` + - `type: optional "skills_enabled"` - default: claude_science_modal_enabled + default: skills_enabled - - `ClaudeScienceScientificModelEndpointsEnabled object` + - `WorkbenchCompletionFeedbackEnabled object` - The Claude Science scientific model endpoints setting was changed for the organization. + The Workbench completion feedback setting was changed for the organization. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change - - `type: optional "claude_science_scientific_model_endpoints_enabled"` + - `type: optional "workbench_completion_feedback_enabled"` - default: claude_science_scientific_model_endpoints_enabled + default: workbench_completion_feedback_enabled - - `ClaudeScienceNetworkAllowlistChanged object` + - `ClaudeAICompletionFeedbackEnabled object` - The hostnames on the organization's Claude Science network allowlist, which applies to members while the organization manages the allowlist, were changed. + The Claude.ai completion feedback setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional boolean or null` - Setting value immediately after this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list is saved (this change reset it), so Claude Science's built-in allowlist applies; an empty list means a list with no domains on it is saved. + Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional boolean or null` - Setting value immediately before this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list was saved at that point (never saved, or since reset), so Claude Science's built-in allowlist applied; an empty list means a list with no domains on it had been saved. + Setting value immediately before this change - - `type: optional "claude_science_network_allowlist_changed"` + - `type: optional "claude_ai_completion_feedback_enabled"` - default: claude_science_network_allowlist_changed + default: claude_ai_completion_feedback_enabled - - `ClaudeScienceModalWorkspaceAllowlistChanged object` + - `ClaudeAIIntegrationSharingEnabled object` - The Claude Science Modal cloud compute workspace allowlist setting was changed for the organization. + The Claude.ai integration sharing setting was changed for the organization. - - `current_value: array of string or null` + - `current_value: optional boolean or null` - Setting value immediately after this change: the Modal workspace names members can connect to. Null or an empty list means any workspace is allowed. + Setting value immediately after this change - - `previous_value: array of string or null` + - `previous_value: optional boolean or null` - Setting value immediately before this change: the Modal workspace names members could connect to. Null or an empty list means any workspace was allowed. + Setting value immediately before this change - - `type: optional "claude_science_modal_workspace_allowlist_changed"` + - `type: optional "claude_ai_integration_sharing_enabled"` - default: claude_science_modal_workspace_allowlist_changed + default: claude_ai_integration_sharing_enabled - - `ClaudeSciencePackageMirrorCondaChannelChanged object` + - `ClaudeAIChatSharingEnabled object` - The Claude Science package mirror setting for the conda channel was changed for the organization. + The Claude.ai chat sharing setting was changed for the organization. - - `current_value: string or null` + - `current_value: optional boolean or null` - Setting value immediately after this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. + Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional boolean or null` - Setting value immediately before this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. + Setting value immediately before this change - - `type: optional "claude_science_package_mirror_conda_channel_changed"` + - `type: optional "claude_ai_chat_sharing_enabled"` - default: claude_science_package_mirror_conda_channel_changed + default: claude_ai_chat_sharing_enabled - - `ClaudeSciencePackageMirrorPipIndexChanged object` + - `ClaudeAICcrSharingEnabled object` - The Claude Science package mirror setting for the Python package index was changed for the organization. + The Claude.ai remote Claude Code session sharing setting was changed for the organization. - - `current_value: string or null` + - `current_value: optional boolean or null` - Setting value immediately after this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. + Setting value immediately after this change - - `previous_value: string or null` + - `previous_value: optional boolean or null` - Setting value immediately before this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. + Setting value immediately before this change - - `type: optional "claude_science_package_mirror_pip_index_changed"` + - `type: optional "claude_ai_ccr_sharing_enabled"` - default: claude_science_package_mirror_pip_index_changed + default: claude_ai_ccr_sharing_enabled - - `SkillPluginsScanningEnabled object` + - `ClaudeAICcrSupportSharingEnabled object` - The skill and plugin security scanning setting was changed for the organization. + The Anthropic support access setting for Claude Code sessions was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_ccr_support_sharing_enabled"` + + default: claude_ai_ccr_support_sharing_enabled + + - `BatchesDownloadUiVisibility object` + + The batches download UI visibility setting was changed for the organization. + + - `current_value: optional "all" or "none" or "selected" or "unspecified" or null` + + Setting value immediately after this change + + - `"all"` + + - `"none"` + + - `"selected"` + + - `"unspecified"` + + - `previous_value: optional "all" or "none" or "selected" or "unspecified" or null` + + Setting value immediately before this change + + - `"all"` + + - `"none"` + + - `"selected"` + + - `"unspecified"` + + - `type: optional "batches_download_ui_visibility"` + + default: batches_download_ui_visibility + + - `AllowedInviteDomains object` + + The allowed invite domains setting was changed for the organization. + + - `current_value: optional array of string or null` + + Setting value immediately after this change + + - `previous_value: optional array of string or null` + + Setting value immediately before this change + + - `type: optional "allowed_invite_domains"` + + default: allowed_invite_domains + + - `WebSearchAPISettings object` + + The web search API setting was changed for the organization. + + - `current_value: optional object or null` + + Setting value immediately after this change + + - `domain_filters: object or null` + + Allowed/blocked domain filters shared by web_search and web_fetch tools. + + - `allowed_domains: optional array of string or null` + + - `blocked_domains: optional array of string or null` + + - `is_enabled: boolean` + + - `previous_value: optional object or null` + + Setting value immediately before this change + + - `domain_filters: object or null` + + Allowed/blocked domain filters shared by web_search and web_fetch tools. + + - `allowed_domains: optional array of string or null` + + - `blocked_domains: optional array of string or null` + + - `is_enabled: boolean` + + - `type: optional "web_search_api_settings"` + + default: web_search_api_settings + + - `WebFetchAPISettings object` + + The web fetch API setting was changed for the organization. + + - `current_value: optional object or null` + + Setting value immediately after this change + + - `domain_filters: object or null` + + Allowed/blocked domain filters shared by web_search and web_fetch tools. + + - `allowed_domains: optional array of string or null` + + - `blocked_domains: optional array of string or null` + + - `is_enabled: boolean` + + - `previous_value: optional object or null` + + Setting value immediately before this change + + - `domain_filters: object or null` + + Allowed/blocked domain filters shared by web_search and web_fetch tools. + + - `allowed_domains: optional array of string or null` + + - `blocked_domains: optional array of string or null` + + - `is_enabled: boolean` + + - `type: optional "web_fetch_api_settings"` + + default: web_fetch_api_settings + + - `DefaultWorkspaceSettings object` + + The default workspace setting was changed for the organization. + + - `current_value: optional object or null` + + Setting value immediately after this change + + - `enable_api_keys: optional boolean` + + default: true + + - `previous_value: optional object or null` + + Setting value immediately before this change + + - `enable_api_keys: optional boolean` + + default: true + + - `type: optional "default_workspace_settings"` + + default: default_workspace_settings + + - `BatchesDownloadUiEnabledWorkspaceIDs object` + + The batches download UI enabled workspace IDs setting was changed for the organization. + + - `current_value: optional array of string or null` + + Setting value immediately after this change + + - `previous_value: optional array of string or null` + + Setting value immediately before this change + + - `type: optional "batches_download_ui_enabled_workspace_ids"` + + default: batches_download_ui_enabled_workspace_ids + + - `ClaudeCodeManagedSettings object` + + The organization's Claude Code managed settings were changed. + + The full previous and current settings content is provided in the + `previous_value` and `current_value` fields. + + - `current_value: optional map[unknown] or null` + + - `current_version: optional number or null` + + - `previous_value: optional map[unknown] or null` + + - `previous_version: optional number or null` + + - `settings_uuid: optional string or null` + + - `type: optional "claude_code_managed_settings"` + + default: claude_code_managed_settings + + - `AccountSessionDurationSeconds object` + + Tracks changes to the enterprise account session duration setting (in seconds). + + - `current_value: optional number or null` + + Setting value immediately after this change + + - `previous_value: optional number or null` + + Setting value immediately before this change + + - `type: optional "account_session_duration_seconds"` + + default: account_session_duration_seconds + + - `VcsConnections object` + + Tracks changes to VCS (GitHub, etc.) organization connections. + + - `current_value: optional array of object or null` + + Setting value immediately after this change + + - `org_name: string` + + - `type: "github"` + + Supported Version Control System providers. + + - `metadata: optional map[string] or null` + + - `org_id: optional string or null` + + - `previous_value: optional array of object or null` + + Setting value immediately before this change + + - `org_name: string` + + - `type: "github"` + + Supported Version Control System providers. + + - `metadata: optional map[string] or null` + + - `org_id: optional string or null` + + - `type: optional "vcs_connections"` + + default: vcs_connections + + - `DisabledAdminRequestTypes object` + + Tracks changes to which admin request types are disabled. + + - `current_value: optional array of string or null` + + Setting value immediately after this change + + - `previous_value: optional array of string or null` + + Setting value immediately before this change + + - `type: optional "disabled_admin_request_types"` + + default: disabled_admin_request_types + + - `MemberUsageDashboardVisible object` + + The member usage dashboard visibility setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "member_usage_dashboard_visible"` + + default: member_usage_dashboard_visible + + - `CodeExecutionNetworkEgressEnabled object` + + The code execution network egress setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "code_execution_network_egress_enabled"` + + default: code_execution_network_egress_enabled + + - `CodeExecutionDomainAllowlistChanged object` + + The code execution domain allowlist setting was changed for the organization. + + - `current_value: optional array of string or null` + + Setting value immediately after this change + + - `previous_value: optional array of string or null` + + Setting value immediately before this change + + - `type: optional "code_execution_domain_allowlist_changed"` + + default: code_execution_domain_allowlist_changed + + - `CodeExecutionDomainAllowlistTemplateChanged object` + + The code execution domain allowlist template setting was changed for the organization. + + - `current_value: optional "custom" or "full_egress" or "package_managers" or "unspecified" or null` + + Setting value immediately after this change + + - `"custom"` + + - `"full_egress"` + + - `"package_managers"` + + - `"unspecified"` + + - `previous_value: optional "custom" or "full_egress" or "package_managers" or "unspecified" or null` + + Setting value immediately before this change + + - `"custom"` + + - `"full_egress"` + + - `"package_managers"` + + - `"unspecified"` + + - `type: optional "code_execution_domain_allowlist_template_changed"` + + default: code_execution_domain_allowlist_template_changed + + - `ChatEnabled object` + + The chat setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "chat_enabled"` + + default: chat_enabled + + - `ClaudeCodeQuickWebSetupEnabled object` + + The Claude Code quick web setup setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_quick_web_setup_enabled"` + + default: claude_code_quick_web_setup_enabled + + - `ClaudeCodeTeamMemoryMode object` + + The Claude Code team memory mode setting was changed for the organization. + + - `current_value: optional "all_org_members" or "github_repo" or "off" or 2 more or null` + + Setting value immediately after this change + + - `"all_org_members"` + + - `"github_repo"` + + - `"off"` + + - `"specific_groups"` + + - `"unspecified"` + + - `previous_value: optional "all_org_members" or "github_repo" or "off" or 2 more or null` + + Setting value immediately before this change + + - `"all_org_members"` + + - `"github_repo"` + + - `"off"` + + - `"specific_groups"` + + - `"unspecified"` + + - `type: optional "claude_code_team_memory_mode"` + + default: claude_code_team_memory_mode + + - `BrowserExtensionSettings object` + + The browser extension setting was changed for the organization. + + - `current_value: optional map[unknown] or null` + + Setting value immediately after this change + + - `previous_value: optional map[unknown] or null` + + Setting value immediately before this change + + - `type: optional "browser_extension_settings"` + + default: browser_extension_settings + + - `IsDesktopExtensionAllowlistEnabled object` + + The desktop extension allowlist setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "is_desktop_extension_allowlist_enabled"` + + default: is_desktop_extension_allowlist_enabled + + - `AllowMemberDataExport object` + + The per-member self-serve data export setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "allow_member_data_export"` + + default: allow_member_data_export + + - `ClaudeAIDesignEnabled object` + + The Claude Design setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_design_enabled"` + + default: claude_ai_design_enabled + + - `ClaudeScienceEnabled object` + + The setting that turns Claude Science on or off for the organization was changed. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_science_enabled"` + + default: claude_science_enabled + + - `ClaudeScienceMemoryEnabled object` + + The Claude Science memory setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_science_memory_enabled"` + + default: claude_science_memory_enabled + + - `ClaudeScienceCustomConnectorsEnabled object` + + The Claude Science custom connectors setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_science_custom_connectors_enabled"` + + default: claude_science_custom_connectors_enabled + + - `ClaudeScienceCustomSkillsEnabled object` + + The Claude Science custom skills setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_science_custom_skills_enabled"` + + default: claude_science_custom_skills_enabled + + - `ClaudeScienceManagedNetworkAllowlistEnabled object` + + The Claude Science setting that puts the network allowlist under the organization's management, instead of each member managing their own, was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_science_managed_network_allowlist_enabled"` + + default: claude_science_managed_network_allowlist_enabled + + - `ClaudeScienceSSHHostsEnabled object` + + The Claude Science SSH hosts setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_science_ssh_hosts_enabled"` + + default: claude_science_ssh_hosts_enabled + + - `ClaudeScienceModalEnabled object` + + The Claude Science setting that lets members connect Modal cloud compute was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_science_modal_enabled"` + + default: claude_science_modal_enabled + + - `ClaudeScienceScientificModelEndpointsEnabled object` + + The Claude Science scientific model endpoints setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_science_scientific_model_endpoints_enabled"` + + default: claude_science_scientific_model_endpoints_enabled + + - `ClaudeScienceNetworkAllowlistChanged object` + + The hostnames on the organization's Claude Science network allowlist, which applies to members while the organization manages the allowlist, were changed. + + - `current_value: optional array of string or null` + + Setting value immediately after this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list is saved (this change reset it), so Claude Science's built-in allowlist applies; an empty list means a list with no domains on it is saved. + + - `previous_value: optional array of string or null` + + Setting value immediately before this change: the organization's complete saved allowlist (built-in and custom domains alike) as lowercase hostnames, each optionally prefixed with '*.'. Null means no list was saved at that point (never saved, or since reset), so Claude Science's built-in allowlist applied; an empty list means a list with no domains on it had been saved. + + - `type: optional "claude_science_network_allowlist_changed"` + + default: claude_science_network_allowlist_changed + + - `ClaudeScienceModalWorkspaceAllowlistChanged object` + + The Claude Science Modal cloud compute workspace allowlist setting was changed for the organization. + + - `current_value: optional array of string or null` + + Setting value immediately after this change: the Modal workspace names members can connect to. Null or an empty list means any workspace is allowed. + + - `previous_value: optional array of string or null` + + Setting value immediately before this change: the Modal workspace names members could connect to. Null or an empty list means any workspace was allowed. + + - `type: optional "claude_science_modal_workspace_allowlist_changed"` + + default: claude_science_modal_workspace_allowlist_changed + + - `ClaudeSciencePackageMirrorCondaChannelChanged object` + + The Claude Science package mirror setting for the conda channel was changed for the organization. + + - `current_value: optional string or null` + + Setting value immediately after this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. + + - `previous_value: optional string or null` + + Setting value immediately before this change: the HTTPS URL of the organization's conda channel mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. + + - `type: optional "claude_science_package_mirror_conda_channel_changed"` + + default: claude_science_package_mirror_conda_channel_changed + + - `ClaudeSciencePackageMirrorPipIndexChanged object` + + The Claude Science package mirror setting for the Python package index was changed for the organization. + + - `current_value: optional string or null` + + Setting value immediately after this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none is set. + + - `previous_value: optional string or null` + + Setting value immediately before this change: the HTTPS URL of the organization's Python (pip) package index mirror, as saved (scheme, host, any non-default port, and path; the setting does not accept a username or password, a query string or a fragment in the URL). Null means none was set. + + - `type: optional "claude_science_package_mirror_pip_index_changed"` + + default: claude_science_package_mirror_pip_index_changed + + - `ClaudeAISkillPluginsScanningEnabled object` + + The skill and plugin security scanning setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_plugins_scanning_enabled"` + + default: claude_ai_skill_plugins_scanning_enabled + + - `ArtifactPublishingEnabled object` + + The Artifact publishing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "artifact_publishing_enabled"` + + default: artifact_publishing_enabled + + - `ArtifactExternalSharingEnabled object` + + The Artifact external sharing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "artifact_external_sharing_enabled"` + + default: artifact_external_sharing_enabled + + - `ArtifactPresenceEnabled object` + + The Artifact presence setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "artifact_presence_enabled"` + + default: artifact_presence_enabled + + - `ClaudeAISkillSharingEnabled object` + + The Claude.ai skill sharing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_sharing_enabled"` + + default: claude_ai_skill_sharing_enabled + + - `ClaudeAISkillSharingOrgEnabled object` + + The Claude.ai organization-wide skill sharing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_sharing_org_enabled"` + + default: claude_ai_skill_sharing_org_enabled + + - `ClaudeAISkillSharingGroupEnabled object` + + The Claude.ai group-based skill sharing setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_sharing_group_enabled"` + + default: claude_ai_skill_sharing_group_enabled + + - `ClaudeAISkillPublishPolicy object` + + The Claude.ai organization skill publish policy was changed for the organization. + + - `current_value: optional "off" or "open" or "review" or "unspecified" or null` + + Setting value immediately after this change + + - `"off"` + + - `"open"` + + - `"review"` + + - `"unspecified"` + + - `previous_value: optional "off" or "open" or "review" or "unspecified" or null` + + Setting value immediately before this change + + - `"off"` + + - `"open"` + + - `"review"` + + - `"unspecified"` + + - `type: optional "claude_ai_skill_publish_policy"` + + default: claude_ai_skill_publish_policy + + - `ClaudeCodeRemoteControlEnabled object` + + The Claude Code remote control setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_remote_control_enabled"` + + default: claude_code_remote_control_enabled + + - `ClaudeCodeRemoteControlDefaultEnabled object` + + The Claude Code remote control auto-enable default was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_remote_control_default_enabled"` + + default: claude_code_remote_control_default_enabled + + - `ClaudeCodeRoutinesEnabled object` + + The Claude Code routines setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_routines_enabled"` + + default: claude_code_routines_enabled + + - `ClaudeCodeWorkflowsEnabled object` + + The Claude Code Workflows setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_workflows_enabled"` + + default: claude_code_workflows_enabled + + - `FrontierServicesDataUseEnabled object` + + The frontier services data use setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "frontier_services_data_use_enabled"` + + default: frontier_services_data_use_enabled + + - `LtiCourseProjectsEnabled object` + + The LTI course projects setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "lti_course_projects_enabled"` + + default: lti_course_projects_enabled + + - `ClaudeAISkillCreationEnabled object` + + The Claude.ai skill creation setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_ai_skill_creation_enabled"` + + default: claude_ai_skill_creation_enabled + + - `ClaudeCodeGitHubAnalyticsEnabled object` + + The Claude Code GitHub analytics setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_github_analytics_enabled"` + + default: claude_code_github_analytics_enabled + + - `ClaudeCodeHideManagedEnvironments object` + + The Claude Code hide managed environments setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_hide_managed_environments"` + + default: claude_code_hide_managed_environments + + - `ClaudeCodeAllowSessionPoolMoves object` + + The Claude Code allow session pool moves setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_allow_session_pool_moves"` + + default: claude_code_allow_session_pool_moves + + - `ClaudeCodeDisableAnthropicCompute object` + + The Claude Code disable Anthropic compute setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_disable_anthropic_compute"` + + default: claude_code_disable_anthropic_compute + + - `ClaudeCodeMetricsLoggingEnabled object` + + The Claude Code metrics logging setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_metrics_logging_enabled"` + + default: claude_code_metrics_logging_enabled + + - `ClaudeCodeFastModeEnabled object` + + The Claude Code fast mode setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_fast_mode_enabled"` + + default: claude_code_fast_mode_enabled + + - `ClaudeCodeTrustedDevicesRequired object` + + The Claude Code trusted devices setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "claude_code_trusted_devices_required"` + + default: claude_code_trusted_devices_required + + - `CoworkTrustedDevicesRequired object` + + The Cowork trusted devices enforcement setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "cowork_trusted_devices_required"` + + default: cowork_trusted_devices_required + + - `InlineVisualizationsEnabled object` + + The inline visualizations setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "inline_visualizations_enabled"` + + default: inline_visualizations_enabled + + - `OrganizationBannerSettings object` + + The organization banner setting was changed. + + - `current_value: optional map[unknown] or null` + + Setting value immediately after this change + + - `previous_value: optional map[unknown] or null` + + Setting value immediately before this change + + - `type: optional "organization_banner_settings"` + + default: organization_banner_settings + + - `ClaudeInSlackSettings object` + + The Claude in Slack setting was changed for the organization. + + - `current_value: optional map[unknown] or null` + + Setting value immediately after this change + + - `previous_value: optional map[unknown] or null` + + Setting value immediately before this change + + - `type: optional "claude_in_slack_settings"` + + default: claude_in_slack_settings + + - `ClaudeCodeDefaultWorkerEnvironmentID object` + + The Claude Code default worker environment setting was changed for the organization. + + - `current_value: optional string or null` + + Setting value immediately after this change + + - `previous_value: optional string or null` + + Setting value immediately before this change + + - `type: optional "claude_code_default_worker_environment_id"` + + default: claude_code_default_worker_environment_id + + - `ClaudeCodeDefaultWorkerPoolID object` + + The Claude Code default worker pool setting was changed for the organization. + + - `current_value: optional string or null` + + Setting value immediately after this change + + - `previous_value: optional string or null` + + Setting value immediately before this change + + - `type: optional "claude_code_default_worker_pool_id"` + + default: claude_code_default_worker_pool_id + + - `ManagedAgentsEnabled object` + + The managed agents setting was changed for the organization. + + - `current_value: optional boolean or null` + + Setting value immediately after this change + + - `previous_value: optional boolean or null` + + Setting value immediately before this change + + - `type: optional "managed_agents_enabled"` + + default: managed_agents_enabled + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time + + - `organization_id: optional string or null` + + Organization ID this activity is associated with + + - `organization_uuid: optional string or null` + + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). + + - `type: optional "claude_organization_settings_updated"` + + default: claude_organization_settings_updated + + - `OwnedProjectsAccessRestored object` + + Access to owned projects was restored. + + - `actor: object or object or object or 8 more` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `APIActor object` + + - `api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "api_actor"` + + default: api_actor + + - `UserActor object` + + - `email_address: string` + + format: email + + - `ip_address: string` + + - `user_agent: string` + + - `user_id: string` + + - `type: optional "user_actor"` + + default: user_actor + + - `UnauthenticatedUserActor object` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "unauthenticated_user_actor"` + + default: unauthenticated_user_actor + + - `unauthenticated_email_address: optional string or null` + + format: email + + - `AnthropicActor object` + + - `email_address: optional string or null` + + format: email + + - `type: optional "anthropic_actor"` + + default: anthropic_actor + + - `SystemActor object` + + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. + + - `service: optional string or null` + + Name of the automated process that performed the action, when known. + + - `type: optional "system_actor"` + + default: system_actor + + - `AdminAPIKeyActor object` + + - `admin_api_key_id: string` + + - `ip_address: string` + + - `user_agent: string` + + - `type: optional "admin_api_key_actor"` + + default: admin_api_key_actor + + - `ServiceAccountActor object` + + - `ip_address: string` + + - `service_account_id: string` + + - `user_agent: string` + + - `type: optional "service_account_actor"` + + default: service_account_actor + + - `ScimDirectorySyncActor object` + + - `directory_id: string` + + - `workos_event_id: string` + + - `idp_connection_type: optional string or null` + + - `type: optional "scim_directory_sync_actor"` + + default: scim_directory_sync_actor + + - `FederatedIdentityActor object` + + A federated external workload authenticated via a verified OIDC token. + + Carries the verified issuer, subject, and audience claims from the + presented JWT. + + - `issuer: string` + + - `subject: string` + + - `audience: optional array of string` + + - `ip_address: optional string or null` + + - `type: optional "federated_identity_actor"` + + default: federated_identity_actor + + - `user_agent: optional string or null` + + - `FederatedActor object` + + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. + + - `provider: object or object or object or object` + + Asserting party: the AWS account the organization is bound to. + + - `FederatedActorAwsProvider object` + + Asserting party: the AWS account the organization is bound to. + + - `account_id: string` + + - `signed_principal: string` + + The AWS-signed ARN of the IAM principal that requested the token. + + - `type: optional "aws"` + + default: aws + + - `FederatedActorAzureProvider object` + + Asserting party: the Azure subscription the organization is bound to. + + - `subscription_id: string` + + - `type: optional "azure"` + + default: azure + + - `FederatedActorGcpProvider object` + + Asserting party: the GCP project the organization is bound to. + + - `project_number: string` + + - `type: optional "gcp"` + + default: gcp + + - `FederatedActorOidcProvider object` + + Asserting party: a customer-registered OIDC federation issuer. + + - `issuer: optional string or null` + + The federation issuer's URL. Null when the presented credential failed verification. + + - `type: optional "oidc"` + + default: oidc + + - `ip_address: optional string or null` + + - `subject: optional string or null` + + The provider's verified identifier for the caller; its form depends on the provider. + + - `type: optional "federated_actor"` + + default: federated_actor + + - `user_agent: optional string or null` + + - `AttestedDeviceActor object` + + An attested mobile device authenticated via Apple App Attest. + + - `external_client_id: string` + + - `kid_hash: string` + + - `ip_address: optional string or null` + + - `type: optional "attested_device_actor"` + + default: attested_device_actor + + - `user_agent: optional string or null` + + - `id: optional string` + + Unique identifier for the activity e.g. 'activity_abcd1234' + + - `created_at: optional string` + + When this activity occurred. + + format: date-time - - `current_value: boolean or null` + - `organization_id: optional string or null` - Setting value immediately after this change + Organization ID this activity is associated with - - `previous_value: boolean or null` + - `organization_uuid: optional string or null` - Setting value immediately before this change + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_ai_skill_plugins_scanning_enabled"` + - `type: optional "owned_projects_access_restored"` - default: claude_ai_skill_plugins_scanning_enabled + default: owned_projects_access_restored - - `ArtifactPublishingEnabled object` + - `user_id: optional string or null` - The Artifact publishing setting was changed for the organization. + - `PaymentMethodUpdated object` - - `current_value: boolean or null` + The organization's default payment method was updated. - Setting value immediately after this change + - `actor: object or object or object or 8 more` - - `previous_value: boolean or null` + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - Setting value immediately before this change + - `APIActor object` - - `type: optional "artifact_publishing_enabled"` + - `api_key_id: string` - default: artifact_publishing_enabled + - `ip_address: string` - - `ArtifactExternalSharingEnabled object` + - `user_agent: string` - The Artifact external sharing setting was changed for the organization. + - `type: optional "api_actor"` - - `current_value: boolean or null` + default: api_actor - Setting value immediately after this change + - `UserActor object` - - `previous_value: boolean or null` + - `email_address: string` - Setting value immediately before this change + format: email - - `type: optional "artifact_external_sharing_enabled"` + - `ip_address: string` - default: artifact_external_sharing_enabled + - `user_agent: string` - - `ArtifactPresenceEnabled object` + - `user_id: string` - The Artifact presence setting was changed for the organization. + - `type: optional "user_actor"` - - `current_value: boolean or null` + default: user_actor - Setting value immediately after this change + - `UnauthenticatedUserActor object` - - `previous_value: boolean or null` + - `ip_address: string` - Setting value immediately before this change + - `user_agent: string` - - `type: optional "artifact_presence_enabled"` + - `type: optional "unauthenticated_user_actor"` - default: artifact_presence_enabled + default: unauthenticated_user_actor - - `ClaudeAISkillSharingEnabled object` + - `unauthenticated_email_address: optional string or null` - The Claude.ai skill sharing setting was changed for the organization. + format: email - - `current_value: boolean or null` + - `AnthropicActor object` - Setting value immediately after this change + - `email_address: optional string or null` - - `previous_value: boolean or null` + format: email - Setting value immediately before this change + - `type: optional "anthropic_actor"` - - `type: optional "claude_ai_skill_sharing_enabled"` + default: anthropic_actor - default: claude_ai_skill_sharing_enabled + - `SystemActor object` - - `ClaudeAISkillSharingOrgEnabled object` + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - The Claude.ai organization-wide skill sharing setting was changed for the organization. + - `service: optional string or null` - - `current_value: boolean or null` + Name of the automated process that performed the action, when known. - Setting value immediately after this change + - `type: optional "system_actor"` - - `previous_value: boolean or null` + default: system_actor - Setting value immediately before this change + - `AdminAPIKeyActor object` - - `type: optional "claude_ai_skill_sharing_org_enabled"` + - `admin_api_key_id: string` - default: claude_ai_skill_sharing_org_enabled + - `ip_address: string` - - `ClaudeAISkillSharingGroupEnabled object` + - `user_agent: string` - The Claude.ai group-based skill sharing setting was changed for the organization. + - `type: optional "admin_api_key_actor"` - - `current_value: boolean or null` + default: admin_api_key_actor - Setting value immediately after this change + - `ServiceAccountActor object` - - `previous_value: boolean or null` + - `ip_address: string` - Setting value immediately before this change + - `service_account_id: string` - - `type: optional "claude_ai_skill_sharing_group_enabled"` + - `user_agent: string` - default: claude_ai_skill_sharing_group_enabled + - `type: optional "service_account_actor"` - - `ClaudeAISkillPublishPolicy object` + default: service_account_actor - The Claude.ai organization skill publish policy was changed for the organization. + - `ScimDirectorySyncActor object` - - `current_value: "off" or "open" or "review" or null` + - `directory_id: string` - Setting value immediately after this change + - `workos_event_id: string` - - `"off"` + - `idp_connection_type: optional string or null` - - `"open"` + - `type: optional "scim_directory_sync_actor"` - - `"review"` + default: scim_directory_sync_actor - - `previous_value: "off" or "open" or "review" or null` + - `FederatedIdentityActor object` - Setting value immediately before this change + A federated external workload authenticated via a verified OIDC token. - - `"off"` + Carries the verified issuer, subject, and audience claims from the + presented JWT. - - `"open"` + - `issuer: string` - - `"review"` + - `subject: string` - - `type: optional "claude_ai_skill_publish_policy"` + - `audience: optional array of string` - default: claude_ai_skill_publish_policy + - `ip_address: optional string or null` - - `ClaudeCodeRemoteControlEnabled object` + - `type: optional "federated_identity_actor"` - The Claude Code remote control setting was changed for the organization. + default: federated_identity_actor - - `current_value: boolean or null` + - `user_agent: optional string or null` - Setting value immediately after this change + - `FederatedActor object` - - `previous_value: boolean or null` + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. - Setting value immediately before this change + - `provider: object or object or object or object` - - `type: optional "claude_code_remote_control_enabled"` + Asserting party: the AWS account the organization is bound to. - default: claude_code_remote_control_enabled + - `FederatedActorAwsProvider object` - - `ClaudeCodeRemoteControlDefaultEnabled object` + Asserting party: the AWS account the organization is bound to. - The Claude Code remote control auto-enable default was changed for the organization. + - `account_id: string` - - `current_value: boolean or null` + - `signed_principal: string` - Setting value immediately after this change + The AWS-signed ARN of the IAM principal that requested the token. - - `previous_value: boolean or null` + - `type: optional "aws"` - Setting value immediately before this change + default: aws - - `type: optional "claude_code_remote_control_default_enabled"` + - `FederatedActorAzureProvider object` - default: claude_code_remote_control_default_enabled + Asserting party: the Azure subscription the organization is bound to. - - `ClaudeCodeRoutinesEnabled object` + - `subscription_id: string` - The Claude Code routines setting was changed for the organization. + - `type: optional "azure"` - - `current_value: boolean or null` + default: azure - Setting value immediately after this change + - `FederatedActorGcpProvider object` - - `previous_value: boolean or null` + Asserting party: the GCP project the organization is bound to. - Setting value immediately before this change + - `project_number: string` - - `type: optional "claude_code_routines_enabled"` + - `type: optional "gcp"` - default: claude_code_routines_enabled + default: gcp - - `ClaudeCodeWorkflowsEnabled object` + - `FederatedActorOidcProvider object` - The Claude Code Workflows setting was changed for the organization. + Asserting party: a customer-registered OIDC federation issuer. - - `current_value: boolean or null` + - `issuer: optional string or null` - Setting value immediately after this change + The federation issuer's URL. Null when the presented credential failed verification. - - `previous_value: boolean or null` + - `type: optional "oidc"` - Setting value immediately before this change + default: oidc - - `type: optional "claude_code_workflows_enabled"` + - `ip_address: optional string or null` - default: claude_code_workflows_enabled + - `subject: optional string or null` - - `FrontierServicesDataUseEnabled object` + The provider's verified identifier for the caller; its form depends on the provider. - The frontier services data use setting was changed for the organization. + - `type: optional "federated_actor"` - - `current_value: boolean or null` + default: federated_actor - Setting value immediately after this change + - `user_agent: optional string or null` - - `previous_value: boolean or null` + - `AttestedDeviceActor object` - Setting value immediately before this change + An attested mobile device authenticated via Apple App Attest. - - `type: optional "frontier_services_data_use_enabled"` + - `external_client_id: string` - default: frontier_services_data_use_enabled + - `kid_hash: string` - - `LtiCourseProjectsEnabled object` + - `ip_address: optional string or null` - The LTI course projects setting was changed for the organization. + - `type: optional "attested_device_actor"` - - `current_value: boolean or null` + default: attested_device_actor - Setting value immediately after this change + - `user_agent: optional string or null` - - `previous_value: boolean or null` + - `id: optional string` - Setting value immediately before this change + Unique identifier for the activity e.g. 'activity_abcd1234' - - `type: optional "lti_course_projects_enabled"` + - `created_at: optional string` - default: lti_course_projects_enabled + When this activity occurred. - - `ClaudeAISkillCreationEnabled object` + format: date-time - The Claude.ai skill creation setting was changed for the organization. + - `organization_id: optional string or null` - - `current_value: boolean or null` + Organization ID this activity is associated with - Setting value immediately after this change + - `organization_uuid: optional string or null` - - `previous_value: boolean or null` + Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - Setting value immediately before this change + - `type: optional "payment_method_updated"` - - `type: optional "claude_ai_skill_creation_enabled"` + default: payment_method_updated - default: claude_ai_skill_creation_enabled + - `PendingShareCreated object` - - `ClaudeCodeGitHubAnalyticsEnabled object` + A pending share of a project or skill was created for an email address that is not yet an organization member. - The Claude Code GitHub analytics setting was changed for the organization. + - `actor: object or object or object or 8 more` - - `current_value: boolean or null` + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - Setting value immediately after this change + - `APIActor object` - - `previous_value: boolean or null` + - `api_key_id: string` - Setting value immediately before this change + - `ip_address: string` - - `type: optional "claude_code_github_analytics_enabled"` + - `user_agent: string` - default: claude_code_github_analytics_enabled + - `type: optional "api_actor"` - - `ClaudeCodeHideManagedEnvironments object` + default: api_actor - The Claude Code hide managed environments setting was changed for the organization. + - `UserActor object` - - `current_value: boolean or null` + - `email_address: string` - Setting value immediately after this change + format: email - - `previous_value: boolean or null` + - `ip_address: string` - Setting value immediately before this change + - `user_agent: string` - - `type: optional "claude_code_hide_managed_environments"` + - `user_id: string` - default: claude_code_hide_managed_environments + - `type: optional "user_actor"` - - `ClaudeCodeAllowSessionPoolMoves object` + default: user_actor - The Claude Code allow session pool moves setting was changed for the organization. + - `UnauthenticatedUserActor object` - - `current_value: boolean or null` + - `ip_address: string` - Setting value immediately after this change + - `user_agent: string` - - `previous_value: boolean or null` + - `type: optional "unauthenticated_user_actor"` - Setting value immediately before this change + default: unauthenticated_user_actor - - `type: optional "claude_code_allow_session_pool_moves"` + - `unauthenticated_email_address: optional string or null` - default: claude_code_allow_session_pool_moves + format: email - - `ClaudeCodeDisableAnthropicCompute object` + - `AnthropicActor object` - The Claude Code disable Anthropic compute setting was changed for the organization. + - `email_address: optional string or null` - - `current_value: boolean or null` + format: email - Setting value immediately after this change + - `type: optional "anthropic_actor"` - - `previous_value: boolean or null` + default: anthropic_actor - Setting value immediately before this change + - `SystemActor object` - - `type: optional "claude_code_disable_anthropic_compute"` + Automated background processing performed by Anthropic systems, acting + without a user or customer credential. - default: claude_code_disable_anthropic_compute + - `service: optional string or null` - - `ClaudeCodeMetricsLoggingEnabled object` + Name of the automated process that performed the action, when known. - The Claude Code metrics logging setting was changed for the organization. + - `type: optional "system_actor"` - - `current_value: boolean or null` + default: system_actor - Setting value immediately after this change + - `AdminAPIKeyActor object` - - `previous_value: boolean or null` + - `admin_api_key_id: string` - Setting value immediately before this change + - `ip_address: string` - - `type: optional "claude_code_metrics_logging_enabled"` + - `user_agent: string` - default: claude_code_metrics_logging_enabled + - `type: optional "admin_api_key_actor"` - - `ClaudeCodeFastModeEnabled object` + default: admin_api_key_actor - The Claude Code fast mode setting was changed for the organization. + - `ServiceAccountActor object` - - `current_value: boolean or null` + - `ip_address: string` - Setting value immediately after this change + - `service_account_id: string` - - `previous_value: boolean or null` + - `user_agent: string` - Setting value immediately before this change + - `type: optional "service_account_actor"` - - `type: optional "claude_code_fast_mode_enabled"` + default: service_account_actor - default: claude_code_fast_mode_enabled + - `ScimDirectorySyncActor object` - - `ClaudeCodeTrustedDevicesRequired object` + - `directory_id: string` - The Claude Code trusted devices setting was changed for the organization. + - `workos_event_id: string` - - `current_value: boolean or null` + - `idp_connection_type: optional string or null` - Setting value immediately after this change + - `type: optional "scim_directory_sync_actor"` - - `previous_value: boolean or null` + default: scim_directory_sync_actor - Setting value immediately before this change + - `FederatedIdentityActor object` - - `type: optional "claude_code_trusted_devices_required"` + A federated external workload authenticated via a verified OIDC token. - default: claude_code_trusted_devices_required + Carries the verified issuer, subject, and audience claims from the + presented JWT. - - `CoworkTrustedDevicesRequired object` + - `issuer: string` - The Cowork trusted devices enforcement setting was changed for the organization. + - `subject: string` - - `current_value: boolean or null` + - `audience: optional array of string` - Setting value immediately after this change + - `ip_address: optional string or null` - - `previous_value: boolean or null` + - `type: optional "federated_identity_actor"` - Setting value immediately before this change + default: federated_identity_actor - - `type: optional "cowork_trusted_devices_required"` + - `user_agent: optional string or null` - default: cowork_trusted_devices_required + - `FederatedActor object` - - `InlineVisualizationsEnabled object` + An external identity asserted by a trusted provider — a cloud-provider + gateway or a customer-registered federation issuer — acting without an + Anthropic-provisioned account or service account. - The inline visualizations setting was changed for the organization. + - `provider: object or object or object or object` - - `current_value: boolean or null` + Asserting party: the AWS account the organization is bound to. - Setting value immediately after this change + - `FederatedActorAwsProvider object` - - `previous_value: boolean or null` + Asserting party: the AWS account the organization is bound to. - Setting value immediately before this change + - `account_id: string` - - `type: optional "inline_visualizations_enabled"` + - `signed_principal: string` - default: inline_visualizations_enabled + The AWS-signed ARN of the IAM principal that requested the token. - - `OrganizationBannerSettingsUpdated object` + - `type: optional "aws"` - The organization banner setting was changed. + default: aws - - `current_value: map[unknown] or null` + - `FederatedActorAzureProvider object` - Setting value immediately after this change + Asserting party: the Azure subscription the organization is bound to. - - `previous_value: map[unknown] or null` + - `subscription_id: string` - Setting value immediately before this change + - `type: optional "azure"` - - `type: optional "organization_banner_settings"` + default: azure - default: organization_banner_settings + - `FederatedActorGcpProvider object` - - `ClaudeInSlackSettingsUpdated object` + Asserting party: the GCP project the organization is bound to. - The Claude in Slack setting was changed for the organization. + - `project_number: string` - - `current_value: map[unknown] or null` + - `type: optional "gcp"` - Setting value immediately after this change + default: gcp - - `previous_value: map[unknown] or null` + - `FederatedActorOidcProvider object` - Setting value immediately before this change + Asserting party: a customer-registered OIDC federation issuer. - - `type: optional "claude_in_slack_settings"` + - `issuer: optional string or null` - default: claude_in_slack_settings + The federation issuer's URL. Null when the presented credential failed verification. - - `ClaudeCodeDefaultWorkerEnvironmentID object` + - `type: optional "oidc"` - The Claude Code default worker environment setting was changed for the organization. + default: oidc - - `current_value: string or null` + - `ip_address: optional string or null` - Setting value immediately after this change + - `subject: optional string or null` - - `previous_value: string or null` + The provider's verified identifier for the caller; its form depends on the provider. - Setting value immediately before this change + - `type: optional "federated_actor"` - - `type: optional "claude_code_default_worker_environment_id"` + default: federated_actor - default: claude_code_default_worker_environment_id + - `user_agent: optional string or null` - - `ClaudeCodeDefaultWorkerPoolID object` + - `AttestedDeviceActor object` - The Claude Code default worker pool setting was changed for the organization. + An attested mobile device authenticated via Apple App Attest. - - `current_value: string or null` + - `external_client_id: string` - Setting value immediately after this change + - `kid_hash: string` - - `previous_value: string or null` + - `ip_address: optional string or null` - Setting value immediately before this change + - `type: optional "attested_device_actor"` - - `type: optional "claude_code_default_worker_pool_id"` + default: attested_device_actor - default: claude_code_default_worker_pool_id + - `user_agent: optional string or null` - - `ManagedAgentsEnabled object` + - `invitee_email: string` - The managed agents setting was changed for the organization. + Email address the share was created for. - - `current_value: boolean or null` + - `resource_id: string` - Setting value immediately after this change + Tagged ID of the resource being shared. - - `previous_value: boolean or null` + - `resource_type: string` - Setting value immediately before this change + The type of resource being shared. - - `type: optional "managed_agents_enabled"` + - `role: string` - default: managed_agents_enabled + The role that will be granted when the invitee joins the organization. - `id: optional string` @@ -78135,13 +79721,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "claude_organization_settings_updated"` + - `type: optional "pending_share_created"` - default: claude_organization_settings_updated + default: pending_share_created - - `OwnedProjectsAccessRestored object` + - `PendingShareRevoked object` - Access to owned projects was restored. + A pending share of a project or skill was revoked before the invitee joined the organization. - `actor: object or object or object or 8 more` @@ -78354,6 +79940,18 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `invitee_email: string` + + Email address the share had been created for. + + - `resource_id: string` + + Tagged ID of the resource that was shared. + + - `resource_type: string` + + The type of resource that was shared. + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -78372,15 +79970,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "owned_projects_access_restored"` - - default: owned_projects_access_restored + - `type: optional "pending_share_revoked"` - - `user_id: optional string or null` + default: pending_share_revoked - - `PaymentMethodUpdated object` + - `PhoneCodeSent object` - The organization's default payment method was updated. + User requested a phone verification code. - `actor: object or object or object or 8 more` @@ -78611,13 +80207,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "payment_method_updated"` + - `type: optional "phone_code_sent"` - default: payment_method_updated + default: phone_code_sent - - `PendingShareCreated object` + - `PhoneCodeVerified object` - A pending share of a project or skill was created for an email address that is not yet an organization member. + User successfully verified their phone code. - `actor: object or object or object or 8 more` @@ -78830,22 +80426,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` - - Email address the share was created for. - - - `resource_id: string` - - Tagged ID of the resource being shared. - - - `resource_type: string` - - The type of resource being shared. - - - `role: string` - - The role that will be granted when the invitee joins the organization. - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -78864,13 +80444,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "pending_share_created"` + - `type: optional "phone_code_verified"` - default: pending_share_created + default: phone_code_verified - - `PendingShareRevoked object` + - `PlatformAgentArchived object` - A pending share of a project or skill was revoked before the invitee joined the organization. + An agent was archived on the API platform. - `actor: object or object or object or 8 more` @@ -79083,17 +80663,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `invitee_email: string` - - Email address the share had been created for. - - - `resource_id: string` - - Tagged ID of the resource that was shared. - - - `resource_type: string` + - `agent_id: string` - The type of resource that was shared. + The agent that was archived, e.g. "agent_01HX...". - `id: optional string` @@ -79113,13 +80685,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "pending_share_revoked"` + - `type: optional "platform_agent_archived"` - default: pending_share_revoked + default: platform_agent_archived - - `PhoneCodeSent object` + - `workspace_id: optional string or null` - User requested a phone verification code. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentCreated object` + + An agent was created on the API platform. - `actor: object or object or object or 8 more` @@ -79332,6 +80908,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `agent_id: string` + + The agent that was created, e.g. "agent_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -79350,13 +80930,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "phone_code_sent"` + - `type: optional "platform_agent_created"` - default: phone_code_sent + default: platform_agent_created - - `PhoneCodeVerified object` + - `workspace_id: optional string or null` - User successfully verified their phone code. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeleted object` + + An agent was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -79569,6 +81153,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `agent_id: string` + + The agent that was deleted, e.g. "agent_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -79587,13 +81175,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "phone_code_verified"` + - `type: optional "platform_agent_deleted"` - default: phone_code_verified + default: platform_agent_deleted - - `PlatformAgentArchived object` + - `workspace_id: optional string or null` - An agent was archived on the API platform. + Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + + - `PlatformAgentDeploymentArchived object` + + An agent deployment was archived on the API platform. - `actor: object or object or object or 8 more` @@ -79806,9 +81398,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was archived, e.g. "agent_01HX...". + The agent deployment that was archived, e.g. "depl_01HX...". - `id: optional string` @@ -79828,17 +81420,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_archived"` + - `type: optional "platform_agent_deployment_archived"` - default: platform_agent_archived + default: platform_agent_deployment_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentCreated object` + - `PlatformAgentDeploymentCreated object` - An agent was created on the API platform. + An agent deployment was created on the API platform. - `actor: object or object or object or 8 more` @@ -80051,9 +81643,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was created, e.g. "agent_01HX...". + The agent deployment that was created, e.g. "depl_01HX...". - `id: optional string` @@ -80073,17 +81665,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_created"` + - `type: optional "platform_agent_deployment_created"` - default: platform_agent_created + default: platform_agent_deployment_created - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeleted object` + - `PlatformAgentDeploymentDeleted object` - An agent was deleted from the API platform. + An agent deployment was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -80296,9 +81888,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` + - `deployment_id: string` - The agent that was deleted, e.g. "agent_01HX...". + The agent deployment that was deleted, e.g. "depl_01HX...". - `id: optional string` @@ -80318,17 +81910,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deleted"` + - `type: optional "platform_agent_deployment_deleted"` - default: platform_agent_deleted + default: platform_agent_deployment_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentArchived object` + - `PlatformAgentDeploymentPaused object` - An agent deployment was archived on the API platform. + An agent deployment was paused on the API platform. - `actor: object or object or object or 8 more` @@ -80543,7 +82135,7 @@ compliance activities that can be filtered by various criteria. - `deployment_id: string` - The agent deployment that was archived, e.g. "depl_01HX...". + The agent deployment that was paused, e.g. "depl_01HX...". - `id: optional string` @@ -80563,17 +82155,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_archived"` + - `type: optional "platform_agent_deployment_paused"` - default: platform_agent_deployment_archived + default: platform_agent_deployment_paused - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentCreated object` + - `PlatformAgentDeploymentRunTriggered object` - An agent deployment was created on the API platform. + An agent deployment was run on demand on the API platform. - `actor: object or object or object or 8 more` @@ -80788,7 +82380,7 @@ compliance activities that can be filtered by various criteria. - `deployment_id: string` - The agent deployment that was created, e.g. "depl_01HX...". + The agent deployment that was run, e.g. "depl_01HX...". - `id: optional string` @@ -80808,17 +82400,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_created"` + - `type: optional "platform_agent_deployment_run_triggered"` - default: platform_agent_deployment_created + default: platform_agent_deployment_run_triggered - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentDeleted object` + - `PlatformAgentDeploymentUnpaused object` - An agent deployment was deleted from the API platform. + An agent deployment was resumed on the API platform. - `actor: object or object or object or 8 more` @@ -81033,7 +82625,7 @@ compliance activities that can be filtered by various criteria. - `deployment_id: string` - The agent deployment that was deleted, e.g. "depl_01HX...". + The agent deployment that was resumed, e.g. "depl_01HX...". - `id: optional string` @@ -81053,17 +82645,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_deleted"` + - `type: optional "platform_agent_deployment_unpaused"` - default: platform_agent_deployment_deleted + default: platform_agent_deployment_unpaused - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentPaused object` + - `PlatformAgentDeploymentUpdated object` - An agent deployment was paused on the API platform. + An agent deployment was updated on the API platform. - `actor: object or object or object or 8 more` @@ -81278,7 +82870,7 @@ compliance activities that can be filtered by various criteria. - `deployment_id: string` - The agent deployment that was paused, e.g. "depl_01HX...". + The agent deployment that was updated, e.g. "depl_01HX...". - `id: optional string` @@ -81298,17 +82890,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_paused"` + - `type: optional "platform_agent_deployment_updated"` - default: platform_agent_deployment_paused + default: platform_agent_deployment_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentRunTriggered object` + - `PlatformAgentSessionArchived object` - An agent deployment was run on demand on the API platform. + An agent session was archived on the API platform. - `actor: object or object or object or 8 more` @@ -81521,9 +83113,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was run, e.g. "depl_01HX...". + The agent session that was archived, e.g. "session_01HX...". - `id: optional string` @@ -81543,17 +83135,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_run_triggered"` + - `type: optional "platform_agent_session_archived"` - default: platform_agent_deployment_run_triggered + default: platform_agent_session_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentUnpaused object` + - `PlatformAgentSessionCreated object` - An agent deployment was resumed on the API platform. + An agent session was created on the API platform. - `actor: object or object or object or 8 more` @@ -81766,9 +83358,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was resumed, e.g. "depl_01HX...". + The agent session that was created, e.g. "session_01HX...". - `id: optional string` @@ -81788,17 +83380,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_unpaused"` + - `type: optional "platform_agent_session_created"` - default: platform_agent_deployment_unpaused + default: platform_agent_session_created - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentDeploymentUpdated object` + - `PlatformAgentSessionDeleted object` - An agent deployment was updated on the API platform. + An agent session was deleted from the API platform. - `actor: object or object or object or 8 more` @@ -82011,9 +83603,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `deployment_id: string` + - `session_id: string` - The agent deployment that was updated, e.g. "depl_01HX...". + The agent session that was deleted, e.g. "session_01HX...". - `id: optional string` @@ -82033,17 +83625,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_deployment_updated"` + - `type: optional "platform_agent_session_deleted"` - default: platform_agent_deployment_updated + default: platform_agent_session_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionArchived object` + - `PlatformAgentSessionResourceAdded object` - An agent session was archived on the API platform. + A resource was attached to an agent session. - `actor: object or object or object or 8 more` @@ -82256,9 +83848,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resource_id: string` + + The resource that was attached, e.g. "resource_01HX...". + - `session_id: string` - The agent session that was archived, e.g. "session_01HX...". + The agent session the resource was attached to, e.g. "session_01HX...". - `id: optional string` @@ -82278,17 +83874,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_archived"` + - `type: optional "platform_agent_session_resource_added"` - default: platform_agent_session_archived + default: platform_agent_session_resource_added - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionCreated object` + - `PlatformAgentSessionResourceDeleted object` - An agent session was created on the API platform. + A resource attached to an agent session was removed. - `actor: object or object or object or 8 more` @@ -82501,9 +84097,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resource_id: string` + + The resource that was removed, e.g. "resource_01HX...". + - `session_id: string` - The agent session that was created, e.g. "session_01HX...". + The agent session the resource belonged to, e.g. "session_01HX...". - `id: optional string` @@ -82523,17 +84123,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_created"` + - `type: optional "platform_agent_session_resource_deleted"` - default: platform_agent_session_created + default: platform_agent_session_resource_deleted - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionDeleted object` + - `PlatformAgentSessionResourceUpdated object` - An agent session was deleted from the API platform. + A resource attached to an agent session was updated. - `actor: object or object or object or 8 more` @@ -82746,9 +84346,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `resource_id: string` + + The resource that was updated, e.g. "resource_01HX...". + - `session_id: string` - The agent session that was deleted, e.g. "session_01HX...". + The agent session the resource belongs to, e.g. "session_01HX...". - `id: optional string` @@ -82768,17 +84372,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_deleted"` + - `type: optional "platform_agent_session_resource_updated"` - default: platform_agent_session_deleted + default: platform_agent_session_resource_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceAdded object` + - `PlatformAgentSessionThreadArchived object` - A resource was attached to an agent session. + A thread within an agent session was archived. - `actor: object or object or object or 8 more` @@ -82991,13 +84595,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` + - `session_id: string` - The resource that was attached, e.g. "resource_01HX...". + The agent session the thread belongs to, e.g. "session_01HX...". - - `session_id: string` + - `thread_id: string` - The agent session the resource was attached to, e.g. "session_01HX...". + The thread that was archived, e.g. "thread_01HX...". - `id: optional string` @@ -83017,17 +84621,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_added"` + - `type: optional "platform_agent_session_thread_archived"` - default: platform_agent_session_resource_added + default: platform_agent_session_thread_archived - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceDeleted object` + - `PlatformAgentSessionUpdated object` - A resource attached to an agent session was removed. + An agent session was updated on the API platform. - `actor: object or object or object or 8 more` @@ -83240,13 +84844,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` - - The resource that was removed, e.g. "resource_01HX...". - - `session_id: string` - The agent session the resource belonged to, e.g. "session_01HX...". + The agent session that was updated, e.g. "session_01HX...". - `id: optional string` @@ -83266,17 +84866,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_deleted"` + - `type: optional "platform_agent_session_updated"` - default: platform_agent_session_resource_deleted + default: platform_agent_session_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionResourceUpdated object` + - `PlatformAgentUpdated object` - A resource attached to an agent session was updated. + An agent was updated on the API platform. - `actor: object or object or object or 8 more` @@ -83489,13 +85089,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `resource_id: string` - - The resource that was updated, e.g. "resource_01HX...". - - - `session_id: string` + - `agent_id: string` - The agent session the resource belongs to, e.g. "session_01HX...". + The agent that was updated, e.g. "agent_01HX...". - `id: optional string` @@ -83515,17 +85111,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_resource_updated"` + - `type: optional "platform_agent_updated"` - default: platform_agent_session_resource_updated + default: platform_agent_updated - `workspace_id: optional string or null` Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. - - `PlatformAgentSessionThreadArchived object` + - `PlatformAPIKeyCreated object` - A thread within an agent session was archived. + An API key was created. - `actor: object or object or object or 8 more` @@ -83738,13 +85334,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` - - The agent session the thread belongs to, e.g. "session_01HX...". - - - `thread_id: string` + - `api_key_id: string` - The thread that was archived, e.g. "thread_01HX...". + Tagged ID of the created API key - `id: optional string` @@ -83764,17 +85356,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_thread_archived"` - - default: platform_agent_session_thread_archived - - - `workspace_id: optional string or null` + - `type: optional "platform_api_key_created"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_api_key_created - - `PlatformAgentSessionUpdated object` + - `PlatformAPIKeyUpdated object` - An agent session was updated on the API platform. + An API key was updated. - `actor: object or object or object or 8 more` @@ -83987,9 +85575,23 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `session_id: string` + - `api_key_id: string` - The agent session that was updated, e.g. "session_01HX...". + Tagged ID of the updated API key + + - `updates: array of object` + + - `current_value: string` + + - `previous_value: string` + + - `type: "name" or "status" or "workspace"` + + - `"name"` + + - `"status"` + + - `"workspace"` - `id: optional string` @@ -84009,17 +85611,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_session_updated"` - - default: platform_agent_session_updated - - - `workspace_id: optional string or null` + - `type: optional "platform_api_key_updated"` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + default: platform_api_key_updated - - `PlatformAgentUpdated object` + - `PlatformAppAttestAuthentication object` - An agent was updated on the API platform. + An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials. - `actor: object or object or object or 8 more` @@ -84232,10 +85830,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `agent_id: string` - - The agent that was updated, e.g. "agent_01HX...". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -84246,6 +85840,22 @@ compliance activities that can be filtered by various criteria. format: date-time + - `event_data: optional object or null` + + A nested object within a compliance activity payload. + + - `external_client_id: optional string or null` + + The registered external client the device presented, e.g. "clid_01HXZ4J2N8K5P7R9T3V6W1Y4M0". + + - `kid_hash: optional string or null` + + A truncated hash of the device's attested key identifier. + + - `workspace_id: optional string or null` + + The tagged ID of the workspace the minted token is bound to. + - `organization_id: optional string or null` Organization ID this activity is associated with @@ -84254,17 +85864,29 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_agent_updated"` + - `request_id: optional string or null` - default: platform_agent_updated + The Anthropic API request identifier for correlation. - - `workspace_id: optional string or null` + - `status: optional object or null` - Tagged workspace ID, e.g. "wrkspc_01HX...". Optional because org-scoped credentials may not resolve a workspace at request time. + A nested object within a compliance activity payload. - - `PlatformAPIKeyCreated object` + - `outcome: string` - An API key was created. + Whether the token exchange succeeded or was denied. + + - `reason: optional string or null` + + A short reason code when the exchange did not succeed. + + - `type: optional "platform_app_attest_authentication"` + + default: platform_app_attest_authentication + + - `PlatformBillingUpgradedToPrepaid object` + + The organization's API billing was upgraded to the prepaid plan. - `actor: object or object or object or 8 more` @@ -84477,9 +86099,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `api_key_id: string` + - `previous_billing_type: string` - Tagged ID of the created API key + The organization's billing type before this upgrade, for example "api_evaluation". - `id: optional string` @@ -84499,13 +86121,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_api_key_created"` + - `type: optional "platform_billing_upgraded_to_prepaid"` - default: platform_api_key_created + default: platform_billing_upgraded_to_prepaid - - `PlatformAPIKeyUpdated object` + - `PlatformClearanceWorkspaceProgramRequestCleared object` - An API key was updated. + A workspace's clearance program assignment was removed. - `actor: object or object or object or 8 more` @@ -84718,23 +86340,13 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `api_key_id: string` - - Tagged ID of the updated API key - - - `updates: array of object` - - - `current_value: string` - - - `previous_value: string` - - - `type: "name" or "status" or "workspace"` + - `program_slug: string` - - `"name"` + The clearance program's identifier - - `"status"` + - `workspace_id: string` - - `"workspace"` + Tagged ID of the workspace - `id: optional string` @@ -84754,13 +86366,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_api_key_updated"` + - `type: optional "platform_clearance_workspace_program_request_cleared"` - default: platform_api_key_updated + default: platform_clearance_workspace_program_request_cleared - - `PlatformAppAttestAuthentication object` + - `PlatformClearanceWorkspaceProgramRequestSet object` - An attested mobile device attempted to exchange an Apple App Attest assertion for Anthropic API credentials. + A workspace's clearance program assignment was created or updated. - `actor: object or object or object or 8 more` @@ -84973,31 +86585,33 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `id: optional string` + - `opt_decision: "opt_in" or "opt_out" or "unspecified"` - Unique identifier for the activity e.g. 'activity_abcd1234' + Whether the workspace is opted in or out of the program - - `created_at: optional string` + - `"opt_in"` - When this activity occurred. + - `"opt_out"` - format: date-time + - `"unspecified"` - - `event_data: optional object or null` + - `program_slug: string` - A nested object within a compliance activity payload. + The clearance program's identifier - - `external_client_id: optional string or null` + - `workspace_id: string` - The registered external client the device presented, e.g. "clid_01HXZ4J2N8K5P7R9T3V6W1Y4M0". + Tagged ID of the workspace - - `kid_hash: optional string or null` + - `id: optional string` - A truncated hash of the device's attested key identifier. + Unique identifier for the activity e.g. 'activity_abcd1234' - - `workspace_id: optional string or null` + - `created_at: optional string` - The tagged ID of the workspace the minted token is bound to. + When this activity occurred. + + format: date-time - `organization_id: optional string or null` @@ -85007,29 +86621,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `request_id: optional string or null` - - The Anthropic API request identifier for correlation. - - - `status: optional object or null` - - A nested object within a compliance activity payload. - - - `outcome: string` - - Whether the token exchange succeeded or was denied. - - - `reason: optional string or null` - - A short reason code when the exchange did not succeed. - - - `type: optional "platform_app_attest_authentication"` + - `type: optional "platform_clearance_workspace_program_request_set"` - default: platform_app_attest_authentication + default: platform_clearance_workspace_program_request_set - - `PlatformBillingUpgradedToPrepaid object` + - `PlatformCostReportViewed object` - The organization's API billing was upgraded to the prepaid plan. + The cost report was viewed. - `actor: object or object or object or 8 more` @@ -85242,10 +86840,6 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `previous_billing_type: string` - - The organization's billing type before this upgrade, for example "api_evaluation". - - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -85264,13 +86858,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_billing_upgraded_to_prepaid"` + - `type: optional "platform_cost_report_viewed"` - default: platform_billing_upgraded_to_prepaid + default: platform_cost_report_viewed - - `PlatformClearanceWorkspaceProgramRequestCleared object` + - `PlatformDreamArchived object` - A workspace's clearance program assignment was removed. + A Dream (asynchronous memory-consolidation job) was archived. - `actor: object or object or object or 8 more` @@ -85483,13 +87077,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `program_slug: string` - - The clearance program's identifier - - - `workspace_id: string` + - `dream_id: string` - Tagged ID of the workspace + Tagged dream ID, e.g. "drm_01HX...". - `id: optional string` @@ -85509,13 +87099,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_clearance_workspace_program_request_cleared"` + - `type: optional "platform_dream_archived"` - default: platform_clearance_workspace_program_request_cleared + default: platform_dream_archived - - `PlatformClearanceWorkspaceProgramRequestSet object` + - `workspace_id: optional string or null` - A workspace's clearance program assignment was created or updated. + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. + + - `PlatformDreamCancelled object` + + A Dream (asynchronous memory-consolidation job) was cancelled before it completed. - `actor: object or object or object or 8 more` @@ -85728,23 +87322,9 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` - - `opt_decision: "opt_in" or "opt_out" or "unspecified"` - - Whether the workspace is opted in or out of the program - - - `"opt_in"` - - - `"opt_out"` - - - `"unspecified"` - - - `program_slug: string` - - The clearance program's identifier - - - `workspace_id: string` + - `dream_id: string` - Tagged ID of the workspace + Tagged dream ID, e.g. "drm_01HX...". - `id: optional string` @@ -85764,13 +87344,17 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_clearance_workspace_program_request_set"` + - `type: optional "platform_dream_cancelled"` - default: platform_clearance_workspace_program_request_set + default: platform_dream_cancelled - - `PlatformCostReportViewed object` + - `workspace_id: optional string or null` - The cost report was viewed. + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. + + - `PlatformDreamCreated object` + + A Dream (asynchronous memory-consolidation job) was created. - `actor: object or object or object or 8 more` @@ -85983,6 +87567,10 @@ compliance activities that can be filtered by various criteria. - `user_agent: optional string or null` + - `dream_id: string` + + Tagged dream ID, e.g. "drm_01HX...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -86001,9 +87589,13 @@ compliance activities that can be filtered by various criteria. Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API). - - `type: optional "platform_cost_report_viewed"` + - `type: optional "platform_dream_created"` - default: platform_cost_report_viewed + default: platform_dream_created + + - `workspace_id: optional string or null` + + Tagged ID of the workspace the dream belongs to, e.g. "wrkspc_01HX...". For organization-scoped credentials this is the organization's default workspace. - `PlatformFederatedAuthentication object` @@ -106171,15 +107763,19 @@ compliance activities that can be filtered by various criteria. - `audience: array of object or object` - Sharing audience for the project. If empty, this it's only visible to the creating user. + Sharing audience for the project. If empty, it's only visible to the creating user. + + - `Public object` - - `ProjectSharingAudiencePublic object` + Sharing audience: the project is visible to anyone with the link. - `type: optional "public"` default: public - - `ProjectSharingAudienceOrganization object` + - `Organization object` + + Sharing audience: the project is visible to members of the owning organization. - `type: optional "organization"` @@ -106187,6 +107783,8 @@ compliance activities that can be filtered by various criteria. - `claude_project_id: string` + The project's identifier, e.g. "claude_proj_01Ab...". + - `id: optional string` Unique identifier for the activity e.g. 'activity_abcd1234' @@ -108668,14 +110266,24 @@ compliance activities that can be filtered by various criteria. - `resource_id: optional string or null` + ID of the resource the role is on. + - `resource_type: optional string or null` + What kind of resource the role is on, for example "chat_project", "skill", or "plugin". + - `role: optional string or null` + The role that was granted, for example "skill:viewer" or "plugin:viewer". + - `target_id: optional string or null` + ID of the grantee: a user ID for a member, a group ID for a group, the organization ID for an organization-wide grant. + - `target_type: optional string or null` + What kind of grantee received the role, for example "organization_member", "group", or "organization". + - `type: optional "role_assignment_granted"` default: role_assignment_granted @@ -108915,14 +110523,24 @@ compliance activities that can be filtered by various criteria. - `resource_id: optional string or null` + ID of the resource the role was on. + - `resource_type: optional string or null` + What kind of resource the role was on, for example "chat_project", "skill", or "plugin". + - `role: optional string or null` + The role that was revoked, for example "skill:viewer" or "plugin:viewer". + - `target_id: optional string or null` + ID of the grantee that held the role: a user ID for a member, a group ID for a group, the organization ID for an organization-wide grant. + - `target_type: optional string or null` + What kind of grantee held the role, for example "organization_member", "group", or "organization". + - `type: optional "role_assignment_revoked"` default: role_assignment_revoked @@ -121443,11 +123061,11 @@ compliance activities that can be filtered by various criteria. The web search setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -121459,11 +123077,11 @@ compliance activities that can be filtered by various criteria. The geolocation setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change @@ -121577,11 +123195,11 @@ compliance activities that can be filtered by various criteria. The Claude API in Artifacts setting was changed. - - `current_value: boolean or null` + - `current_value: optional boolean or null` Setting value immediately after this change - - `previous_value: boolean or null` + - `previous_value: optional boolean or null` Setting value immediately before this change diff --git a/content/en/api/compliance/apps.md b/content/en/api/compliance/apps.md index fa750fca0..780518451 100644 --- a/content/en/api/compliance/apps.md +++ b/content/en/api/compliance/apps.md @@ -2089,7 +2089,7 @@ forward-only via `next_page`; there is no reverse cursor. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -2187,7 +2187,7 @@ inference call has aged out returns 404. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -2484,7 +2484,7 @@ explicit 400; restart the walk to read under the current boundary. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` diff --git a/content/en/api/compliance/apps/sessions.md b/content/en/api/compliance/apps/sessions.md index bb80732b9..d4ad1b722 100644 --- a/content/en/api/compliance/apps/sessions.md +++ b/content/en/api/compliance/apps/sessions.md @@ -71,7 +71,7 @@ forward-only via `next_page`; there is no reverse cursor. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -169,7 +169,7 @@ inference call has aged out returns 404. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -466,7 +466,7 @@ explicit 400; restart the walk to read under the current boundary. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` diff --git a/content/en/api/compliance/apps/sessions/local.md b/content/en/api/compliance/apps/sessions/local.md index 527d03c74..65756f5e7 100644 --- a/content/en/api/compliance/apps/sessions/local.md +++ b/content/en/api/compliance/apps/sessions/local.md @@ -69,7 +69,7 @@ forward-only via `next_page`; there is no reverse cursor. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -167,7 +167,7 @@ inference call has aged out returns 404. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -226,8 +226,8 @@ curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ - `LocalListResponse object` - A Cowork or Claude Code session that a user ran on their own computer - while signed in with their organization account. + A session that a user ran on their own computer in a Claude app while + signed in with their organization account. - `id: string` @@ -245,7 +245,7 @@ curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -277,8 +277,8 @@ curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ - `LocalRetrieveResponse object` - A Cowork or Claude Code session that a user ran on their own computer - while signed in with their organization account. + A session that a user ran on their own computer in a Claude app while + signed in with their organization account. - `id: string` @@ -296,7 +296,7 @@ curl https://api.anthropic.com/v1/compliance/apps/sessions/local/$LOCAL_SESSION_ - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` @@ -568,7 +568,7 @@ explicit 400; restart the walk to read under the current boundary. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` diff --git a/content/en/api/compliance/apps/sessions/local/list.md b/content/en/api/compliance/apps/sessions/local/list.md index 67b01eaa4..823c40a43 100644 --- a/content/en/api/compliance/apps/sessions/local/list.md +++ b/content/en/api/compliance/apps/sessions/local/list.md @@ -67,7 +67,7 @@ forward-only via `next_page`; there is no reverse cursor. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` diff --git a/content/en/api/compliance/apps/sessions/local/messages.md b/content/en/api/compliance/apps/sessions/local/messages.md index 6031728a3..05c733528 100644 --- a/content/en/api/compliance/apps/sessions/local/messages.md +++ b/content/en/api/compliance/apps/sessions/local/messages.md @@ -242,7 +242,7 @@ explicit 400; restart the walk to read under the current boundary. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` diff --git a/content/en/api/compliance/apps/sessions/local/messages/list.md b/content/en/api/compliance/apps/sessions/local/messages/list.md index 8f89ab41d..e400ef4f8 100644 --- a/content/en/api/compliance/apps/sessions/local/messages/list.md +++ b/content/en/api/compliance/apps/sessions/local/messages/list.md @@ -240,7 +240,7 @@ explicit 400; restart the walk to read under the current boundary. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` diff --git a/content/en/api/compliance/apps/sessions/local/retrieve.md b/content/en/api/compliance/apps/sessions/local/retrieve.md index 1afb43132..8645d97b0 100644 --- a/content/en/api/compliance/apps/sessions/local/retrieve.md +++ b/content/en/api/compliance/apps/sessions/local/retrieve.md @@ -35,7 +35,7 @@ inference call has aged out returns 404. - `product_surface: string or null` - The product the session ran in: `cowork` for Cowork sessions in Claude Desktop, or `claude_code` for Claude Code sessions. New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. + The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded. - `type: "compliance_local_session"` diff --git a/content/en/api/compliance/organizations.md b/content/en/api/compliance/organizations.md index dfc8247cc..1be7b6a94 100644 --- a/content/en/api/compliance/organizations.md +++ b/content/en/api/compliance/organizations.md @@ -514,7 +514,7 @@ unknown organizations and organizations outside the hierarchy return 404. A setting whose enforced value is a single true/false flag. - - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 44 more` + - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more` - `"ai_powered_artifacts_enabled"` @@ -558,6 +558,22 @@ unknown organizations and organizations outside the hierarchy return 404. - `"claude_in_slack_enabled"` + - `"claude_science_custom_connectors_enabled"` + + - `"claude_science_custom_skills_enabled"` + + - `"claude_science_enabled"` + + - `"claude_science_managed_network_allowlist_enabled"` + + - `"claude_science_memory_enabled"` + + - `"claude_science_modal_enabled"` + + - `"claude_science_scientific_model_endpoints_enabled"` + + - `"claude_science_ssh_hosts_enabled"` + - `"code_execution_enabled"` - `"code_execution_network_egress_enabled"` diff --git a/content/en/api/compliance/organizations/settings.md b/content/en/api/compliance/organizations/settings.md index b3baaa623..38cb6fc98 100644 --- a/content/en/api/compliance/organizations/settings.md +++ b/content/en/api/compliance/organizations/settings.md @@ -75,7 +75,7 @@ unknown organizations and organizations outside the hierarchy return 404. A setting whose enforced value is a single true/false flag. - - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 44 more` + - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more` - `"ai_powered_artifacts_enabled"` @@ -119,6 +119,22 @@ unknown organizations and organizations outside the hierarchy return 404. - `"claude_in_slack_enabled"` + - `"claude_science_custom_connectors_enabled"` + + - `"claude_science_custom_skills_enabled"` + + - `"claude_science_enabled"` + + - `"claude_science_managed_network_allowlist_enabled"` + + - `"claude_science_memory_enabled"` + + - `"claude_science_modal_enabled"` + + - `"claude_science_scientific_model_endpoints_enabled"` + + - `"claude_science_ssh_hosts_enabled"` + - `"code_execution_enabled"` - `"code_execution_network_egress_enabled"` @@ -402,7 +418,7 @@ curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/sett A setting whose enforced value is a single true/false flag. - - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 44 more` + - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more` - `"ai_powered_artifacts_enabled"` @@ -446,6 +462,22 @@ curl https://api.anthropic.com/v1/compliance/organizations/$ORGANIZATION_ID/sett - `"claude_in_slack_enabled"` + - `"claude_science_custom_connectors_enabled"` + + - `"claude_science_custom_skills_enabled"` + + - `"claude_science_enabled"` + + - `"claude_science_managed_network_allowlist_enabled"` + + - `"claude_science_memory_enabled"` + + - `"claude_science_modal_enabled"` + + - `"claude_science_scientific_model_endpoints_enabled"` + + - `"claude_science_ssh_hosts_enabled"` + - `"code_execution_enabled"` - `"code_execution_network_egress_enabled"` diff --git a/content/en/api/compliance/organizations/settings/retrieve.md b/content/en/api/compliance/organizations/settings/retrieve.md index 4b6909a82..14e98617c 100644 --- a/content/en/api/compliance/organizations/settings/retrieve.md +++ b/content/en/api/compliance/organizations/settings/retrieve.md @@ -73,7 +73,7 @@ unknown organizations and organizations outside the hierarchy return 404. A setting whose enforced value is a single true/false flag. - - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 44 more` + - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more` - `"ai_powered_artifacts_enabled"` @@ -117,6 +117,22 @@ unknown organizations and organizations outside the hierarchy return 404. - `"claude_in_slack_enabled"` + - `"claude_science_custom_connectors_enabled"` + + - `"claude_science_custom_skills_enabled"` + + - `"claude_science_enabled"` + + - `"claude_science_managed_network_allowlist_enabled"` + + - `"claude_science_memory_enabled"` + + - `"claude_science_modal_enabled"` + + - `"claude_science_scientific_model_endpoints_enabled"` + + - `"claude_science_ssh_hosts_enabled"` + - `"code_execution_enabled"` - `"code_execution_network_egress_enabled"` diff --git a/content/en/api/csharp/beta.md b/content/en/api/csharp/beta.md index c3688d032..b76cc7294 100644 --- a/content/en/api/csharp/beta.md +++ b/content/en/api/csharp/beta.md @@ -320,6 +320,20 @@ The Models API response can be used to determine which models are available for - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ModelListPageResponse:` @@ -656,6 +670,20 @@ The Models API response can be used to determine information about a specific mo - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaModelInfo:` @@ -4428,6 +4456,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5761,12 +5803,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -6064,12 +6108,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `required long OutputTokens` The cumulative number of output tokens which were used. @@ -9763,6 +9809,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -11535,6 +11595,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `Omitted` + - `Updates` + - `class BetaThinkingConfigDisabled:` - `JsonElement Type constant` @@ -11551,6 +11613,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `Omitted` + - `Updates` + - `JsonElement` - `string? InferenceGeo` @@ -13716,6 +13780,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -14120,6 +14198,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaMessageBatch:` @@ -14353,6 +14445,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BatchListPageResponse:` @@ -14599,6 +14705,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaMessageBatch:` @@ -14822,6 +14942,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaDeletedMessageBatch:` @@ -14947,6 +15081,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaMessageBatchIndividualResponse:` @@ -16250,12 +16398,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -17310,6 +17460,20 @@ Create Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsAgent:` @@ -18033,6 +18197,20 @@ List Agents - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class AgentListPageResponse:` @@ -18751,6 +18929,20 @@ Get Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsAgent:` @@ -20109,6 +20301,20 @@ Update Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsAgent:` @@ -20809,6 +21015,20 @@ Archive Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsAgent:` @@ -21521,6 +21741,20 @@ List Agent Versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionListPageResponse:` @@ -22212,7 +22446,7 @@ Create a new environment with the specified configuration. - `bool? AllowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `IReadOnlyList? AllowedHosts` @@ -22224,6 +22458,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `IReadOnlyList? Apt` Ubuntu/Debian packages to install @@ -22350,6 +22586,20 @@ Create a new environment with the specified configuration. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaEnvironment:` @@ -22637,6 +22887,20 @@ List environments with pagination support. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class EnvironmentListPageResponse:` @@ -22930,6 +23194,20 @@ Retrieve a specific environment by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaEnvironment:` @@ -23182,7 +23460,7 @@ Update an existing environment's configuration. - `bool? AllowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `IReadOnlyList? AllowedHosts` @@ -23194,6 +23472,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `IReadOnlyList? Apt` Ubuntu/Debian packages to install @@ -23326,6 +23606,20 @@ Update an existing environment's configuration. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaEnvironment:` @@ -23604,6 +23898,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaEnvironmentDeleteResponse:` @@ -23726,6 +24034,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaEnvironment:` @@ -24014,6 +24336,20 @@ Retrieve detailed information about a specific work item. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWork:` @@ -24235,6 +24571,20 @@ Long poll for work items in the queue. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string anthropicWorkerID` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -24451,6 +24801,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWork:` @@ -24672,6 +25036,20 @@ Record a heartbeat for a work item to maintain the lease. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWorkHeartbeatResponse:` @@ -24832,6 +25210,20 @@ Stop a work item, initiating graceful or forced shutdown. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWork:` @@ -25051,6 +25443,20 @@ List work items in an environment. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWorkListResponse:` @@ -25278,6 +25684,20 @@ Update work item metadata with merge semantics. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWork:` @@ -25484,6 +25904,20 @@ Get statistics about the work queue for an environment. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWorkQueueStats:` @@ -26617,6 +27051,20 @@ Create Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSession:` @@ -27811,6 +28259,20 @@ List Sessions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class SessionListPageResponse:` @@ -28949,6 +29411,20 @@ Get Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSession:` @@ -30092,6 +30568,20 @@ Update Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSession:` @@ -31213,6 +31703,20 @@ Delete Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeletedSession:` @@ -31333,6 +31837,20 @@ Archive Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSession:` @@ -32502,6 +33020,20 @@ List Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class EventListPageResponse:` @@ -35127,6 +35659,20 @@ Send Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSendSessionEvents:` @@ -35717,6 +36263,20 @@ Stream Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsStreamSessionEvents: union` @@ -38031,6 +38591,20 @@ Add Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsFileResource:` @@ -38181,6 +38755,20 @@ List Session Resources - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ResourceListPageResponse:` @@ -38434,6 +39022,20 @@ Get Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ResourceRetrieveResponse: union` @@ -38671,6 +39273,20 @@ Update Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ResourceUpdateResponse: union` @@ -38903,6 +39519,20 @@ Delete Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeleteSessionResource:` @@ -39036,6 +39666,20 @@ List Session Threads - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ThreadListPageResponse:` @@ -39052,7 +39696,7 @@ List Session Threads - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -39869,6 +40513,20 @@ Get Session Thread - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -39881,7 +40539,7 @@ Get Session Thread - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -40688,6 +41346,20 @@ Archive Session Thread - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -40700,7 +41372,7 @@ Archive Session Thread - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -41519,6 +42191,20 @@ List Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class EventListPageResponse:` @@ -43784,6 +44470,20 @@ Stream Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` @@ -46449,6 +47149,20 @@ Create Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -47180,6 +47894,20 @@ List Deployments - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class DeploymentListPageResponse:` @@ -47876,6 +48604,20 @@ Get Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -48932,6 +49674,20 @@ Update Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -49616,6 +50372,20 @@ Archive Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -50300,6 +51070,20 @@ Run Deployment Now - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeploymentRun:` @@ -50650,6 +51434,20 @@ Pause Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -51334,6 +52132,20 @@ Unpause Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -52062,6 +52874,20 @@ List Deployment Runs - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class DeploymentRunListPageResponse:` @@ -52424,6 +53250,20 @@ Get Deployment Run - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeploymentRun:` @@ -52782,6 +53622,20 @@ Create Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsVault:` @@ -52944,6 +53798,20 @@ List Vaults - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VaultListPageResponse:` @@ -53111,6 +53979,20 @@ Get Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsVault:` @@ -53276,6 +54158,20 @@ Update Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsVault:` @@ -53431,6 +54327,20 @@ Delete Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeletedVault:` @@ -53553,6 +54463,20 @@ Archive Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsVault:` @@ -53884,6 +54808,20 @@ Create Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredential:` @@ -54182,6 +55120,20 @@ List Credentials - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class CredentialListPageResponse:` @@ -54479,6 +55431,20 @@ Get Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredential:` @@ -54894,6 +55860,20 @@ Update Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredential:` @@ -55177,6 +56157,20 @@ Delete Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeletedCredential:` @@ -55304,6 +56298,20 @@ Archive Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredential:` @@ -55587,6 +56595,20 @@ Validate Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredentialValidation:` @@ -55820,6 +56842,20 @@ Create a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemoryStore:` @@ -55999,6 +57035,20 @@ List memory stores - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class MemoryStoreListPageResponse:` @@ -56171,6 +57221,20 @@ Retrieve a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemoryStore:` @@ -56347,6 +57411,20 @@ Update a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemoryStore:` @@ -56507,6 +57585,20 @@ Delete a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeletedMemoryStore:` @@ -56629,6 +57721,20 @@ Archive a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemoryStore:` @@ -56805,6 +57911,20 @@ Create a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemory:` @@ -56837,7 +57957,7 @@ Create a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -56999,6 +58119,20 @@ List memories - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class MemoryListPageResponse:` @@ -57039,7 +58173,7 @@ List memories - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -57201,6 +58335,20 @@ Retrieve a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemory:` @@ -57233,7 +58381,7 @@ Retrieve a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -57392,6 +58540,20 @@ Update a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemory:` @@ -57424,7 +58586,7 @@ Update a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -57569,11 +58731,25 @@ Delete a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `required string ID` @@ -57740,6 +58916,20 @@ List memory versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class MemoryVersionListPageResponse:` @@ -57762,7 +58952,7 @@ List memory versions - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` @@ -58006,11 +59196,25 @@ Retrieve a memory version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -58024,7 +59228,7 @@ Retrieve a memory version - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` @@ -58254,11 +59458,25 @@ Redact a memory version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -58272,7 +59490,7 @@ Redact a memory version - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` @@ -58502,6 +59720,20 @@ Upload File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaFileMetadata:` @@ -58693,6 +59925,20 @@ List Files - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class FileListPageResponse:` @@ -58890,6 +60136,20 @@ Download File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Example ```csharp @@ -58988,6 +60248,20 @@ Get File Metadata - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaFileMetadata:` @@ -59160,6 +60434,20 @@ Delete File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaDeletedFile:` @@ -59291,6 +60579,20 @@ Create Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class SkillCreateResponse:` @@ -59471,6 +60773,20 @@ List Skills - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class SkillListPageResponse:` @@ -59654,6 +60970,20 @@ Get Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class SkillRetrieveResponse:` @@ -59813,6 +61143,20 @@ Delete Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class SkillDeleteResponse:` @@ -59946,6 +61290,20 @@ Create Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionCreateResponse:` @@ -60126,6 +61484,20 @@ List Skill Versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionListPageResponse:` @@ -60315,6 +61687,20 @@ Download a skill version's content as a zip archive. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Example ```csharp @@ -60425,6 +61811,20 @@ Get Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionRetrieveResponse:` @@ -60598,6 +61998,20 @@ Delete Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionDeleteResponse:` @@ -60757,6 +62171,20 @@ Create User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaUserProfile:` @@ -60958,6 +62386,20 @@ List User Profiles - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class UserProfileListPageResponse:` @@ -61160,6 +62602,20 @@ Get User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaUserProfile:` @@ -61384,6 +62840,20 @@ Update User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaUserProfile:` @@ -61574,6 +63044,20 @@ Create Enrollment URL - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaUserProfileEnrollmentUrl:` @@ -61757,6 +63241,20 @@ Create a Dream - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaDream:` @@ -62092,6 +63590,20 @@ List Dreams - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class DreamListPageResponse:` @@ -62389,6 +63901,20 @@ Get a Dream - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaDream:` @@ -62677,6 +64203,20 @@ Cancel a Dream - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaDream:` @@ -62965,6 +64505,20 @@ Archive a Dream - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaDream:` @@ -63259,6 +64813,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaTunnel:` @@ -63404,6 +64972,20 @@ Fetches a tunnel by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaTunnel:` @@ -63559,6 +65141,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class TunnelListPageResponse:` @@ -63719,6 +65315,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaTunnel:` @@ -63864,6 +65474,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaTunnelToken:` @@ -63996,6 +65620,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaTunnelToken:` @@ -64130,93 +65768,10123 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `MidConversationToolChanges2026_07_01` -#### Returns + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaTunnelCertificate:` + + A CA certificate attached to a tunnel. + + - `required string ID` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `required DateTimeOffset? ArchivedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required DateTimeOffset CreatedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required DateTimeOffset? ExpiresAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required string Fingerprint` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `required string TunnelID` + + ID of the tunnel the certificate is registered against. + + - `JsonElement Type constant` + +#### Example + +```csharp +CertificateCreateParams parameters = new() +{ + TunnelID = "tunnel_id", + CACertificatePem = "ca_certificate_pem", +}; + +var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Create(parameters); + +Console.WriteLine(betaTunnelCertificate); +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### Get Tunnel Certificate + +`BetaTunnelCertificate Beta.Tunnels.Certificates.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Fetches a tunnel certificate by ID. + +#### Parameters + +- `CertificateRetrieveParams parameters` + + - `required string tunnelID` + + Path param: Path parameter tunnel_id + + - `required string certificateID` + + Path param: Path parameter certificate_id + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaTunnelCertificate:` + + A CA certificate attached to a tunnel. + + - `required string ID` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `required DateTimeOffset? ArchivedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required DateTimeOffset CreatedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required DateTimeOffset? ExpiresAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required string Fingerprint` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `required string TunnelID` + + ID of the tunnel the certificate is registered against. + + - `JsonElement Type constant` + +#### Example + +```csharp +CertificateRetrieveParams parameters = new() +{ + TunnelID = "tunnel_id", + CertificateID = "certificate_id", +}; + +var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Retrieve(parameters); + +Console.WriteLine(betaTunnelCertificate); +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### List Tunnel Certificates + +`CertificateListPageResponse Beta.Tunnels.Certificates.List(parameters, cancellationToken = default)` + +**GET** `/v1/tunnels/{tunnel_id}/certificates` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. + +#### Parameters + +- `CertificateListParams parameters` + + - `required string tunnelID` + + Path param: Path parameter tunnel_id + + - `bool includeArchived` + + Query param: Whether to include archived certificates in the results. Defaults to false. + + - `int limit` + + Query param: Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + + format: int32 + + - `string page` + + Query param: Opaque pagination cursor from a previous `list_tunnel_certificates` response. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class CertificateListPageResponse:` + + The tunnel's certificates. + + - `required IReadOnlyList Data` + + List of certificates, ordered by created_at descending. + + - `required string ID` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `required DateTimeOffset? ArchivedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required DateTimeOffset CreatedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required DateTimeOffset? ExpiresAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required string Fingerprint` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `required string TunnelID` + + ID of the tunnel the certificate is registered against. + + - `JsonElement Type constant` + + - `required string? NextPage` + + Pagination cursor for the next page, or null if no more results. + +#### Example + +```csharp +CertificateListParams parameters = new() { TunnelID = "tunnel_id" }; + +var page = await client.Beta.Tunnels.Certificates.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" + } + ], + "next_page": "next_page" +} +``` + +### Archive Tunnel Certificate + +`BetaTunnelCertificate Beta.Tunnels.Certificates.Archive(parameters, cancellationToken = default)` + +**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. + +#### Parameters + +- `CertificateArchiveParams parameters` + + - `required string tunnelID` + + Path param: Path parameter tunnel_id + + - `required string certificateID` + + Path param: Path parameter certificate_id + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaTunnelCertificate:` + + A CA certificate attached to a tunnel. + + - `required string ID` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `required DateTimeOffset? ArchivedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required DateTimeOffset CreatedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required DateTimeOffset? ExpiresAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `required string Fingerprint` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `required string TunnelID` + + ID of the tunnel the certificate is registered against. + + - `JsonElement Type constant` + +#### Example + +```csharp +CertificateArchiveParams parameters = new() +{ + TunnelID = "tunnel_id", + CertificateID = "certificate_id", +}; + +var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Archive(parameters); + +Console.WriteLine(betaTunnelCertificate); +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +## Beta › Organization + +### Get Current Organization + +`BetaOrganization Beta.Organization.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Parameters + +- `OrganizationRetrieveParams parameters` + +#### Returns + +- `class BetaOrganization:` + + - `required string ID` + + ID of the Organization. + + format: uuid + + - `required string Name` + + Name of the Organization. + + - `JsonElement Type constant` + + Object type. + + For Organizations, this is always `"organization"`. + +#### Example + +```csharp +OrganizationRetrieveParams parameters = new(); + +var betaOrganization = await client.Beta.Organization.Retrieve(parameters); + +Console.WriteLine(betaOrganization); +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +`ApiKeyListPageResponse Beta.Organization.ApiKeys.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Parameters + +- `ApiKeyListParams parameters` + + - `string afterID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `string beforeID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `string? createdByUserID` + + Filter by the ID of the User who created the object. + + - `long limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `Status? status` + + Filter by API key status. + + - `Active` + + - `Archived` + + - `Expired` + + - `Inactive` + + - `string? workspaceID` + + Filter by Workspace ID. + +#### Returns + +- `class ApiKeyListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string ID` + + ID of the API key. + + - `required DateTimeOffset CreatedAt` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `required BetaApiKeyCreatedBy? CreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `required string ID` + + ID of the actor that created the object. + + - `required Type Type` + + Type of the actor that created the object. + + - `ServiceAccount` + + - `User` + + - `required DateTimeOffset? ExpiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `required string Name` + + Name of the API key. + + - `required string? PartialKeyHint` + + Partially redacted hint for the API key. + + - `required Principal? Principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaApiKeyUserActor:` + + - `JsonElement Type constant` + + Principal type. Always `"user_actor"` for a User. + + - `required string UserID` + + ID of the User the API key acts as. + + - `class BetaApiKeyServiceAccountActor:` + + - `required string ServiceAccountID` + + ID of the Service Account the API key acts as. + + - `JsonElement Type constant` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `required Scope Scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaApiKeyOrganizationScope:` + + - `JsonElement Type constant` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaApiKeyWorkspaceScope:` + + - `JsonElement Type constant` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `required string WorkspaceID` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `required Status Status` + + Status of the API key. + + - `Active` + + - `Archived` + + - `Expired` + + - `Inactive` + + - `JsonElement Type constant` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `required string? WorkspaceID` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + + - `required string? FirstID` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `required bool HasMore` + + Indicates if there are more results in the requested page direction. + + - `required string? LastID` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```csharp +ApiKeyListParams parameters = new(); + +var page = await client.Beta.Organization.ApiKeys.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +`BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Parameters + +- `ApiKeyRetrieveParams parameters` + + - `required string apiKeyID` + + ID of the API key. + +#### Returns + +- `class BetaApiKey:` + + - `required string ID` + + ID of the API key. + + - `required DateTimeOffset CreatedAt` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `required BetaApiKeyCreatedBy? CreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `required string ID` + + ID of the actor that created the object. + + - `required Type Type` + + Type of the actor that created the object. + + - `ServiceAccount` + + - `User` + + - `required DateTimeOffset? ExpiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `required string Name` + + Name of the API key. + + - `required string? PartialKeyHint` + + Partially redacted hint for the API key. + + - `required Principal? Principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaApiKeyUserActor:` + + - `JsonElement Type constant` + + Principal type. Always `"user_actor"` for a User. + + - `required string UserID` + + ID of the User the API key acts as. + + - `class BetaApiKeyServiceAccountActor:` + + - `required string ServiceAccountID` + + ID of the Service Account the API key acts as. + + - `JsonElement Type constant` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `required Scope Scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaApiKeyOrganizationScope:` + + - `JsonElement Type constant` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaApiKeyWorkspaceScope:` + + - `JsonElement Type constant` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `required string WorkspaceID` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `required Status Status` + + Status of the API key. + + - `Active` + + - `Archived` + + - `Expired` + + - `Inactive` + + - `JsonElement Type constant` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `required string? WorkspaceID` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```csharp +ApiKeyRetrieveParams parameters = new() { ApiKeyID = "api_key_id" }; + +var betaApiKey = await client.Beta.Organization.ApiKeys.Retrieve(parameters); + +Console.WriteLine(betaApiKey); +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +`BetaApiKey Beta.Organization.ApiKeys.Update(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Parameters + +- `ApiKeyUpdateParams parameters` + + - `required string apiKeyID` + + ID of the API key. + + - `string? name` + + Name of the API key. + + maxLength: 500, minLength: 1 + + - `Status? status` + + Status of the API key. + + - `Active` + + - `Archived` + + - `Inactive` + +#### Returns + +- `class BetaApiKey:` + + - `required string ID` + + ID of the API key. + + - `required DateTimeOffset CreatedAt` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `required BetaApiKeyCreatedBy? CreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `required string ID` + + ID of the actor that created the object. + + - `required Type Type` + + Type of the actor that created the object. + + - `ServiceAccount` + + - `User` + + - `required DateTimeOffset? ExpiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `required string Name` + + Name of the API key. + + - `required string? PartialKeyHint` + + Partially redacted hint for the API key. + + - `required Principal? Principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaApiKeyUserActor:` + + - `JsonElement Type constant` + + Principal type. Always `"user_actor"` for a User. + + - `required string UserID` + + ID of the User the API key acts as. + + - `class BetaApiKeyServiceAccountActor:` + + - `required string ServiceAccountID` + + ID of the Service Account the API key acts as. + + - `JsonElement Type constant` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `required Scope Scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaApiKeyOrganizationScope:` + + - `JsonElement Type constant` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaApiKeyWorkspaceScope:` + + - `JsonElement Type constant` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `required string WorkspaceID` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `required Status Status` + + Status of the API key. + + - `Active` + + - `Archived` + + - `Expired` + + - `Inactive` + + - `JsonElement Type constant` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `required string? WorkspaceID` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```csharp +ApiKeyUpdateParams parameters = new() { ApiKeyID = "api_key_id" }; + +var betaApiKey = await client.Beta.Organization.ApiKeys.Update(parameters); + +Console.WriteLine(betaApiKey); +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +`BetaExternalKey Beta.Organization.ExternalKeys.Create(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Parameters + +- `ExternalKeyCreateParams parameters` + + - `required ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `required string KmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonElement Type constant` + + - `string? Region` + + AWS region. Derived from `kms_arn` if omitted. + + - `string? RoleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `required string KeyName` + + Full resource name of the Cloud KMS key. + + - `JsonElement Type constant` + + - `class BetaAzureExternalKeyConfigParam:` + + Azure Key Vault provider configuration. + + - `required string KeyName` + + Name of the key within the vault. + + - `required string TenantID` + + Azure AD tenant ID. + + - `JsonElement Type constant` + + - `required string VaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `string? ClientID` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `string? displayName` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + + - `Geo geo` + + Data residency geo. Only `us` is supported. + + - `Us` + +#### Returns + +- `class BetaExternalKey:` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `required string ID` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `required Attachment Attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment:` + + - `JsonElement Type constant` + + - `class BetaExternalKeyUnattachedAttachment:` + + - `JsonElement Type constant` + + - `required DateTimeOffset CreatedAt` + + format: date-time + + - `required string? DisplayName` + + Human-friendly display name. Null if none was set. + + - `required string Geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `required ProviderConfig ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `required string KmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonElement Type constant` + + - `string? Region` + + AWS region. Derived from `kms_arn` if omitted. + + - `string? RoleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `required string KeyName` + + Full resource name of the Cloud KMS key. + + - `JsonElement Type constant` + + - `class BetaAzureExternalKeyConfig:` + + - `required string KeyName` + + Name of the key within the vault. + + - `required string TenantID` + + Azure AD tenant ID. + + - `JsonElement Type constant` + + - `required string VaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `string? ClientID` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + format: date-time + +#### Example + +```csharp +ExternalKeyCreateParams parameters = new() +{ + ProviderConfig = new BetaAwsExternalKeyConfig() + { + KmsArn = "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + Region = "us-east-1", + RoleArn = "arn:aws:iam::111122223333:role/anthropic-cmek", + }, +}; + +var betaExternalKey = await client.Beta.Organization.ExternalKeys.Create(parameters); + +Console.WriteLine(betaExternalKey); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +`ExternalKeyListPageResponse Beta.Organization.ExternalKeys.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Parameters + +- `ExternalKeyListParams parameters` + + - `long limit` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `string? page` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class ExternalKeyListPageResponse:` + + Opaque-cursor page of external keys, ordered by creation time (newest first). + + - `required IReadOnlyList Data` + + - `required string ID` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `required Attachment Attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment:` + + - `JsonElement Type constant` + + - `class BetaExternalKeyUnattachedAttachment:` + + - `JsonElement Type constant` + + - `required DateTimeOffset CreatedAt` + + format: date-time + + - `required string? DisplayName` + + Human-friendly display name. Null if none was set. + + - `required string Geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `required ProviderConfig ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `required string KmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonElement Type constant` + + - `string? Region` + + AWS region. Derived from `kms_arn` if omitted. + + - `string? RoleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `required string KeyName` + + Full resource name of the Cloud KMS key. + + - `JsonElement Type constant` + + - `class BetaAzureExternalKeyConfig:` + + - `required string KeyName` + + Name of the key within the vault. + + - `required string TenantID` + + Azure AD tenant ID. + + - `JsonElement Type constant` + + - `required string VaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `string? ClientID` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + format: date-time + + - `required string? NextPage` + + Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page. + +#### Example + +```csharp +ExternalKeyListParams parameters = new(); + +var page = await client.Beta.Organization.ExternalKeys.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +`BetaExternalKey Beta.Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Parameters + +- `ExternalKeyRetrieveParams parameters` + + - `required string externalKeyID` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class BetaExternalKey:` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `required string ID` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `required Attachment Attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment:` + + - `JsonElement Type constant` + + - `class BetaExternalKeyUnattachedAttachment:` + + - `JsonElement Type constant` + + - `required DateTimeOffset CreatedAt` + + format: date-time + + - `required string? DisplayName` + + Human-friendly display name. Null if none was set. + + - `required string Geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `required ProviderConfig ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `required string KmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonElement Type constant` + + - `string? Region` + + AWS region. Derived from `kms_arn` if omitted. + + - `string? RoleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `required string KeyName` + + Full resource name of the Cloud KMS key. + + - `JsonElement Type constant` + + - `class BetaAzureExternalKeyConfig:` + + - `required string KeyName` + + Name of the key within the vault. + + - `required string TenantID` + + Azure AD tenant ID. + + - `JsonElement Type constant` + + - `required string VaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `string? ClientID` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + format: date-time + +#### Example + +```csharp +ExternalKeyRetrieveParams parameters = new() +{ + ExternalKeyID = "external_key_id" +}; + +var betaExternalKey = await client.Beta.Organization.ExternalKeys.Retrieve(parameters); + +Console.WriteLine(betaExternalKey); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +`BetaExternalKey Beta.Organization.ExternalKeys.Update(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Parameters + +- `ExternalKeyUpdateParams parameters` + + - `required string externalKeyID` + + ID of the External Key. + + maxLength: 2048 + + - `string? displayName` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + + - `Geo? geo` + + Data residency geo. Only `us` is supported. + + - `Us` + + - `ProviderConfig? providerConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `required string KmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonElement Type constant` + + - `string? Region` + + AWS region. Derived from `kms_arn` if omitted. + + - `string? RoleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `required string KeyName` + + Full resource name of the Cloud KMS key. + + - `JsonElement Type constant` + + - `class BetaAzureExternalKeyConfigParam:` + + Azure Key Vault provider configuration. + + - `required string KeyName` + + Name of the key within the vault. + + - `required string TenantID` + + Azure AD tenant ID. + + - `JsonElement Type constant` + + - `required string VaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `string? ClientID` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +#### Returns + +- `class BetaExternalKey:` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `required string ID` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `required Attachment Attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment:` + + - `JsonElement Type constant` + + - `class BetaExternalKeyUnattachedAttachment:` + + - `JsonElement Type constant` + + - `required DateTimeOffset CreatedAt` + + format: date-time + + - `required string? DisplayName` + + Human-friendly display name. Null if none was set. + + - `required string Geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `required ProviderConfig ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `required string KmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonElement Type constant` + + - `string? Region` + + AWS region. Derived from `kms_arn` if omitted. + + - `string? RoleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `required string KeyName` + + Full resource name of the Cloud KMS key. + + - `JsonElement Type constant` + + - `class BetaAzureExternalKeyConfig:` + + - `required string KeyName` + + Name of the key within the vault. + + - `required string TenantID` + + Azure AD tenant ID. + + - `JsonElement Type constant` + + - `required string VaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `string? ClientID` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + format: date-time + +#### Example + +```csharp +ExternalKeyUpdateParams parameters = new() +{ + ExternalKeyID = "external_key_id" +}; + +var betaExternalKey = await client.Beta.Organization.ExternalKeys.Update(parameters); + +Console.WriteLine(betaExternalKey); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +`ExternalKeyDeleteResponse Beta.Organization.ExternalKeys.Delete(parameters, cancellationToken = default)` + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Parameters + +- `ExternalKeyDeleteParams parameters` + + - `required string externalKeyID` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class ExternalKeyDeleteResponse:` + + - `required string ID` + + ID of the deleted External Key. + + - `JsonElement Type constant` + +#### Example + +```csharp +ExternalKeyDeleteParams parameters = new() +{ + ExternalKeyID = "external_key_id" +}; + +var externalKey = await client.Beta.Organization.ExternalKeys.Delete(parameters); + +Console.WriteLine(externalKey); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +`ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Parameters + +- `ExternalKeyValidateParams parameters` + + - `required string externalKeyID` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class ExternalKeyValidateResponse:` + + Result of a validation roundtrip against the customer's KMS. + + HTTP 200 for both outcomes — the operation completed; `status` says + whether the key works. + + - `required string? Error` + + Error message when status is `failure`. Null otherwise. + + - `required Status Status` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `Failure` + + - `Success` + + - `JsonElement Type constant` + +#### Example + +```csharp +ExternalKeyValidateParams parameters = new() +{ + ExternalKeyID = "external_key_id" +}; + +var response = await client.Beta.Organization.ExternalKeys.Validate(parameters); + +Console.WriteLine(response); +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +`BetaFederationIssuer Beta.Organization.Federation.Issuers.Create(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Parameters + +- `IssuerCreateParams parameters` + + - `required string issuerUrl` + + Body param: The `iss` claim value to match against. + + minLength: 1 + + - `required string name` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `bool? checkJti` + + Body param: Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `Jwks jwks` + + Body param: How signing keys are obtained. Defaults to OIDC discovery. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonElement Type constant` + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `string? DiscoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonElement Type constant` + + - `required string Url` + + JWKS endpoint. + + minLength: 1 + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `required IReadOnlyList> Keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonElement Type constant` + + - `long? maxJwtLifetimeSeconds` + + Body param: Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `required string ID` + + Tagged ID of the federation issuer. + + - `required DateTimeOffset? ArchivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `required bool CheckJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `required DateTimeOffset CreatedAt` + + When this issuer was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `required string IssuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `required Jwks Jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonElement Type constant` + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `string? DiscoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonElement Type constant` + + - `required string Url` + + JWKS endpoint. + + minLength: 1 + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `required IReadOnlyList> Keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonElement Type constant` + + - `required DateTimeOffset? JwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `required long MaxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required BetaFederationIssuerPollStatus? PollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `required long ConsecutiveFailures` + + Consecutive fetch failures since the last success. + + - `required DateTimeOffset? LastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `required DateTimeOffset? NextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this issuer was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```csharp +IssuerCreateParams parameters = new() +{ + IssuerUrl = "x", + Name = "x", +}; + +var betaFederationIssuer = await client.Beta.Organization.Federation.Issuers.Create(parameters); + +Console.WriteLine(betaFederationIssuer); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +`IssuerListPageResponse Beta.Organization.Federation.Issuers.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Parameters + +- `IssuerListParams parameters` + + - `bool includeArchived` + + Query param: Include archived resources. Defaults to false. + + - `long limit` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `string? page` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class IssuerListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string ID` + + Tagged ID of the federation issuer. + + - `required DateTimeOffset? ArchivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `required bool CheckJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `required DateTimeOffset CreatedAt` + + When this issuer was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `required string IssuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `required Jwks Jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonElement Type constant` + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `string? DiscoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonElement Type constant` + + - `required string Url` + + JWKS endpoint. + + minLength: 1 + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `required IReadOnlyList> Keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonElement Type constant` + + - `required DateTimeOffset? JwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `required long MaxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required BetaFederationIssuerPollStatus? PollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `required long ConsecutiveFailures` + + Consecutive fetch failures since the last success. + + - `required DateTimeOffset? LastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `required DateTimeOffset? NextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this issuer was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + + - `required string? NextPage` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```csharp +IssuerListParams parameters = new(); + +var page = await client.Beta.Organization.Federation.Issuers.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +`BetaFederationIssuer Beta.Organization.Federation.Issuers.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Parameters + +- `IssuerRetrieveParams parameters` + + - `required string federationIssuerID` + + ID of the federation issuer. + + - `IReadOnlyList betas` + + Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `required string ID` + + Tagged ID of the federation issuer. + + - `required DateTimeOffset? ArchivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `required bool CheckJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `required DateTimeOffset CreatedAt` + + When this issuer was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `required string IssuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `required Jwks Jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonElement Type constant` + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `string? DiscoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonElement Type constant` + + - `required string Url` + + JWKS endpoint. + + minLength: 1 + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `required IReadOnlyList> Keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonElement Type constant` + + - `required DateTimeOffset? JwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `required long MaxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required BetaFederationIssuerPollStatus? PollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `required long ConsecutiveFailures` + + Consecutive fetch failures since the last success. + + - `required DateTimeOffset? LastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `required DateTimeOffset? NextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this issuer was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```csharp +IssuerRetrieveParams parameters = new() +{ + FederationIssuerID = "federation_issuer_id" +}; + +var betaFederationIssuer = await client.Beta.Organization.Federation.Issuers.Retrieve(parameters); + +Console.WriteLine(betaFederationIssuer); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +`BetaFederationIssuer Beta.Organization.Federation.Issuers.Update(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Parameters + +- `IssuerUpdateParams parameters` + + - `required string federationIssuerID` + + Path param: ID of the federation issuer to update. + + - `bool? checkJti` + + Body param: Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `string? issuerUrl` + + Body param: Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + + - `Jwks? jwks` + + Body param: Replaces the entire JWKS configuration. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonElement Type constant` + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `string? DiscoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonElement Type constant` + + - `required string Url` + + JWKS endpoint. + + minLength: 1 + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `required IReadOnlyList> Keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonElement Type constant` + + - `bool? jwksPollingDisabled` + + Body param: Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + + - `long? maxJwtLifetimeSeconds` + + Body param: Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + + - `string? name` + + Body param: Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `required string ID` + + Tagged ID of the federation issuer. + + - `required DateTimeOffset? ArchivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `required bool CheckJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `required DateTimeOffset CreatedAt` + + When this issuer was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `required string IssuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `required Jwks Jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonElement Type constant` + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `string? DiscoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonElement Type constant` + + - `required string Url` + + JWKS endpoint. + + minLength: 1 + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `required IReadOnlyList> Keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonElement Type constant` + + - `required DateTimeOffset? JwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `required long MaxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required BetaFederationIssuerPollStatus? PollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `required long ConsecutiveFailures` + + Consecutive fetch failures since the last success. + + - `required DateTimeOffset? LastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `required DateTimeOffset? NextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this issuer was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```csharp +IssuerUpdateParams parameters = new() +{ + FederationIssuerID = "federation_issuer_id" +}; + +var betaFederationIssuer = await client.Beta.Organization.Federation.Issuers.Update(parameters); + +Console.WriteLine(betaFederationIssuer); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +`BetaFederationIssuer Beta.Organization.Federation.Issuers.Archive(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Parameters + +- `IssuerArchiveParams parameters` + + - `required string federationIssuerID` + + ID of the federation issuer to archive. + + - `IReadOnlyList betas` + + Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `required string ID` + + Tagged ID of the federation issuer. + + - `required DateTimeOffset? ArchivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `required bool CheckJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `required DateTimeOffset CreatedAt` + + When this issuer was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `required string IssuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `required Jwks Jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonElement Type constant` + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `string? DiscoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonElement Type constant` + + - `required string Url` + + JWKS endpoint. + + minLength: 1 + + - `string? CACertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `required IReadOnlyList> Keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonElement Type constant` + + - `required DateTimeOffset? JwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `required long MaxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required BetaFederationIssuerPollStatus? PollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `required long ConsecutiveFailures` + + Consecutive fetch failures since the last success. + + - `required DateTimeOffset? LastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `required DateTimeOffset? NextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this issuer was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```csharp +IssuerArchiveParams parameters = new() +{ + FederationIssuerID = "federation_issuer_id" +}; + +var betaFederationIssuer = await client.Beta.Organization.Federation.Issuers.Archive(parameters); + +Console.WriteLine(betaFederationIssuer); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +`BetaFederationRule Beta.Organization.Federation.Rules.Create(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Parameters + +- `RuleCreateParams parameters` + + - `required string issuerID` + + Body param: Tagged ID of the federation issuer. + + - `required BetaFederationRuleMatch match` + + Body param: Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `required string name` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `required string oauthScope` + + Body param: Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + + - `required BetaServiceAccountTarget target` + + Body param: Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `bool appliesToAllWorkspaces` + + Body param: When true, enable this rule for every workspace in the org (including workspaces created later). + + - `IReadOnlyDictionary? attributes` + + Body param: CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + + - `string? description` + + Body param: Optional free-text description. + + maxLength: 2000 + + - `long tokenLifetimeSeconds` + + Body param: Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + + - `string? workspaceID` + + Body param: Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `required string ID` + + Tagged ID of the federation rule. + + - `required bool AppliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `required DateTimeOffset? ArchivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `required IReadOnlyDictionary? Attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `required DateTimeOffset CreatedAt` + + When this rule was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `required string? Description` + + Optional free-text description. + + - `required string IssuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `required string? IssuerName` + + Issuer's display name at read time. + + - `required BetaFederationRuleMatch Match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string? Audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `IReadOnlyDictionary? Claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `string? Condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `string? SubjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `required string Name` + + Admin-chosen slug identifier. + + - `required string OAuthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `required BetaServiceAccountTarget Target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `required string ServiceAccountID` + + Tagged ID of the service account to mint tokens for. + + - `JsonElement Type constant` + + - `string? ServiceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `required long TokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this rule was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `required string? WorkspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `required IReadOnlyList WorkspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```csharp +RuleCreateParams parameters = new() +{ + IssuerID = "issuer_id", + Match = new() + { + Audience = "audience", + Claims = new Dictionary() { { "foo", "string" } }, + Condition = "condition", + SubjectPrefix = "subject_prefix", + }, + Name = "x", + OAuthScope = "x", + Target = new() + { + ServiceAccountID = "svac_01SDCCSbTxrXDpWc1phhtcfK", + ServiceAccountName = "service_account_name", + }, +}; + +var betaFederationRule = await client.Beta.Organization.Federation.Rules.Create(parameters); + +Console.WriteLine(betaFederationRule); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +`RuleListPageResponse Beta.Organization.Federation.Rules.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Parameters + +- `RuleListParams parameters` + + - `bool includeArchived` + + Query param: Include archived resources. Defaults to false. + + - `string? issuerID` + + Query param: Filter to rules referencing this federation issuer. + + - `long limit` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `string? page` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class RuleListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string ID` + + Tagged ID of the federation rule. + + - `required bool AppliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `required DateTimeOffset? ArchivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `required IReadOnlyDictionary? Attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `required DateTimeOffset CreatedAt` + + When this rule was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `required string? Description` + + Optional free-text description. + + - `required string IssuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `required string? IssuerName` + + Issuer's display name at read time. + + - `required BetaFederationRuleMatch Match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string? Audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `IReadOnlyDictionary? Claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `string? Condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `string? SubjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `required string Name` + + Admin-chosen slug identifier. + + - `required string OAuthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `required BetaServiceAccountTarget Target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `required string ServiceAccountID` + + Tagged ID of the service account to mint tokens for. + + - `JsonElement Type constant` + + - `string? ServiceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `required long TokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this rule was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `required string? WorkspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `required IReadOnlyList WorkspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + + - `required string? NextPage` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```csharp +RuleListParams parameters = new(); + +var page = await client.Beta.Organization.Federation.Rules.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +`BetaFederationRule Beta.Organization.Federation.Rules.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Parameters + +- `RuleRetrieveParams parameters` + + - `required string federationRuleID` + + ID of the federation rule. + + - `IReadOnlyList betas` + + Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `required string ID` + + Tagged ID of the federation rule. + + - `required bool AppliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `required DateTimeOffset? ArchivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `required IReadOnlyDictionary? Attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `required DateTimeOffset CreatedAt` + + When this rule was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `required string? Description` + + Optional free-text description. + + - `required string IssuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `required string? IssuerName` + + Issuer's display name at read time. + + - `required BetaFederationRuleMatch Match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string? Audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `IReadOnlyDictionary? Claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `string? Condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `string? SubjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `required string Name` + + Admin-chosen slug identifier. + + - `required string OAuthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `required BetaServiceAccountTarget Target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `required string ServiceAccountID` + + Tagged ID of the service account to mint tokens for. + + - `JsonElement Type constant` + + - `string? ServiceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `required long TokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this rule was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `required string? WorkspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `required IReadOnlyList WorkspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```csharp +RuleRetrieveParams parameters = new() +{ + FederationRuleID = "federation_rule_id" +}; + +var betaFederationRule = await client.Beta.Organization.Federation.Rules.Retrieve(parameters); + +Console.WriteLine(betaFederationRule); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +`BetaFederationRule Beta.Organization.Federation.Rules.Update(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `RuleUpdateParams parameters` + + - `required string federationRuleID` + + Path param: ID of the federation rule to update. + + - `bool? appliesToAllWorkspaces` + + Body param: When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + + - `IReadOnlyDictionary? attributes` + + Body param: Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + + - `string? description` + + Body param: Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + + - `BetaFederationRuleMatch? match` + + Body param: Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `string? name` + + Body param: Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `string? oauthScope` + + Body param: Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + + - `BetaServiceAccountTarget? target` + + Body param: Bind to a fixed service account by ID. + + - `long? tokenLifetimeSeconds` + + Body param: Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + + - `string? workspaceID` + + Body param: Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `required string ID` + + Tagged ID of the federation rule. + + - `required bool AppliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `required DateTimeOffset? ArchivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `required IReadOnlyDictionary? Attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `required DateTimeOffset CreatedAt` + + When this rule was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `required string? Description` + + Optional free-text description. + + - `required string IssuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `required string? IssuerName` + + Issuer's display name at read time. + + - `required BetaFederationRuleMatch Match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string? Audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `IReadOnlyDictionary? Claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `string? Condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `string? SubjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `required string Name` + + Admin-chosen slug identifier. + + - `required string OAuthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `required BetaServiceAccountTarget Target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `required string ServiceAccountID` + + Tagged ID of the service account to mint tokens for. + + - `JsonElement Type constant` + + - `string? ServiceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `required long TokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this rule was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `required string? WorkspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `required IReadOnlyList WorkspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```csharp +RuleUpdateParams parameters = new() { FederationRuleID = "federation_rule_id" }; + +var betaFederationRule = await client.Beta.Organization.Federation.Rules.Update(parameters); + +Console.WriteLine(betaFederationRule); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +`BetaFederationRule Beta.Organization.Federation.Rules.Archive(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `RuleArchiveParams parameters` + + - `required string federationRuleID` + + ID of the federation rule to archive. + + - `IReadOnlyList betas` + + Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `required string ID` + + Tagged ID of the federation rule. + + - `required bool AppliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `required DateTimeOffset? ArchivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `required IReadOnlyDictionary? Attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `required DateTimeOffset CreatedAt` + + When this rule was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `required string? Description` + + Optional free-text description. + + - `required string IssuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `required string? IssuerName` + + Issuer's display name at read time. + + - `required BetaFederationRuleMatch Match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string? Audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `IReadOnlyDictionary? Claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `string? Condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `string? SubjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `required string Name` + + Admin-chosen slug identifier. + + - `required string OAuthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `required BetaServiceAccountTarget Target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `required string ServiceAccountID` + + Tagged ID of the service account to mint tokens for. + + - `JsonElement Type constant` + + - `string? ServiceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `required long TokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this rule was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `required string? WorkspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `required IReadOnlyList WorkspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```csharp +RuleArchiveParams parameters = new() +{ + FederationRuleID = "federation_rule_id" +}; + +var betaFederationRule = await client.Beta.Organization.Federation.Rules.Archive(parameters); + +Console.WriteLine(betaFederationRule); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +`BetaFederationRuleWorkspace Beta.Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `WorkspaceAddParams parameters` + + - `required string federationRuleID` + + Path param: ID of the federation rule. + + - `required string workspaceID` + + Body param: Tagged ID of the workspace to enable this rule for. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaFederationRuleWorkspace:` + + - `required DateTimeOffset CreatedAt` + + When this workspace was enabled for the rule. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `required string FederationRuleID` + + Tagged ID of the federation rule. + + - `JsonElement Type constant` + + - `required string WorkspaceID` + + Tagged ID of the workspace this rule is enabled for. + + - `required string? WorkspaceName` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```csharp +WorkspaceAddParams parameters = new() +{ + FederationRuleID = "federation_rule_id", + WorkspaceID = "workspace_id", +}; + +var betaFederationRuleWorkspace = await client.Beta.Organization.Federation.Rules.Workspaces.Add(parameters); + +Console.WriteLine(betaFederationRuleWorkspace); +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +`WorkspaceListPageResponse Beta.Organization.Federation.Rules.Workspaces.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Parameters + +- `WorkspaceListParams parameters` + + - `required string federationRuleID` + + Path param: ID of the federation rule. + + - `long limit` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `string? page` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class WorkspaceListPageResponse:` + + - `required IReadOnlyList Data` + + - `required DateTimeOffset CreatedAt` + + When this workspace was enabled for the rule. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `required string FederationRuleID` + + Tagged ID of the federation rule. + + - `JsonElement Type constant` + + - `required string WorkspaceID` + + Tagged ID of the workspace this rule is enabled for. + + - `required string? WorkspaceName` + + Workspace display name. Populated when listing; null in the enable response. + + - `required string? NextPage` + + Opaque cursor for the next page; null when there are no more results. + +#### Example + +```csharp +WorkspaceListParams parameters = new() +{ + FederationRuleID = "federation_rule_id" +}; + +var page = await client.Beta.Organization.Federation.Rules.Workspaces.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +`WorkspaceRemoveResponse Beta.Organization.Federation.Rules.Workspaces.Remove(parameters, cancellationToken = default)` + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `WorkspaceRemoveParams parameters` + + - `required string federationRuleID` + + Path param: ID of the federation rule. + + - `required string workspaceID` + + Path param: ID of the workspace to disable for. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class WorkspaceRemoveResponse:` + + - `required string FederationRuleID` + + Tagged ID of the federation rule. + + - `JsonElement Type constant` + + - `required string WorkspaceID` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```csharp +WorkspaceRemoveParams parameters = new() +{ + FederationRuleID = "federation_rule_id", + WorkspaceID = "workspace_id", +}; + +var workspace = await client.Beta.Organization.Federation.Rules.Workspaces.Remove(parameters); + +Console.WriteLine(workspace); +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +`BetaOrganizationInvite Beta.Organization.Invites.Create(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Parameters + +- `InviteCreateParams parameters` + + - `required string email` + + Email of the User. + + format: email + + - `required Role role` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `Billing` + + - `ClaudeCodeUser` + + - `Developer` + + - `Managed` + + - `User` + + - `IReadOnlyList rbacGroupIds` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `class BetaOrganizationInvite:` + + - `required string ID` + + ID of the Invite. + + - `required DateTimeOffset? AcceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `required string Email` + + Email of the User being invited. + + - `required DateTimeOffset ExpiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `required DateTimeOffset InvitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `required IReadOnlyList RbacGroupIds` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `required BetaOrganizationRole Role` + + Organization role of the User. + + - `Admin` + + - `Billing` + + - `ClaudeCodeUser` + + - `Developer` + + - `Managed` + + - `MembershipAdmin` + + - `Owner` + + - `PrimaryOwner` + + - `User` + + - `required Status Status` + + Status of the Invite. + + - `Accepted` + + - `Deleted` + + - `Expired` + + - `Pending` + + - `JsonElement Type constant` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```csharp +InviteCreateParams parameters = new() +{ + Email = "user@emaildomain.com", + Role = Role.User, +}; + +var betaOrganizationInvite = await client.Beta.Organization.Invites.Create(parameters); + +Console.WriteLine(betaOrganizationInvite); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +`InviteListPageResponse Beta.Organization.Invites.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Parameters + +- `InviteListParams parameters` + + - `string afterID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `string beforeID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `string email` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + + - `long limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `IReadOnlyList roles` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + + - `IReadOnlyList statuses` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `Accepted` + + - `Expired` + + - `Pending` + +#### Returns + +- `class InviteListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string ID` + + ID of the Invite. + + - `required DateTimeOffset? AcceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `required string Email` + + Email of the User being invited. + + - `required DateTimeOffset ExpiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `required DateTimeOffset InvitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `required IReadOnlyList RbacGroupIds` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `required BetaOrganizationRole Role` + + Organization role of the User. + + - `Admin` + + - `Billing` + + - `ClaudeCodeUser` + + - `Developer` + + - `Managed` + + - `MembershipAdmin` + + - `Owner` + + - `PrimaryOwner` + + - `User` + + - `required Status Status` + + Status of the Invite. + + - `Accepted` + + - `Deleted` + + - `Expired` + + - `Pending` + + - `JsonElement Type constant` + + Object type. + + For Invites, this is always `"invite"`. + + - `required string? FirstID` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `required bool HasMore` + + Indicates if there are more results in the requested page direction. + + - `required string? LastID` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```csharp +InviteListParams parameters = new(); + +var page = await client.Beta.Organization.Invites.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +`BetaOrganizationInvite Beta.Organization.Invites.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Parameters + +- `InviteRetrieveParams parameters` + + - `required string inviteID` + + ID of the Invite. + +#### Returns + +- `class BetaOrganizationInvite:` + + - `required string ID` + + ID of the Invite. + + - `required DateTimeOffset? AcceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `required string Email` + + Email of the User being invited. + + - `required DateTimeOffset ExpiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `required DateTimeOffset InvitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `required IReadOnlyList RbacGroupIds` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `required BetaOrganizationRole Role` + + Organization role of the User. + + - `Admin` + + - `Billing` + + - `ClaudeCodeUser` + + - `Developer` + + - `Managed` + + - `MembershipAdmin` + + - `Owner` + + - `PrimaryOwner` + + - `User` + + - `required Status Status` + + Status of the Invite. + + - `Accepted` + + - `Deleted` + + - `Expired` + + - `Pending` + + - `JsonElement Type constant` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```csharp +InviteRetrieveParams parameters = new() { InviteID = "invite_id" }; + +var betaOrganizationInvite = await client.Beta.Organization.Invites.Retrieve(parameters); + +Console.WriteLine(betaOrganizationInvite); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +`InviteDeleteResponse Beta.Organization.Invites.Delete(parameters, cancellationToken = default)` + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Parameters + +- `InviteDeleteParams parameters` + + - `required string inviteID` + + ID of the Invite. + +#### Returns + +- `class InviteDeleteResponse:` + + - `required string ID` + + ID of the Invite. + + - `JsonElement Type constant` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + +#### Example + +```csharp +InviteDeleteParams parameters = new() { InviteID = "invite_id" }; + +var invite = await client.Beta.Organization.Invites.Delete(parameters); + +Console.WriteLine(invite); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +`BetaServiceAccount Beta.Organization.ServiceAccounts.Create(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Parameters + +- `ServiceAccountCreateParams parameters` + + - `required string name` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `string? description` + + Body param: Optional free-text description. + + maxLength: 2000 + + - `OrganizationRole organizationRole` + + Body param: Org-level role. Defaults to `developer`. + + - `Admin` + + - `Developer` + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `required string ID` + + Tagged ID of the service account. + + - `required DateTimeOffset? ArchivedAt` + + If set, this service account is archived. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `required DateTimeOffset CreatedAt` + + When this service account was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `required string? Description` + + Optional free-text description. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required OrganizationRole OrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `Admin` + + - `Developer` + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this service account was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```csharp +ServiceAccountCreateParams parameters = new() { Name = "ci-deploy-bot" }; + +var betaServiceAccount = await client.Beta.Organization.ServiceAccounts.Create(parameters); + +Console.WriteLine(betaServiceAccount); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +`ServiceAccountListPageResponse Beta.Organization.ServiceAccounts.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Parameters + +- `ServiceAccountListParams parameters` + + - `bool includeArchived` + + Query param: Include archived resources. Defaults to false. + + - `long limit` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `string? page` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class ServiceAccountListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string ID` + + Tagged ID of the service account. + + - `required DateTimeOffset? ArchivedAt` + + If set, this service account is archived. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `required DateTimeOffset CreatedAt` + + When this service account was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `required string? Description` + + Optional free-text description. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required OrganizationRole OrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `Admin` + + - `Developer` + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this service account was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + + - `required string? NextPage` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```csharp +ServiceAccountListParams parameters = new(); + +var page = await client.Beta.Organization.ServiceAccounts.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +`BetaServiceAccount Beta.Organization.ServiceAccounts.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Parameters + +- `ServiceAccountRetrieveParams parameters` + + - `required string serviceAccountID` + + ID of the service account. + + - `IReadOnlyList betas` + + Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `required string ID` + + Tagged ID of the service account. + + - `required DateTimeOffset? ArchivedAt` + + If set, this service account is archived. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `required DateTimeOffset CreatedAt` + + When this service account was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `required string? Description` + + Optional free-text description. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required OrganizationRole OrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `Admin` + + - `Developer` + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this service account was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```csharp +ServiceAccountRetrieveParams parameters = new() +{ + ServiceAccountID = "service_account_id" +}; + +var betaServiceAccount = await client.Beta.Organization.ServiceAccounts.Retrieve(parameters); + +Console.WriteLine(betaServiceAccount); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +`BetaServiceAccount Beta.Organization.ServiceAccounts.Update(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Parameters + +- `ServiceAccountUpdateParams parameters` + + - `required string serviceAccountID` + + Path param: ID of the service account to update. + + - `string? description` + + Body param: Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + + - `OrganizationRole? organizationRole` + + Body param: Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `Admin` + + - `Developer` + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `required string ID` + + Tagged ID of the service account. + + - `required DateTimeOffset? ArchivedAt` + + If set, this service account is archived. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `required DateTimeOffset CreatedAt` + + When this service account was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `required string? Description` + + Optional free-text description. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required OrganizationRole OrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `Admin` + + - `Developer` + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this service account was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```csharp +ServiceAccountUpdateParams parameters = new() +{ + ServiceAccountID = "service_account_id" +}; + +var betaServiceAccount = await client.Beta.Organization.ServiceAccounts.Update(parameters); + +Console.WriteLine(betaServiceAccount); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +`BetaServiceAccount Beta.Organization.ServiceAccounts.Archive(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Parameters + +- `ServiceAccountArchiveParams parameters` + + - `required string serviceAccountID` + + ID of the service account to archive. + + - `IReadOnlyList betas` + + Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `required string ID` + + Tagged ID of the service account. + + - `required DateTimeOffset? ArchivedAt` + + If set, this service account is archived. + + format: date-time + + - `required string? ArchivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `required DateTimeOffset CreatedAt` + + When this service account was created. + + format: date-time + + - `required string? CreatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `required string? Description` + + Optional free-text description. + + - `required string Name` + + Admin-chosen slug identifier. + + - `required OrganizationRole OrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `Admin` + + - `Developer` + + - `JsonElement Type constant` + + - `required DateTimeOffset UpdatedAt` + + When this service account was last updated. + + format: date-time + + - `required string? UpdatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```csharp +ServiceAccountArchiveParams parameters = new() +{ + ServiceAccountID = "service_account_id" +}; + +var betaServiceAccount = await client.Beta.Organization.ServiceAccounts.Archive(parameters); + +Console.WriteLine(betaServiceAccount); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +`BetaServiceAccountWorkspaceMember Beta.Organization.ServiceAccounts.Workspaces.Add(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Parameters + +- `WorkspaceAddParams parameters` + + - `required string serviceAccountID` + + Path param: ID of the service account. + + - `required string workspaceID` + + Body param: Tagged workspace ID to add the service account to. + + - `required BetaNoBillingWorkspaceRole workspaceRole` + + Body param: Role to assign to the service account in this workspace. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaServiceAccountWorkspaceMember:` + + - `required string? CreatedByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `required bool? Implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `required string ServiceAccountID` + + Tagged service account ID (`svac_...`). + + - `JsonElement Type constant` + + - `required string WorkspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` + +#### Example + +```csharp +WorkspaceAddParams parameters = new() +{ + ServiceAccountID = "service_account_id", + WorkspaceID = "workspace_id", + WorkspaceRole = BetaNoBillingWorkspaceRole.WorkspaceAdmin, +}; + +var betaServiceAccountWorkspaceMember = await client.Beta.Organization.ServiceAccounts.Workspaces.Add(parameters); + +Console.WriteLine(betaServiceAccountWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +`WorkspaceListPageResponse Beta.Organization.ServiceAccounts.Workspaces.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Parameters + +- `WorkspaceListParams parameters` + + - `required string serviceAccountID` + + Path param: ID of the service account. + + - `long limit` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `string? page` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class WorkspaceListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string? CreatedByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `required bool? Implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `required string ServiceAccountID` + + Tagged service account ID (`svac_...`). + + - `JsonElement Type constant` + + - `required string WorkspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` + + - `required string? NextPage` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```csharp +WorkspaceListParams parameters = new() +{ + ServiceAccountID = "service_account_id" +}; + +var page = await client.Beta.Organization.ServiceAccounts.Workspaces.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +`WorkspaceRemoveResponse Beta.Organization.ServiceAccounts.Workspaces.Remove(parameters, cancellationToken = default)` + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Parameters + +- `WorkspaceRemoveParams parameters` + + - `required string serviceAccountID` + + Path param: ID of the service account. + + - `required string workspaceID` + + Path param: ID of the workspace. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class WorkspaceRemoveResponse:` + + - `required string ServiceAccountID` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `JsonElement Type constant` + + - `required string WorkspaceID` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```csharp +WorkspaceRemoveParams parameters = new() +{ + ServiceAccountID = "service_account_id", + WorkspaceID = "workspace_id", +}; + +var workspace = await client.Beta.Organization.ServiceAccounts.Workspaces.Remove(parameters); + +Console.WriteLine(workspace); +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +`UserListPageResponse Beta.Organization.Users.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Parameters + +- `UserListParams parameters` + + - `string afterID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `string beforeID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `string email` + + Filter by user email. + + format: email + + - `long limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `IReadOnlyList roles` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `class UserListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string ID` + + ID of the User. + + - `required DateTimeOffset AddedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `required string Email` + + Email of the User. + + - `required string Name` + + Name of the User. + + - `required BetaOrganizationRole Role` + + Organization role of the User. + + - `Admin` + + - `Billing` + + - `ClaudeCodeUser` + + - `Developer` + + - `Managed` + + - `MembershipAdmin` + + - `Owner` + + - `PrimaryOwner` + + - `User` + + - `JsonElement Type constant` + + Object type. + + For Users, this is always `"user"`. + + - `required string? FirstID` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `required bool HasMore` + + Indicates if there are more results in the requested page direction. + + - `required string? LastID` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```csharp +UserListParams parameters = new(); + +var page = await client.Beta.Organization.Users.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +`BetaOrganizationUser Beta.Organization.Users.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Parameters + +- `UserRetrieveParams parameters` + + - `required string userID` + + ID of the User. + +#### Returns + +- `class BetaOrganizationUser:` + + - `required string ID` + + ID of the User. + + - `required DateTimeOffset AddedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `required string Email` + + Email of the User. + + - `required string Name` + + Name of the User. + + - `required BetaOrganizationRole Role` + + Organization role of the User. + + - `Admin` + + - `Billing` + + - `ClaudeCodeUser` + + - `Developer` + + - `Managed` + + - `MembershipAdmin` + + - `Owner` + + - `PrimaryOwner` + + - `User` + + - `JsonElement Type constant` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```csharp +UserRetrieveParams parameters = new() { UserID = "user_id" }; + +var betaOrganizationUser = await client.Beta.Organization.Users.Retrieve(parameters); + +Console.WriteLine(betaOrganizationUser); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +`BetaOrganizationUser Beta.Organization.Users.Update(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Parameters + +- `UserUpdateParams parameters` + + - `required string userID` + + ID of the User. + + - `required Role role` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `Billing` + + - `ClaudeCodeUser` + + - `Developer` + + - `Managed` + + - `User` + +#### Returns + +- `class BetaOrganizationUser:` + + - `required string ID` + + ID of the User. + + - `required DateTimeOffset AddedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `required string Email` + + Email of the User. + + - `required string Name` + + Name of the User. + + - `required BetaOrganizationRole Role` + + Organization role of the User. + + - `Admin` + + - `Billing` + + - `ClaudeCodeUser` + + - `Developer` + + - `Managed` + + - `MembershipAdmin` + + - `Owner` + + - `PrimaryOwner` + + - `User` + + - `JsonElement Type constant` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```csharp +UserUpdateParams parameters = new() +{ + UserID = "user_id", + Role = Role.User, +}; + +var betaOrganizationUser = await client.Beta.Organization.Users.Update(parameters); + +Console.WriteLine(betaOrganizationUser); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +`UserRemoveResponse Beta.Organization.Users.Remove(parameters, cancellationToken = default)` + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Parameters + +- `UserRemoveParams parameters` + + - `required string userID` + + ID of the User. + +#### Returns + +- `class UserRemoveResponse:` + + - `required string ID` + + ID of the User. + + - `JsonElement Type constant` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + +#### Example + +```csharp +UserRemoveParams parameters = new() { UserID = "user_id" }; + +var user = await client.Beta.Organization.Users.Remove(parameters); + +Console.WriteLine(user); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +`WorkspaceListPageResponse Beta.Organization.Workspaces.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Parameters + +- `WorkspaceListParams parameters` + + - `string afterID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `string beforeID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `bool includeArchived` + + Whether to include Workspaces that have been archived in the response + + - `long limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `class WorkspaceListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string ID` + + ID of the Workspace. + + - `required DateTimeOffset? ArchivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `required string CompartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `required DateTimeOffset CreatedAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `required BetaDataResidency DataResidency` + + Data residency configuration. + + - `required AllowedInferenceGeos AllowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `IReadOnlyList` + + - `class Unrestricted:` + + - `required string DefaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `required string WorkspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `required string DisplayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `required string? ExternalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `required string Name` + + Name of the Workspace. + + - `required IReadOnlyDictionary Tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonElement Type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + + - `required string? FirstID` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `required bool HasMore` + + Indicates if there are more results in the requested page direction. + + - `required string? LastID` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```csharp +WorkspaceListParams parameters = new(); + +var page = await client.Beta.Organization.Workspaces.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +`BetaWorkspace Beta.Organization.Workspaces.Create(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Parameters + +- `WorkspaceCreateParams parameters` + + - `required string name` + + Body param: Name of the Workspace. + + maxLength: 40, minLength: 1 + + - `BetaDataResidencyCreateConfig? dataResidency` + + Body param: Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `string? displayColor` + + Body param: Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + + - `string? externalKeyID` + + Body param: ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `IReadOnlyDictionary? tags` + + Body param: User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class BetaWorkspace:` + + - `required string ID` + + ID of the Workspace. + + - `required DateTimeOffset? ArchivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `required string CompartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `required DateTimeOffset CreatedAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `required BetaDataResidency DataResidency` + + Data residency configuration. + + - `required AllowedInferenceGeos AllowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `IReadOnlyList` + + - `class Unrestricted:` + + - `required string DefaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `required string WorkspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `required string DisplayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `required string? ExternalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `required string Name` + + Name of the Workspace. + + - `required IReadOnlyDictionary Tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonElement Type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```csharp +WorkspaceCreateParams parameters = new() { Name = "x" }; + +var betaWorkspace = await client.Beta.Organization.Workspaces.Create(parameters); + +Console.WriteLine(betaWorkspace); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +`BetaWorkspace Beta.Organization.Workspaces.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Parameters + +- `WorkspaceRetrieveParams parameters` + + - `required string workspaceID` + + ID of the Workspace. + +#### Returns + +- `class BetaWorkspace:` + + - `required string ID` + + ID of the Workspace. + + - `required DateTimeOffset? ArchivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `required string CompartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `required DateTimeOffset CreatedAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `required BetaDataResidency DataResidency` + + Data residency configuration. + + - `required AllowedInferenceGeos AllowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `IReadOnlyList` + + - `class Unrestricted:` + + - `required string DefaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `required string WorkspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `required string DisplayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `required string? ExternalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `required string Name` + + Name of the Workspace. + + - `required IReadOnlyDictionary Tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonElement Type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```csharp +WorkspaceRetrieveParams parameters = new() { WorkspaceID = "workspace_id" }; + +var betaWorkspace = await client.Beta.Organization.Workspaces.Retrieve(parameters); + +Console.WriteLine(betaWorkspace); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +`BetaWorkspace Beta.Organization.Workspaces.Update(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Parameters + +- `WorkspaceUpdateParams parameters` + + - `required string workspaceID` + + - `BetaDataResidencyUpdateConfig? dataResidency` + + Data residency configuration for the workspace. + + - `string displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + + - `string externalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `string name` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + + - `IReadOnlyDictionary? tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `class BetaWorkspace:` + + - `required string ID` + + ID of the Workspace. + + - `required DateTimeOffset? ArchivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `required string CompartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `required DateTimeOffset CreatedAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `required BetaDataResidency DataResidency` + + Data residency configuration. + + - `required AllowedInferenceGeos AllowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `IReadOnlyList` + + - `class Unrestricted:` + + - `required string DefaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `required string WorkspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `required string DisplayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `required string? ExternalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `required string Name` + + Name of the Workspace. + + - `required IReadOnlyDictionary Tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonElement Type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```csharp +WorkspaceUpdateParams parameters = new() { WorkspaceID = "workspace_id" }; + +var betaWorkspace = await client.Beta.Organization.Workspaces.Update(parameters); + +Console.WriteLine(betaWorkspace); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +`BetaWorkspace Beta.Organization.Workspaces.Archive(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Parameters + +- `WorkspaceArchiveParams parameters` + + - `required string workspaceID` + +#### Returns + +- `class BetaWorkspace:` + + - `required string ID` + + ID of the Workspace. + + - `required DateTimeOffset? ArchivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `required string CompartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `required DateTimeOffset CreatedAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `required BetaDataResidency DataResidency` + + Data residency configuration. + + - `required AllowedInferenceGeos AllowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `IReadOnlyList` + + - `class Unrestricted:` + + - `required string DefaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `required string WorkspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `required string DisplayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `required string? ExternalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `required string Name` + + Name of the Workspace. + + - `required IReadOnlyDictionary Tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonElement Type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```csharp +WorkspaceArchiveParams parameters = new() { WorkspaceID = "workspace_id" }; + +var betaWorkspace = await client.Beta.Organization.Workspaces.Archive(parameters); + +Console.WriteLine(betaWorkspace); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +`RateLimitListPageResponse Beta.Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `RateLimitListParams parameters` + + - `required string workspaceID` + + The ID of the workspace. + + - `GroupType? groupType` + + Filter by group type. + + - `Batch` + + - `Files` + + - `ModelGroup` + + - `Skills` + + - `TokenCount` + + - `WebSearch` + + - `long? limit` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + + - `string? page` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class RateLimitListPageResponse:` + + - `required IReadOnlyList Data` + + Rate-limit entries for the workspace, one per group that has at least one override. + + - `required GroupType GroupType` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `Batch` + + - `Files` + + - `ModelGroup` + + - `Skills` + + - `TokenCount` + + - `WebSearch` + + - `required IReadOnlyList Limits` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `required long? OrgLimit` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `required string Type` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `required long Value` + + The workspace-level override value for this limiter type. + + - `required IReadOnlyList? Models` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `required string RateLimitID` + + The `id` of the RateLimit group this override applies to. + + - `JsonElement Type constant` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + - `required string WorkspaceID` + + ID of the Workspace this override applies to. + + - `required string? NextPage` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. + +#### Example + +```csharp +RateLimitListParams parameters = new() { WorkspaceID = "workspace_id" }; + +var page = await client.Beta.Organization.Workspaces.RateLimits.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +`MemberListPageResponse Beta.Organization.Workspaces.Members.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Parameters + +- `MemberListParams parameters` + + - `required string workspaceID` + + ID of the Workspace. + + - `string afterID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `string beforeID` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `long limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `class MemberListPageResponse:` + + - `required IReadOnlyList Data` + + - `JsonElement Type constant` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `required string UserID` + + ID of the User. + + - `required string WorkspaceID` + + ID of the Workspace. + + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the Workspace Member. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` + + - `required string? FirstID` + + First ID in the `data` list. Can be used as the `before_id` for the previous page. + + - `required bool HasMore` + + Indicates if there are more results in the requested page direction. + + - `required string? LastID` + + Last ID in the `data` list. Can be used as the `after_id` for the next page. + +#### Example + +```csharp +MemberListParams parameters = new() { WorkspaceID = "workspace_id" }; + +var page = await client.Beta.Organization.Workspaces.Members.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +`BetaWorkspaceMember Beta.Organization.Workspaces.Members.Add(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Parameters + +- `MemberAddParams parameters` + + - `required string workspaceID` + + ID of the Workspace. + + - `required string userID` + + ID of the User. + + - `required BetaNoBillingWorkspaceRole workspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + +#### Returns + +- `class BetaWorkspaceMember:` + + - `JsonElement Type constant` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `required string UserID` + + ID of the User. + + - `required string WorkspaceID` + + ID of the Workspace. + + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the Workspace Member. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` + +#### Example + +```csharp +MemberAddParams parameters = new() +{ + WorkspaceID = "workspace_id", + UserID = "user_01WCz1FkmYMm4gnmykNKUu3Q", + WorkspaceRole = BetaNoBillingWorkspaceRole.WorkspaceAdmin, +}; + +var betaWorkspaceMember = await client.Beta.Organization.Workspaces.Members.Add(parameters); + +Console.WriteLine(betaWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +`BetaWorkspaceMember Beta.Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Parameters + +- `MemberRetrieveParams parameters` + + - `required string workspaceID` + + ID of the Workspace. + + - `required string userID` + + ID of the User. + +#### Returns + +- `class BetaWorkspaceMember:` + + - `JsonElement Type constant` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `required string UserID` + + ID of the User. + + - `required string WorkspaceID` + + ID of the Workspace. + + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the Workspace Member. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` + +#### Example + +```csharp +MemberRetrieveParams parameters = new() +{ + WorkspaceID = "workspace_id", + UserID = "user_id", +}; + +var betaWorkspaceMember = await client.Beta.Organization.Workspaces.Members.Retrieve(parameters); + +Console.WriteLine(betaWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +`BetaWorkspaceMember Beta.Organization.Workspaces.Members.Update(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Parameters + +- `MemberUpdateParams parameters` + + - `required string workspaceID` + + Path param: ID of the Workspace. + + - `required string userID` + + Path param: ID of the User. + + - `required BetaWorkspaceRole workspaceRole` + + Body param: New workspace role for the User. + +#### Returns + +- `class BetaWorkspaceMember:` + + - `JsonElement Type constant` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `required string UserID` + + ID of the User. + + - `required string WorkspaceID` + + ID of the Workspace. + + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the Workspace Member. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` + +#### Example + +```csharp +MemberUpdateParams parameters = new() +{ + WorkspaceID = "workspace_id", + UserID = "user_id", + WorkspaceRole = BetaWorkspaceRole.WorkspaceAdmin, +}; + +var betaWorkspaceMember = await client.Beta.Organization.Workspaces.Members.Update(parameters); + +Console.WriteLine(betaWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +`MemberRemoveResponse Beta.Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Parameters + +- `MemberRemoveParams parameters` + + - `required string workspaceID` + + ID of the Workspace. + + - `required string userID` + + ID of the User. + +#### Returns + +- `class MemberRemoveResponse:` + + - `JsonElement Type constant` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + - `required string UserID` + + ID of the User. + + - `required string WorkspaceID` + + ID of the Workspace. + +#### Example + +```csharp +MemberRemoveParams parameters = new() +{ + WorkspaceID = "workspace_id", + UserID = "user_id", +}; + +var member = await client.Beta.Organization.Workspaces.Members.Remove(parameters); + +Console.WriteLine(member); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +`ServiceAccountListPageResponse Beta.Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Parameters + +- `ServiceAccountListParams parameters` + + - `required string workspaceID` + + Path param: ID of the workspace. + + - `long limit` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `string? page` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + +#### Returns + +- `class ServiceAccountListPageResponse:` + + - `required IReadOnlyList Data` + + - `required string? CreatedByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `required bool? Implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `required string ServiceAccountID` + + Tagged service account ID (`svac_...`). + + - `JsonElement Type constant` + + - `required string WorkspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` + + - `required string? NextPage` + + Opaque cursor for the next page, or null if no more results. + +#### Example + +```csharp +ServiceAccountListParams parameters = new() { WorkspaceID = "workspace_id" }; + +var page = await client.Beta.Organization.Workspaces.ServiceAccounts.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +`BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Parameters + +- `ServiceAccountAddParams parameters` + + - `required string workspaceID` + + Path param: ID of the workspace. + + - `required string serviceAccountID` + + Body param: Tagged service account ID to add. + + - `required BetaNoBillingWorkspaceRole workspaceRole` + + Body param: Role to assign to the service account in this workspace. + + - `IReadOnlyList betas` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `MessageBatches2024_09_24` + + - `PromptCaching2024_07_31` + + - `ComputerUse2024_10_22` + + - `ComputerUse2025_01_24` + + - `Pdfs2024_09_25` + + - `TokenCounting2024_11_01` + + - `TokenEfficientTools2025_02_19` + + - `Output128k2025_02_19` + + - `FilesApi2025_04_14` + + - `McpClient2025_04_04` + + - `McpClient2025_11_20` + + - `DevFullThinking2025_05_14` + + - `InterleavedThinking2025_05_14` + + - `CodeExecution2025_05_22` + + - `ExtendedCacheTtl2025_04_11` + + - `Context1m2025_08_07` + + - `ContextManagement2025_06_27` + + - `ModelContextWindowExceeded2025_08_26` + + - `Skills2025_10_02` + + - `FastMode2026_02_01` + + - `Output300k2026_03_24` + + - `UserProfiles2026_03_24` + + - `UserProfiles2026_08_18` + + - `AdvisorTool2026_03_01` + + - `ManagedAgents2026_04_01` + + - `CacheDiagnosis2026_04_07` + + - `Dreaming2026_04_21` + + - `ThinkingTokenCount2026_05_13` + + - `ServerSideFallback2026_06_01` + + - `ServerSideFallback2026_07_01` + + - `FallbackCredit2026_06_01` + + - `FallbackCredit2026_07_01` + + - `AgentMemory2026_07_22` + + - `MidConversationToolChanges2026_07_01` + + - `Compact2026_01_12` -- `class BetaTunnelCertificate:` + - `ComputerUse2025_11_24` - A CA certificate attached to a tunnel. + - `McpTunnels2026_06_22` - - `required string ID` + - `StructuredOutputs2025_11_13` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `TaskBudgets2026_03_13` - - `required DateTimeOffset? ArchivedAt` + - `ThinkingDisplayUpdates2026_08_18` - A timestamp in RFC 3339 format + - `CEUserManagement2026_07_13` - format: date-time +#### Returns - - `required DateTimeOffset CreatedAt` +- `class BetaServiceAccountWorkspaceMember:` - A timestamp in RFC 3339 format + - `required string? CreatedByActorID` - format: date-time + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - - `required DateTimeOffset? ExpiresAt` + - `required bool? Implicit` - A timestamp in RFC 3339 format + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - format: date-time + - `required string ServiceAccountID` - - `required string Fingerprint` + Tagged service account ID (`svac_...`). - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `JsonElement Type constant` - - `required string TunnelID` + - `required string WorkspaceID` - ID of the tunnel the certificate is registered against. + Tagged workspace ID (`wrkspc_...`). - - `JsonElement Type constant` + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` #### Example ```csharp -CertificateCreateParams parameters = new() +ServiceAccountAddParams parameters = new() { - TunnelID = "tunnel_id", - CaCertificatePem = "ca_certificate_pem", + WorkspaceID = "workspace_id", + ServiceAccountID = "service_account_id", + WorkspaceRole = BetaNoBillingWorkspaceRole.WorkspaceAdmin, }; -var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Create(parameters); +var betaServiceAccountWorkspaceMember = await client.Beta.Organization.Workspaces.ServiceAccounts.Add(parameters); -Console.WriteLine(betaTunnelCertificate); +Console.WriteLine(betaServiceAccountWorkspaceMember); ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Get Tunnel Certificate +### Get Service Account Workspace Member -`BetaTunnelCertificate Beta.Tunnels.Certificates.Retrieve(parameters, cancellationToken = default)` +`BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)` -**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Fetches a tunnel certificate by ID. +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. #### Parameters -- `CertificateRetrieveParams parameters` +- `ServiceAccountRetrieveParams parameters` - - `required string tunnelID` + - `required string workspaceID` - Path param: Path parameter tunnel_id + Path param: ID of the workspace. - - `required string certificateID` + - `required string serviceAccountID` - Path param: Path parameter certificate_id + Path param: ID of the service account. - `IReadOnlyList betas` @@ -64290,103 +75958,115 @@ Fetches a tunnel certificate by ID. - `MidConversationToolChanges2026_07_01` -#### Returns + - `Compact2026_01_12` -- `class BetaTunnelCertificate:` + - `ComputerUse2025_11_24` - A CA certificate attached to a tunnel. + - `McpTunnels2026_06_22` - - `required string ID` + - `StructuredOutputs2025_11_13` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `TaskBudgets2026_03_13` - - `required DateTimeOffset? ArchivedAt` + - `ThinkingDisplayUpdates2026_08_18` - A timestamp in RFC 3339 format + - `CEUserManagement2026_07_13` - format: date-time +#### Returns - - `required DateTimeOffset CreatedAt` +- `class BetaServiceAccountWorkspaceMember:` - A timestamp in RFC 3339 format + - `required string? CreatedByActorID` - format: date-time + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - - `required DateTimeOffset? ExpiresAt` + - `required bool? Implicit` - A timestamp in RFC 3339 format + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - format: date-time + - `required string ServiceAccountID` - - `required string Fingerprint` + Tagged service account ID (`svac_...`). - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `JsonElement Type constant` - - `required string TunnelID` + - `required string WorkspaceID` - ID of the tunnel the certificate is registered against. + Tagged workspace ID (`wrkspc_...`). - - `JsonElement Type constant` + - `required BetaWorkspaceRole WorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WorkspaceAdmin` + + - `WorkspaceBilling` + + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` #### Example ```csharp -CertificateRetrieveParams parameters = new() +ServiceAccountRetrieveParams parameters = new() { - TunnelID = "tunnel_id", - CertificateID = "certificate_id", + WorkspaceID = "workspace_id", + ServiceAccountID = "service_account_id", }; -var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Retrieve(parameters); +var betaServiceAccountWorkspaceMember = await client.Beta.Organization.Workspaces.ServiceAccounts.Retrieve(parameters); -Console.WriteLine(betaTunnelCertificate); +Console.WriteLine(betaServiceAccountWorkspaceMember); ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### List Tunnel Certificates - -`CertificateListPageResponse Beta.Tunnels.Certificates.List(parameters, cancellationToken = default)` +### Update Service Account Workspace Member -**GET** `/v1/tunnels/{tunnel_id}/certificates` +`BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -#### Parameters +Change a service account's role in a workspace. -- `CertificateListParams parameters` - - - `required string tunnelID` +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. - Path param: Path parameter tunnel_id +#### Parameters - - `bool includeArchived` +- `ServiceAccountUpdateParams parameters` - Query param: Whether to include archived certificates in the results. Defaults to false. + - `required string workspaceID` - - `int limit` + Path param: ID of the workspace. - Query param: Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + - `required string serviceAccountID` - format: int32 + Path param: ID of the service account. - - `string page` + - `required BetaNoBillingWorkspaceRole workspaceRole` - Query param: Opaque pagination cursor from a previous `list_tunnel_certificates` response. + Body param: New role for the service account in this workspace. - `IReadOnlyList betas` @@ -64460,104 +76140,111 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `MidConversationToolChanges2026_07_01` -#### Returns + - `Compact2026_01_12` -- `class CertificateListPageResponse:` + - `ComputerUse2025_11_24` - The tunnel's certificates. + - `McpTunnels2026_06_22` - - `required IReadOnlyList Data` + - `StructuredOutputs2025_11_13` - List of certificates, ordered by created_at descending. + - `TaskBudgets2026_03_13` - - `required string ID` + - `ThinkingDisplayUpdates2026_08_18` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `CEUserManagement2026_07_13` - - `required DateTimeOffset? ArchivedAt` +#### Returns - A timestamp in RFC 3339 format +- `class BetaServiceAccountWorkspaceMember:` - format: date-time + - `required string? CreatedByActorID` - - `required DateTimeOffset CreatedAt` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - A timestamp in RFC 3339 format + - `required bool? Implicit` - format: date-time + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - - `required DateTimeOffset? ExpiresAt` + - `required string ServiceAccountID` - A timestamp in RFC 3339 format + Tagged service account ID (`svac_...`). - format: date-time + - `JsonElement Type constant` - - `required string Fingerprint` + - `required string WorkspaceID` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + Tagged workspace ID (`wrkspc_...`). - - `required string TunnelID` + - `required BetaWorkspaceRole WorkspaceRole` - ID of the tunnel the certificate is registered against. + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `JsonElement Type constant` + - `WorkspaceAdmin` - - `required string? NextPage` + - `WorkspaceBilling` - Pagination cursor for the next page, or null if no more results. + - `WorkspaceDeveloper` + + - `WorkspaceRestrictedDeveloper` + + - `WorkspaceUser` #### Example ```csharp -CertificateListParams parameters = new() { TunnelID = "tunnel_id" }; - -var page = await client.Beta.Tunnels.Certificates.List(parameters); -await foreach (var item in page.Paginate()) +ServiceAccountUpdateParams parameters = new() { - Console.WriteLine(item); -} + WorkspaceID = "workspace_id", + ServiceAccountID = "service_account_id", + WorkspaceRole = BetaNoBillingWorkspaceRole.WorkspaceAdmin, +}; + +var betaServiceAccountWorkspaceMember = await client.Beta.Organization.Workspaces.ServiceAccounts.Update(parameters); + +Console.WriteLine(betaServiceAccountWorkspaceMember); ``` ##### Response (200) ```json { - "data": [ - { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" - } - ], - "next_page": "next_page" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Archive Tunnel Certificate +### Delete Service Account Workspace Member -`BetaTunnelCertificate Beta.Tunnels.Certificates.Archive(parameters, cancellationToken = default)` +`ServiceAccountRemoveResponse Beta.Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)` -**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. #### Parameters -- `CertificateArchiveParams parameters` +- `ServiceAccountRemoveParams parameters` - - `required string tunnelID` + - `required string workspaceID` - Path param: Path parameter tunnel_id + Path param: ID of the workspace. - - `required string certificateID` + - `required string serviceAccountID` - Path param: Path parameter certificate_id + Path param: ID of the service account. - `IReadOnlyList betas` @@ -64631,68 +76318,196 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns -- `class BetaTunnelCertificate:` +- `class ServiceAccountRemoveResponse:` - A CA certificate attached to a tunnel. + - `required string ServiceAccountID` - - `required string ID` + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `JsonElement Type constant` - - `required DateTimeOffset? ArchivedAt` + - `required string WorkspaceID` - A timestamp in RFC 3339 format + Tagged workspace ID (`wrkspc_...`) named in the delete request. - format: date-time +#### Example - - `required DateTimeOffset CreatedAt` +```csharp +ServiceAccountRemoveParams parameters = new() +{ + WorkspaceID = "workspace_id", + ServiceAccountID = "service_account_id", +}; - A timestamp in RFC 3339 format +var serviceAccount = await client.Beta.Organization.Workspaces.ServiceAccounts.Remove(parameters); - format: date-time +Console.WriteLine(serviceAccount); +``` - - `required DateTimeOffset? ExpiresAt` +##### Response (200) - A timestamp in RFC 3339 format +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` - format: date-time +## Beta › Organization › Rate Limits - - `required string Fingerprint` +### List Organization Rate Limits - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. +`RateLimitListPageResponse Beta.Organization.RateLimits.List(parameters, cancellationToken = default)` - - `required string TunnelID` +**GET** `/v1/organizations/rate_limits` - ID of the tunnel the certificate is registered against. +List Messages API rate limits for your organization. - - `JsonElement Type constant` +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `RateLimitListParams parameters` + + - `GroupType? groupType` + + Filter by group type. + + - `Batch` + + - `Files` + + - `ModelGroup` + + - `Skills` + + - `TokenCount` + + - `WebSearch` + + - `long? limit` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + + - `string? model` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + + - `string? page` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class RateLimitListPageResponse:` + + - `required IReadOnlyList Data` + + Rate-limit entries for the organization, one per group. + + - `required string ID` + + Stable identifier for this rate-limit group within the organization. + + - `required GroupType GroupType` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `Batch` + + - `Files` + + - `ModelGroup` + + - `Skills` + + - `TokenCount` + + - `WebSearch` + + - `required IReadOnlyList Limits` + + The limiter values that apply to this group. + + - `required string Type` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `required long Value` + + The configured limit value for this limiter type. + + - `required IReadOnlyList? Models` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `JsonElement Type constant` + + Object type. Always `rate_limit` for organization rate-limit entries. + + - `required string? NextPage` + + Token to provide in as `page` in the subsequent request to retrieve the next page of data. #### Example ```csharp -CertificateArchiveParams parameters = new() -{ - TunnelID = "tunnel_id", - CertificateID = "certificate_id", -}; +RateLimitListParams parameters = new(); -var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Archive(parameters); - -Console.WriteLine(betaTunnelCertificate); +var page = await client.Beta.Organization.RateLimits.List(parameters); +await foreach (var item in page.Paginate()) +{ + Console.WriteLine(item); +} ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" } ``` diff --git a/content/en/api/csharp/beta/agents.md b/content/en/api/csharp/beta/agents.md index db5a116cf..4d829b1dd 100644 --- a/content/en/api/csharp/beta/agents.md +++ b/content/en/api/csharp/beta/agents.md @@ -736,6 +736,20 @@ Create Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsAgent:` @@ -1459,6 +1473,20 @@ List Agents - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class AgentListPageResponse:` @@ -2177,6 +2205,20 @@ Get Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsAgent:` @@ -3535,6 +3577,20 @@ Update Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsAgent:` @@ -4235,6 +4291,20 @@ Archive Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsAgent:` @@ -8587,6 +8657,20 @@ List Agent Versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionListPageResponse:` diff --git a/content/en/api/csharp/beta/agents/archive.md b/content/en/api/csharp/beta/agents/archive.md index 7a4c493e5..a2b70aca8 100644 --- a/content/en/api/csharp/beta/agents/archive.md +++ b/content/en/api/csharp/beta/agents/archive.md @@ -86,6 +86,20 @@ Archive Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/csharp/beta/agents/create.md b/content/en/api/csharp/beta/agents/create.md index fbc465793..b6c6a00e8 100644 --- a/content/en/api/csharp/beta/agents/create.md +++ b/content/en/api/csharp/beta/agents/create.md @@ -734,6 +734,20 @@ Create Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/csharp/beta/agents/list.md b/content/en/api/csharp/beta/agents/list.md index b8c430e50..37cf463a2 100644 --- a/content/en/api/csharp/beta/agents/list.md +++ b/content/en/api/csharp/beta/agents/list.md @@ -108,6 +108,20 @@ List Agents - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class AgentListPageResponse:` diff --git a/content/en/api/csharp/beta/agents/retrieve.md b/content/en/api/csharp/beta/agents/retrieve.md index c4fb44704..b9a74a36f 100644 --- a/content/en/api/csharp/beta/agents/retrieve.md +++ b/content/en/api/csharp/beta/agents/retrieve.md @@ -92,6 +92,20 @@ Get Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/csharp/beta/agents/update.md b/content/en/api/csharp/beta/agents/update.md index 657d6885b..5fa9e4142 100644 --- a/content/en/api/csharp/beta/agents/update.md +++ b/content/en/api/csharp/beta/agents/update.md @@ -744,6 +744,20 @@ Update Agent - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/csharp/beta/agents/versions.md b/content/en/api/csharp/beta/agents/versions.md index d4da69a2d..e520bdd95 100644 --- a/content/en/api/csharp/beta/agents/versions.md +++ b/content/en/api/csharp/beta/agents/versions.md @@ -98,6 +98,20 @@ List Agent Versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class VersionListPageResponse:` diff --git a/content/en/api/csharp/beta/agents/versions/list.md b/content/en/api/csharp/beta/agents/versions/list.md index 4da707466..1c7b68ccf 100644 --- a/content/en/api/csharp/beta/agents/versions/list.md +++ b/content/en/api/csharp/beta/agents/versions/list.md @@ -96,6 +96,20 @@ List Agent Versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class VersionListPageResponse:` diff --git a/content/en/api/csharp/beta/deployment_runs.md b/content/en/api/csharp/beta/deployment_runs.md index 75ada87e0..b277bbee4 100644 --- a/content/en/api/csharp/beta/deployment_runs.md +++ b/content/en/api/csharp/beta/deployment_runs.md @@ -130,6 +130,20 @@ List Deployment Runs - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class DeploymentRunListPageResponse:` @@ -492,6 +506,20 @@ Get Deployment Run - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeploymentRun:` diff --git a/content/en/api/csharp/beta/deployment_runs/list.md b/content/en/api/csharp/beta/deployment_runs/list.md index 3def79449..e713b626a 100644 --- a/content/en/api/csharp/beta/deployment_runs/list.md +++ b/content/en/api/csharp/beta/deployment_runs/list.md @@ -128,6 +128,20 @@ List Deployment Runs - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class DeploymentRunListPageResponse:` diff --git a/content/en/api/csharp/beta/deployment_runs/retrieve.md b/content/en/api/csharp/beta/deployment_runs/retrieve.md index 772bca042..f3dcafc73 100644 --- a/content/en/api/csharp/beta/deployment_runs/retrieve.md +++ b/content/en/api/csharp/beta/deployment_runs/retrieve.md @@ -86,6 +86,20 @@ Get Deployment Run - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeploymentRun:` diff --git a/content/en/api/csharp/beta/deployments.md b/content/en/api/csharp/beta/deployments.md index 5dd8f4218..e9dc2f3b8 100644 --- a/content/en/api/csharp/beta/deployments.md +++ b/content/en/api/csharp/beta/deployments.md @@ -456,6 +456,20 @@ Create Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -1187,6 +1201,20 @@ List Deployments - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class DeploymentListPageResponse:` @@ -1883,6 +1911,20 @@ Get Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -2939,6 +2981,20 @@ Update Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -3623,6 +3679,20 @@ Archive Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -4307,6 +4377,20 @@ Run Deployment Now - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeploymentRun:` @@ -4657,6 +4741,20 @@ Pause Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -5341,6 +5439,20 @@ Unpause Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/csharp/beta/deployments/archive.md b/content/en/api/csharp/beta/deployments/archive.md index 84febe908..b45a7cfd5 100644 --- a/content/en/api/csharp/beta/deployments/archive.md +++ b/content/en/api/csharp/beta/deployments/archive.md @@ -86,6 +86,20 @@ Archive Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/csharp/beta/deployments/create.md b/content/en/api/csharp/beta/deployments/create.md index c5fe7083a..9b30a1cfa 100644 --- a/content/en/api/csharp/beta/deployments/create.md +++ b/content/en/api/csharp/beta/deployments/create.md @@ -454,6 +454,20 @@ Create Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/csharp/beta/deployments/list.md b/content/en/api/csharp/beta/deployments/list.md index 7e0835637..e98d3c7d4 100644 --- a/content/en/api/csharp/beta/deployments/list.md +++ b/content/en/api/csharp/beta/deployments/list.md @@ -116,6 +116,20 @@ List Deployments - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class DeploymentListPageResponse:` diff --git a/content/en/api/csharp/beta/deployments/pause.md b/content/en/api/csharp/beta/deployments/pause.md index f5ea44fca..b1ea5d34a 100644 --- a/content/en/api/csharp/beta/deployments/pause.md +++ b/content/en/api/csharp/beta/deployments/pause.md @@ -86,6 +86,20 @@ Pause Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/csharp/beta/deployments/retrieve.md b/content/en/api/csharp/beta/deployments/retrieve.md index ea2a7d63a..c4805dace 100644 --- a/content/en/api/csharp/beta/deployments/retrieve.md +++ b/content/en/api/csharp/beta/deployments/retrieve.md @@ -86,6 +86,20 @@ Get Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/csharp/beta/deployments/run.md b/content/en/api/csharp/beta/deployments/run.md index c9d947303..e1504b094 100644 --- a/content/en/api/csharp/beta/deployments/run.md +++ b/content/en/api/csharp/beta/deployments/run.md @@ -86,6 +86,20 @@ Run Deployment Now - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeploymentRun:` diff --git a/content/en/api/csharp/beta/deployments/unpause.md b/content/en/api/csharp/beta/deployments/unpause.md index c736bdfbc..ff8a9d294 100644 --- a/content/en/api/csharp/beta/deployments/unpause.md +++ b/content/en/api/csharp/beta/deployments/unpause.md @@ -86,6 +86,20 @@ Unpause Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/csharp/beta/deployments/update.md b/content/en/api/csharp/beta/deployments/update.md index 9ff52d4dc..155a78d25 100644 --- a/content/en/api/csharp/beta/deployments/update.md +++ b/content/en/api/csharp/beta/deployments/update.md @@ -458,6 +458,20 @@ Update Deployment - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/csharp/beta/environments.md b/content/en/api/csharp/beta/environments.md index d360169ec..683751358 100644 --- a/content/en/api/csharp/beta/environments.md +++ b/content/en/api/csharp/beta/environments.md @@ -62,7 +62,7 @@ Create a new environment with the specified configuration. - `bool? AllowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `IReadOnlyList? AllowedHosts` @@ -74,6 +74,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `IReadOnlyList? Apt` Ubuntu/Debian packages to install @@ -200,6 +202,20 @@ Create a new environment with the specified configuration. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaEnvironment:` @@ -487,6 +503,20 @@ List environments with pagination support. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class EnvironmentListPageResponse:` @@ -780,6 +810,20 @@ Retrieve a specific environment by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaEnvironment:` @@ -1032,7 +1076,7 @@ Update an existing environment's configuration. - `bool? AllowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `IReadOnlyList? AllowedHosts` @@ -1044,6 +1088,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `IReadOnlyList? Apt` Ubuntu/Debian packages to install @@ -1176,6 +1222,20 @@ Update an existing environment's configuration. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaEnvironment:` @@ -1454,6 +1514,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaEnvironmentDeleteResponse:` @@ -1576,6 +1650,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaEnvironment:` @@ -1886,7 +1974,7 @@ Console.WriteLine(betaEnvironment); - `bool? AllowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `IReadOnlyList? AllowedHosts` @@ -1898,6 +1986,8 @@ Console.WriteLine(betaEnvironment); When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `IReadOnlyList? Apt` Ubuntu/Debian packages to install @@ -2111,7 +2201,7 @@ Console.WriteLine(betaEnvironment); - `bool? AllowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `IReadOnlyList? AllowedHosts` @@ -2159,6 +2249,8 @@ Console.WriteLine(betaEnvironment); When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `IReadOnlyList? Apt` Ubuntu/Debian packages to install @@ -2313,6 +2405,20 @@ Retrieve detailed information about a specific work item. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWork:` @@ -2534,6 +2640,20 @@ Long poll for work items in the queue. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string anthropicWorkerID` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -2750,6 +2870,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWork:` @@ -2971,6 +3105,20 @@ Record a heartbeat for a work item to maintain the lease. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWorkHeartbeatResponse:` @@ -3131,6 +3279,20 @@ Stop a work item, initiating graceful or forced shutdown. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWork:` @@ -3350,6 +3512,20 @@ List work items in an environment. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWorkListResponse:` @@ -3577,6 +3753,20 @@ Update work item metadata with merge semantics. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWork:` @@ -3783,6 +3973,20 @@ Get statistics about the work queue for an environment. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaSelfHostedWorkQueueStats:` diff --git a/content/en/api/csharp/beta/environments/archive.md b/content/en/api/csharp/beta/environments/archive.md index 76f4df95d..11dfd6578 100644 --- a/content/en/api/csharp/beta/environments/archive.md +++ b/content/en/api/csharp/beta/environments/archive.md @@ -84,6 +84,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaEnvironment:` diff --git a/content/en/api/csharp/beta/environments/create.md b/content/en/api/csharp/beta/environments/create.md index 09f1bbc30..d9dc31f2c 100644 --- a/content/en/api/csharp/beta/environments/create.md +++ b/content/en/api/csharp/beta/environments/create.md @@ -60,7 +60,7 @@ Create a new environment with the specified configuration. - `bool? AllowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `IReadOnlyList? AllowedHosts` @@ -72,6 +72,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `IReadOnlyList? Apt` Ubuntu/Debian packages to install @@ -198,6 +200,20 @@ Create a new environment with the specified configuration. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaEnvironment:` diff --git a/content/en/api/csharp/beta/environments/delete.md b/content/en/api/csharp/beta/environments/delete.md index fb27574b5..6393c85ed 100644 --- a/content/en/api/csharp/beta/environments/delete.md +++ b/content/en/api/csharp/beta/environments/delete.md @@ -84,6 +84,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaEnvironmentDeleteResponse:` diff --git a/content/en/api/csharp/beta/environments/list.md b/content/en/api/csharp/beta/environments/list.md index b4dd75e9c..0ca003bd9 100644 --- a/content/en/api/csharp/beta/environments/list.md +++ b/content/en/api/csharp/beta/environments/list.md @@ -96,6 +96,20 @@ List environments with pagination support. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class EnvironmentListPageResponse:` diff --git a/content/en/api/csharp/beta/environments/retrieve.md b/content/en/api/csharp/beta/environments/retrieve.md index b433bc145..8dd9f3f14 100644 --- a/content/en/api/csharp/beta/environments/retrieve.md +++ b/content/en/api/csharp/beta/environments/retrieve.md @@ -84,6 +84,20 @@ Retrieve a specific environment by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaEnvironment:` diff --git a/content/en/api/csharp/beta/environments/update.md b/content/en/api/csharp/beta/environments/update.md index 93a680d4a..756d10d71 100644 --- a/content/en/api/csharp/beta/environments/update.md +++ b/content/en/api/csharp/beta/environments/update.md @@ -58,7 +58,7 @@ Update an existing environment's configuration. - `bool? AllowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `IReadOnlyList? AllowedHosts` @@ -70,6 +70,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `IReadOnlyList? Apt` Ubuntu/Debian packages to install @@ -202,6 +204,20 @@ Update an existing environment's configuration. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaEnvironment:` diff --git a/content/en/api/csharp/beta/environments/work.md b/content/en/api/csharp/beta/environments/work.md index 239dabfc5..2aef9c5c8 100644 --- a/content/en/api/csharp/beta/environments/work.md +++ b/content/en/api/csharp/beta/environments/work.md @@ -94,6 +94,20 @@ Retrieve detailed information about a specific work item. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaSelfHostedWork:` @@ -315,6 +329,20 @@ Long poll for work items in the queue. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string anthropicWorkerID` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -531,6 +559,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaSelfHostedWork:` @@ -752,6 +794,20 @@ Record a heartbeat for a work item to maintain the lease. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaSelfHostedWorkHeartbeatResponse:` @@ -912,6 +968,20 @@ Stop a work item, initiating graceful or forced shutdown. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaSelfHostedWork:` @@ -1131,6 +1201,20 @@ List work items in an environment. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaSelfHostedWorkListResponse:` @@ -1358,6 +1442,20 @@ Update work item metadata with merge semantics. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaSelfHostedWork:` @@ -1564,6 +1662,20 @@ Get statistics about the work queue for an environment. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaSelfHostedWorkQueueStats:` diff --git a/content/en/api/csharp/beta/environments/work/ack.md b/content/en/api/csharp/beta/environments/work/ack.md index 684d16baf..1a7462ccf 100644 --- a/content/en/api/csharp/beta/environments/work/ack.md +++ b/content/en/api/csharp/beta/environments/work/ack.md @@ -92,6 +92,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaSelfHostedWork:` diff --git a/content/en/api/csharp/beta/environments/work/heartbeat.md b/content/en/api/csharp/beta/environments/work/heartbeat.md index d83078061..1e501f189 100644 --- a/content/en/api/csharp/beta/environments/work/heartbeat.md +++ b/content/en/api/csharp/beta/environments/work/heartbeat.md @@ -100,6 +100,20 @@ Record a heartbeat for a work item to maintain the lease. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaSelfHostedWorkHeartbeatResponse:` diff --git a/content/en/api/csharp/beta/environments/work/list.md b/content/en/api/csharp/beta/environments/work/list.md index c56c9707d..a52b16a03 100644 --- a/content/en/api/csharp/beta/environments/work/list.md +++ b/content/en/api/csharp/beta/environments/work/list.md @@ -98,6 +98,20 @@ List work items in an environment. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaSelfHostedWorkListResponse:` diff --git a/content/en/api/csharp/beta/environments/work/poll.md b/content/en/api/csharp/beta/environments/work/poll.md index df09680c1..70e26c2c7 100644 --- a/content/en/api/csharp/beta/environments/work/poll.md +++ b/content/en/api/csharp/beta/environments/work/poll.md @@ -100,6 +100,20 @@ Long poll for work items in the queue. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string anthropicWorkerID` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console diff --git a/content/en/api/csharp/beta/environments/work/retrieve.md b/content/en/api/csharp/beta/environments/work/retrieve.md index a9bcb2d4c..07e82bdea 100644 --- a/content/en/api/csharp/beta/environments/work/retrieve.md +++ b/content/en/api/csharp/beta/environments/work/retrieve.md @@ -92,6 +92,20 @@ Retrieve detailed information about a specific work item. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaSelfHostedWork:` diff --git a/content/en/api/csharp/beta/environments/work/stats.md b/content/en/api/csharp/beta/environments/work/stats.md index 05f4390d7..389ef971b 100644 --- a/content/en/api/csharp/beta/environments/work/stats.md +++ b/content/en/api/csharp/beta/environments/work/stats.md @@ -84,6 +84,20 @@ Get statistics about the work queue for an environment. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaSelfHostedWorkQueueStats:` diff --git a/content/en/api/csharp/beta/environments/work/stop.md b/content/en/api/csharp/beta/environments/work/stop.md index 7ff8e2acb..123794475 100644 --- a/content/en/api/csharp/beta/environments/work/stop.md +++ b/content/en/api/csharp/beta/environments/work/stop.md @@ -96,6 +96,20 @@ Stop a work item, initiating graceful or forced shutdown. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaSelfHostedWork:` diff --git a/content/en/api/csharp/beta/environments/work/update.md b/content/en/api/csharp/beta/environments/work/update.md index 819429ac9..f8c94ab3b 100644 --- a/content/en/api/csharp/beta/environments/work/update.md +++ b/content/en/api/csharp/beta/environments/work/update.md @@ -96,6 +96,20 @@ Update work item metadata with merge semantics. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaSelfHostedWork:` diff --git a/content/en/api/csharp/beta/files.md b/content/en/api/csharp/beta/files.md index b3047d985..c99ecdcd6 100644 --- a/content/en/api/csharp/beta/files.md +++ b/content/en/api/csharp/beta/files.md @@ -90,6 +90,20 @@ Upload File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaFileMetadata:` @@ -281,6 +295,20 @@ List Files - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class FileListPageResponse:` @@ -478,6 +506,20 @@ Download File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Example ```csharp @@ -576,6 +618,20 @@ Get File Metadata - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaFileMetadata:` @@ -748,6 +804,20 @@ Delete File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaDeletedFile:` diff --git a/content/en/api/csharp/beta/files/delete.md b/content/en/api/csharp/beta/files/delete.md index 6f1a7ca2b..7deddd897 100644 --- a/content/en/api/csharp/beta/files/delete.md +++ b/content/en/api/csharp/beta/files/delete.md @@ -86,6 +86,20 @@ Delete File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaDeletedFile:` diff --git a/content/en/api/csharp/beta/files/download.md b/content/en/api/csharp/beta/files/download.md index 6e7904ea8..0f97c97ab 100644 --- a/content/en/api/csharp/beta/files/download.md +++ b/content/en/api/csharp/beta/files/download.md @@ -86,6 +86,20 @@ Download File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Example ```csharp diff --git a/content/en/api/csharp/beta/files/list.md b/content/en/api/csharp/beta/files/list.md index 59b689210..3af54a717 100644 --- a/content/en/api/csharp/beta/files/list.md +++ b/content/en/api/csharp/beta/files/list.md @@ -102,6 +102,20 @@ List Files - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class FileListPageResponse:` diff --git a/content/en/api/csharp/beta/files/retrieve_metadata.md b/content/en/api/csharp/beta/files/retrieve_metadata.md index 2d45bee74..309a8e676 100644 --- a/content/en/api/csharp/beta/files/retrieve_metadata.md +++ b/content/en/api/csharp/beta/files/retrieve_metadata.md @@ -86,6 +86,20 @@ Get File Metadata - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaFileMetadata:` diff --git a/content/en/api/csharp/beta/files/upload.md b/content/en/api/csharp/beta/files/upload.md index 4690b3439..de2064033 100644 --- a/content/en/api/csharp/beta/files/upload.md +++ b/content/en/api/csharp/beta/files/upload.md @@ -88,6 +88,20 @@ Upload File - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaFileMetadata:` diff --git a/content/en/api/csharp/beta/memory_stores.md b/content/en/api/csharp/beta/memory_stores.md index 02273b66b..efe4488c7 100644 --- a/content/en/api/csharp/beta/memory_stores.md +++ b/content/en/api/csharp/beta/memory_stores.md @@ -100,6 +100,20 @@ Create a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemoryStore:` @@ -279,6 +293,20 @@ List memory stores - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class MemoryStoreListPageResponse:` @@ -451,6 +479,20 @@ Retrieve a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemoryStore:` @@ -627,6 +669,20 @@ Update a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemoryStore:` @@ -787,6 +843,20 @@ Delete a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeletedMemoryStore:` @@ -909,6 +979,20 @@ Archive a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemoryStore:` @@ -1141,6 +1225,20 @@ Create a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemory:` @@ -1173,7 +1271,7 @@ Create a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -1335,6 +1433,20 @@ List memories - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class MemoryListPageResponse:` @@ -1375,7 +1487,7 @@ List memories - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -1537,6 +1649,20 @@ Retrieve a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemory:` @@ -1569,7 +1695,7 @@ Retrieve a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -1728,6 +1854,20 @@ Update a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemory:` @@ -1760,7 +1900,7 @@ Update a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -1905,11 +2045,25 @@ Delete a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `required string ID` @@ -2076,6 +2230,20 @@ List memory versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class MemoryVersionListPageResponse:` @@ -2098,7 +2266,7 @@ List memory versions - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` @@ -2342,11 +2510,25 @@ Retrieve a memory version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -2360,7 +2542,7 @@ Retrieve a memory version - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` @@ -2590,11 +2772,25 @@ Redact a memory version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -2608,7 +2804,7 @@ Redact a memory version - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` diff --git a/content/en/api/csharp/beta/memory_stores/archive.md b/content/en/api/csharp/beta/memory_stores/archive.md index 052743aba..ff9575cef 100644 --- a/content/en/api/csharp/beta/memory_stores/archive.md +++ b/content/en/api/csharp/beta/memory_stores/archive.md @@ -86,6 +86,20 @@ Archive a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemoryStore:` diff --git a/content/en/api/csharp/beta/memory_stores/create.md b/content/en/api/csharp/beta/memory_stores/create.md index 9eb5e9f00..b3b00becf 100644 --- a/content/en/api/csharp/beta/memory_stores/create.md +++ b/content/en/api/csharp/beta/memory_stores/create.md @@ -98,6 +98,20 @@ Create a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemoryStore:` diff --git a/content/en/api/csharp/beta/memory_stores/delete.md b/content/en/api/csharp/beta/memory_stores/delete.md index dcbb9ca9a..3e8a4ef16 100644 --- a/content/en/api/csharp/beta/memory_stores/delete.md +++ b/content/en/api/csharp/beta/memory_stores/delete.md @@ -86,6 +86,20 @@ Delete a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeletedMemoryStore:` diff --git a/content/en/api/csharp/beta/memory_stores/list.md b/content/en/api/csharp/beta/memory_stores/list.md index 2a652d321..ded4ca07a 100644 --- a/content/en/api/csharp/beta/memory_stores/list.md +++ b/content/en/api/csharp/beta/memory_stores/list.md @@ -108,6 +108,20 @@ List memory stores - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class MemoryStoreListPageResponse:` diff --git a/content/en/api/csharp/beta/memory_stores/memories.md b/content/en/api/csharp/beta/memory_stores/memories.md index e9e42bf7c..952e624d5 100644 --- a/content/en/api/csharp/beta/memory_stores/memories.md +++ b/content/en/api/csharp/beta/memory_stores/memories.md @@ -102,6 +102,20 @@ Create a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemory:` @@ -134,7 +148,7 @@ Create a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -296,6 +310,20 @@ List memories - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class MemoryListPageResponse:` @@ -336,7 +364,7 @@ List memories - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -498,6 +526,20 @@ Retrieve a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemory:` @@ -530,7 +572,7 @@ Retrieve a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -689,6 +731,20 @@ Update a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemory:` @@ -721,7 +777,7 @@ Update a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -866,11 +922,25 @@ Delete a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `required string ID` @@ -927,7 +997,7 @@ Console.WriteLine(betaManagedAgentsDeletedMemory); - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `required string ID` @@ -1047,7 +1117,7 @@ Console.WriteLine(betaManagedAgentsDeletedMemory); - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` @@ -1101,7 +1171,7 @@ Console.WriteLine(betaManagedAgentsDeletedMemory); - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` diff --git a/content/en/api/csharp/beta/memory_stores/memories/create.md b/content/en/api/csharp/beta/memory_stores/memories/create.md index d6da8b563..b4bbbbed2 100644 --- a/content/en/api/csharp/beta/memory_stores/memories/create.md +++ b/content/en/api/csharp/beta/memory_stores/memories/create.md @@ -100,6 +100,20 @@ Create a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemory:` @@ -132,7 +146,7 @@ Create a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` diff --git a/content/en/api/csharp/beta/memory_stores/memories/delete.md b/content/en/api/csharp/beta/memory_stores/memories/delete.md index c55d539ce..81600d4c9 100644 --- a/content/en/api/csharp/beta/memory_stores/memories/delete.md +++ b/content/en/api/csharp/beta/memory_stores/memories/delete.md @@ -94,11 +94,25 @@ Delete a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `required string ID` diff --git a/content/en/api/csharp/beta/memory_stores/memories/list.md b/content/en/api/csharp/beta/memory_stores/memories/list.md index 5c786ea7e..51f4bd6e8 100644 --- a/content/en/api/csharp/beta/memory_stores/memories/list.md +++ b/content/en/api/csharp/beta/memory_stores/memories/list.md @@ -110,6 +110,20 @@ List memories - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class MemoryListPageResponse:` @@ -150,7 +164,7 @@ List memories - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` diff --git a/content/en/api/csharp/beta/memory_stores/memories/retrieve.md b/content/en/api/csharp/beta/memory_stores/memories/retrieve.md index b9e822174..4267e82f7 100644 --- a/content/en/api/csharp/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/csharp/beta/memory_stores/memories/retrieve.md @@ -94,6 +94,20 @@ Retrieve a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemory:` @@ -126,7 +140,7 @@ Retrieve a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` diff --git a/content/en/api/csharp/beta/memory_stores/memories/update.md b/content/en/api/csharp/beta/memory_stores/memories/update.md index b07d9ee32..592afd0e6 100644 --- a/content/en/api/csharp/beta/memory_stores/memories/update.md +++ b/content/en/api/csharp/beta/memory_stores/memories/update.md @@ -108,6 +108,20 @@ Update a memory - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemory:` @@ -140,7 +154,7 @@ Update a memory - `required string MemoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `required string Path` diff --git a/content/en/api/csharp/beta/memory_stores/memory_versions.md b/content/en/api/csharp/beta/memory_stores/memory_versions.md index cc7c9da7e..d7905187a 100644 --- a/content/en/api/csharp/beta/memory_stores/memory_versions.md +++ b/content/en/api/csharp/beta/memory_stores/memory_versions.md @@ -134,6 +134,20 @@ List memory versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class MemoryVersionListPageResponse:` @@ -156,7 +170,7 @@ List memory versions - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` @@ -400,11 +414,25 @@ Retrieve a memory version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -418,7 +446,7 @@ Retrieve a memory version - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` @@ -648,11 +676,25 @@ Redact a memory version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -666,7 +708,7 @@ Redact a memory version - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` @@ -878,7 +920,7 @@ Console.WriteLine(betaManagedAgentsMemoryVersion); - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -892,7 +934,7 @@ Console.WriteLine(betaManagedAgentsMemoryVersion); - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` diff --git a/content/en/api/csharp/beta/memory_stores/memory_versions/list.md b/content/en/api/csharp/beta/memory_stores/memory_versions/list.md index aa820b646..e1d9a1ff8 100644 --- a/content/en/api/csharp/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/csharp/beta/memory_stores/memory_versions/list.md @@ -132,6 +132,20 @@ List memory versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class MemoryVersionListPageResponse:` @@ -154,7 +168,7 @@ List memory versions - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` diff --git a/content/en/api/csharp/beta/memory_stores/memory_versions/redact.md b/content/en/api/csharp/beta/memory_stores/memory_versions/redact.md index 5b66f2cf1..c46374473 100644 --- a/content/en/api/csharp/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/csharp/beta/memory_stores/memory_versions/redact.md @@ -90,11 +90,25 @@ Redact a memory version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -108,7 +122,7 @@ Redact a memory version - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` diff --git a/content/en/api/csharp/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/csharp/beta/memory_stores/memory_versions/retrieve.md index cfcf855ad..e29a47670 100644 --- a/content/en/api/csharp/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/csharp/beta/memory_stores/memory_versions/retrieve.md @@ -94,11 +94,25 @@ Retrieve a memory version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `required string ID` @@ -112,7 +126,7 @@ Retrieve a memory version - `required string MemoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `required string MemoryStoreID` diff --git a/content/en/api/csharp/beta/memory_stores/retrieve.md b/content/en/api/csharp/beta/memory_stores/retrieve.md index 5dcac9c7e..fa99d5275 100644 --- a/content/en/api/csharp/beta/memory_stores/retrieve.md +++ b/content/en/api/csharp/beta/memory_stores/retrieve.md @@ -86,6 +86,20 @@ Retrieve a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemoryStore:` diff --git a/content/en/api/csharp/beta/memory_stores/update.md b/content/en/api/csharp/beta/memory_stores/update.md index 57ee5f8f8..9d80f138c 100644 --- a/content/en/api/csharp/beta/memory_stores/update.md +++ b/content/en/api/csharp/beta/memory_stores/update.md @@ -102,6 +102,20 @@ Update a memory store - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsMemoryStore:` diff --git a/content/en/api/csharp/beta/messages.md b/content/en/api/csharp/beta/messages.md index 27a7ed299..f5582801b 100644 --- a/content/en/api/csharp/beta/messages.md +++ b/content/en/api/csharp/beta/messages.md @@ -3547,6 +3547,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -4880,12 +4894,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -5183,12 +5199,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `required long OutputTokens` The cumulative number of output tokens which were used. @@ -8882,6 +8900,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -17107,6 +17139,8 @@ Console.WriteLine(betaMessageTokensCount); - `Omitted` + - `Updates` + - `class BetaThinkingConfigDisabled:` - `JsonElement Type constant` @@ -17123,6 +17157,8 @@ Console.WriteLine(betaMessageTokensCount); - `Omitted` + - `Updates` + ### Beta Fallback Refusal Trigger - `class BetaFallbackRefusalTrigger:` @@ -17309,6 +17345,8 @@ Console.WriteLine(betaMessageTokensCount); - `Omitted` + - `Updates` + - `class BetaThinkingConfigDisabled:` - `JsonElement Type constant` @@ -17325,6 +17363,8 @@ Console.WriteLine(betaMessageTokensCount); - `Omitted` + - `Updates` + - `JsonElement` ### Beta File Document Source @@ -19285,12 +19325,14 @@ Console.WriteLine(betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -19614,12 +19656,14 @@ Console.WriteLine(betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -22938,12 +22982,14 @@ Console.WriteLine(betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -24512,12 +24558,14 @@ Console.WriteLine(betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -26044,12 +26092,14 @@ Console.WriteLine(betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -26341,12 +26391,14 @@ Console.WriteLine(betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `required long OutputTokens` The cumulative number of output tokens which were used. @@ -28531,6 +28583,8 @@ Console.WriteLine(betaMessageTokensCount); - `Omitted` + - `Updates` + ### Beta Thinking Config Disabled - `class BetaThinkingConfigDisabled:` @@ -28561,6 +28615,8 @@ Console.WriteLine(betaMessageTokensCount); - `Omitted` + - `Updates` + ### Beta Thinking Config Param - `class BetaThinkingConfigParam: union` @@ -28593,6 +28649,8 @@ Console.WriteLine(betaMessageTokensCount); - `Omitted` + - `Updates` + - `class BetaThinkingConfigDisabled:` - `JsonElement Type constant` @@ -28609,6 +28667,8 @@ Console.WriteLine(betaMessageTokensCount); - `Omitted` + - `Updates` + ### Beta Thinking Delta - `class BetaThinkingDelta:` @@ -32423,12 +32483,14 @@ Console.WriteLine(betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -36248,6 +36310,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `Omitted` + - `Updates` + - `class BetaThinkingConfigDisabled:` - `JsonElement Type constant` @@ -36264,6 +36328,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `Omitted` + - `Updates` + - `JsonElement` - `string? InferenceGeo` @@ -38429,6 +38495,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -38833,6 +38913,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaMessageBatch:` @@ -39066,6 +39160,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BatchListPageResponse:` @@ -39312,6 +39420,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaMessageBatch:` @@ -39535,6 +39657,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaDeletedMessageBatch:` @@ -39660,6 +39796,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaMessageBatchIndividualResponse:` @@ -40963,12 +41113,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. diff --git a/content/en/api/csharp/beta/messages/batches.md b/content/en/api/csharp/beta/messages/batches.md index b0cedf1c3..ee50c0161 100644 --- a/content/en/api/csharp/beta/messages/batches.md +++ b/content/en/api/csharp/beta/messages/batches.md @@ -1710,6 +1710,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `Omitted` + - `Updates` + - `class BetaThinkingConfigDisabled:` - `JsonElement Type constant` @@ -1726,6 +1728,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `Omitted` + - `Updates` + - `JsonElement` - `string? InferenceGeo` @@ -3891,6 +3895,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -4295,6 +4313,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaMessageBatch:` @@ -4528,6 +4560,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BatchListPageResponse:` @@ -4774,6 +4820,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaMessageBatch:` @@ -4997,6 +5057,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaDeletedMessageBatch:` @@ -5122,6 +5196,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaMessageBatchIndividualResponse:` @@ -6425,12 +6513,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -8244,12 +8334,14 @@ await foreach (var betaMessageBatchIndividualResponse in client.Beta.Messages.Ba Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -9880,12 +9972,14 @@ await foreach (var betaMessageBatchIndividualResponse in client.Beta.Messages.Ba Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -11478,12 +11572,14 @@ await foreach (var betaMessageBatchIndividualResponse in client.Beta.Messages.Ba Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. diff --git a/content/en/api/csharp/beta/messages/batches/cancel.md b/content/en/api/csharp/beta/messages/batches/cancel.md index c76bd40d1..59a2e9519 100644 --- a/content/en/api/csharp/beta/messages/batches/cancel.md +++ b/content/en/api/csharp/beta/messages/batches/cancel.md @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaMessageBatch:` diff --git a/content/en/api/csharp/beta/messages/batches/create.md b/content/en/api/csharp/beta/messages/batches/create.md index 799864d9f..92b4ae163 100644 --- a/content/en/api/csharp/beta/messages/batches/create.md +++ b/content/en/api/csharp/beta/messages/batches/create.md @@ -1708,6 +1708,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `Omitted` + - `Updates` + - `class BetaThinkingConfigDisabled:` - `JsonElement Type constant` @@ -1724,6 +1726,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `Omitted` + - `Updates` + - `JsonElement` - `string? InferenceGeo` @@ -3889,6 +3893,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. diff --git a/content/en/api/csharp/beta/messages/batches/delete.md b/content/en/api/csharp/beta/messages/batches/delete.md index 8ad6d8120..f07552f7c 100644 --- a/content/en/api/csharp/beta/messages/batches/delete.md +++ b/content/en/api/csharp/beta/messages/batches/delete.md @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaDeletedMessageBatch:` diff --git a/content/en/api/csharp/beta/messages/batches/list.md b/content/en/api/csharp/beta/messages/batches/list.md index 173f021c8..125a9f3ba 100644 --- a/content/en/api/csharp/beta/messages/batches/list.md +++ b/content/en/api/csharp/beta/messages/batches/list.md @@ -100,6 +100,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BatchListPageResponse:` diff --git a/content/en/api/csharp/beta/messages/batches/results.md b/content/en/api/csharp/beta/messages/batches/results.md index d6c5c6435..b59ecd0f1 100644 --- a/content/en/api/csharp/beta/messages/batches/results.md +++ b/content/en/api/csharp/beta/messages/batches/results.md @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaMessageBatchIndividualResponse:` @@ -1393,12 +1407,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. diff --git a/content/en/api/csharp/beta/messages/batches/retrieve.md b/content/en/api/csharp/beta/messages/batches/retrieve.md index 71c807d2b..786458bc5 100644 --- a/content/en/api/csharp/beta/messages/batches/retrieve.md +++ b/content/en/api/csharp/beta/messages/batches/retrieve.md @@ -88,6 +88,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaMessageBatch:` diff --git a/content/en/api/csharp/beta/messages/count_tokens.md b/content/en/api/csharp/beta/messages/count_tokens.md index 0edb438b1..d503a31d2 100644 --- a/content/en/api/csharp/beta/messages/count_tokens.md +++ b/content/en/api/csharp/beta/messages/count_tokens.md @@ -3409,6 +3409,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. diff --git a/content/en/api/csharp/beta/messages/create.md b/content/en/api/csharp/beta/messages/create.md index e8640214e..8a17e5ed0 100644 --- a/content/en/api/csharp/beta/messages/create.md +++ b/content/en/api/csharp/beta/messages/create.md @@ -3545,6 +3545,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + - `string userProfileID` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -4878,12 +4892,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -5181,12 +5197,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `required long OutputTokens` The cumulative number of output tokens which were used. diff --git a/content/en/api/csharp/beta/models.md b/content/en/api/csharp/beta/models.md index 184bad5d9..a4803cf4f 100644 --- a/content/en/api/csharp/beta/models.md +++ b/content/en/api/csharp/beta/models.md @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class ModelListPageResponse:` @@ -438,6 +452,20 @@ The Models API response can be used to determine information about a specific mo - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaModelInfo:` diff --git a/content/en/api/csharp/beta/models/list.md b/content/en/api/csharp/beta/models/list.md index 55939bbe5..1d7fcb8bd 100644 --- a/content/en/api/csharp/beta/models/list.md +++ b/content/en/api/csharp/beta/models/list.md @@ -100,6 +100,20 @@ The Models API response can be used to determine which models are available for - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class ModelListPageResponse:` diff --git a/content/en/api/csharp/beta/models/retrieve.md b/content/en/api/csharp/beta/models/retrieve.md index 9e011ff76..f96057dc2 100644 --- a/content/en/api/csharp/beta/models/retrieve.md +++ b/content/en/api/csharp/beta/models/retrieve.md @@ -88,6 +88,20 @@ The Models API response can be used to determine information about a specific mo - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaModelInfo:` diff --git a/content/en/api/csharp/beta/sessions.md b/content/en/api/csharp/beta/sessions.md index 2c695b277..7e5ce9e79 100644 --- a/content/en/api/csharp/beta/sessions.md +++ b/content/en/api/csharp/beta/sessions.md @@ -1078,6 +1078,20 @@ Create Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsSession:` @@ -2272,6 +2286,20 @@ List Sessions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class SessionListPageResponse:` @@ -3410,6 +3438,20 @@ Get Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsSession:` @@ -4553,6 +4595,20 @@ Update Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsSession:` @@ -5674,6 +5730,20 @@ Delete Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeletedSession:` @@ -5794,6 +5864,20 @@ Archive Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsSession:` @@ -11427,6 +11511,20 @@ List Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class EventListPageResponse:` @@ -14052,6 +14150,20 @@ Send Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSendSessionEvents:` @@ -14642,6 +14754,20 @@ Stream Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsStreamSessionEvents: union` @@ -16956,6 +17082,20 @@ Add Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsFileResource:` @@ -17106,6 +17246,20 @@ List Session Resources - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ResourceListPageResponse:` @@ -17359,6 +17513,20 @@ Get Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ResourceRetrieveResponse: union` @@ -17596,6 +17764,20 @@ Update Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ResourceUpdateResponse: union` @@ -17828,6 +18010,20 @@ Delete Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeleteSessionResource:` @@ -17961,6 +18157,20 @@ List Session Threads - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class ThreadListPageResponse:` @@ -17977,7 +18187,7 @@ List Session Threads - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -18794,6 +19004,20 @@ Get Session Thread - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -18806,7 +19030,7 @@ Get Session Thread - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -19613,6 +19837,20 @@ Archive Session Thread - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -19625,7 +19863,7 @@ Archive Session Thread - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -20444,6 +20682,20 @@ List Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class EventListPageResponse:` @@ -22709,6 +22961,20 @@ Stream Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` diff --git a/content/en/api/csharp/beta/sessions/archive.md b/content/en/api/csharp/beta/sessions/archive.md index a42f4be0a..626e76dca 100644 --- a/content/en/api/csharp/beta/sessions/archive.md +++ b/content/en/api/csharp/beta/sessions/archive.md @@ -86,6 +86,20 @@ Archive Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsSession:` diff --git a/content/en/api/csharp/beta/sessions/create.md b/content/en/api/csharp/beta/sessions/create.md index d888d4a7d..5d5245c6f 100644 --- a/content/en/api/csharp/beta/sessions/create.md +++ b/content/en/api/csharp/beta/sessions/create.md @@ -1076,6 +1076,20 @@ Create Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsSession:` diff --git a/content/en/api/csharp/beta/sessions/delete.md b/content/en/api/csharp/beta/sessions/delete.md index 8daae204b..4d692e4fd 100644 --- a/content/en/api/csharp/beta/sessions/delete.md +++ b/content/en/api/csharp/beta/sessions/delete.md @@ -86,6 +86,20 @@ Delete Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeletedSession:` diff --git a/content/en/api/csharp/beta/sessions/events.md b/content/en/api/csharp/beta/sessions/events.md index d10a282ee..5074a2ec9 100644 --- a/content/en/api/csharp/beta/sessions/events.md +++ b/content/en/api/csharp/beta/sessions/events.md @@ -134,6 +134,20 @@ List Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class EventListPageResponse:` @@ -2759,6 +2773,20 @@ Send Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsSendSessionEvents:` @@ -3349,6 +3377,20 @@ Stream Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsStreamSessionEvents: union` diff --git a/content/en/api/csharp/beta/sessions/events/list.md b/content/en/api/csharp/beta/sessions/events/list.md index fa07ff253..778075cd3 100644 --- a/content/en/api/csharp/beta/sessions/events/list.md +++ b/content/en/api/csharp/beta/sessions/events/list.md @@ -132,6 +132,20 @@ List Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class EventListPageResponse:` diff --git a/content/en/api/csharp/beta/sessions/events/send.md b/content/en/api/csharp/beta/sessions/events/send.md index 671a4aa78..51020defd 100644 --- a/content/en/api/csharp/beta/sessions/events/send.md +++ b/content/en/api/csharp/beta/sessions/events/send.md @@ -448,6 +448,20 @@ Send Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsSendSessionEvents:` diff --git a/content/en/api/csharp/beta/sessions/events/stream.md b/content/en/api/csharp/beta/sessions/events/stream.md index 30b4f3539..4d5cfebef 100644 --- a/content/en/api/csharp/beta/sessions/events/stream.md +++ b/content/en/api/csharp/beta/sessions/events/stream.md @@ -94,6 +94,20 @@ Stream Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsStreamSessionEvents: union` diff --git a/content/en/api/csharp/beta/sessions/list.md b/content/en/api/csharp/beta/sessions/list.md index 87d8fa85c..3eb9148fb 100644 --- a/content/en/api/csharp/beta/sessions/list.md +++ b/content/en/api/csharp/beta/sessions/list.md @@ -158,6 +158,20 @@ List Sessions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class SessionListPageResponse:` diff --git a/content/en/api/csharp/beta/sessions/resources.md b/content/en/api/csharp/beta/sessions/resources.md index 5ccc86664..c31038c73 100644 --- a/content/en/api/csharp/beta/sessions/resources.md +++ b/content/en/api/csharp/beta/sessions/resources.md @@ -106,6 +106,20 @@ Add Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsFileResource:` @@ -256,6 +270,20 @@ List Session Resources - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class ResourceListPageResponse:` @@ -509,6 +537,20 @@ Get Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class ResourceRetrieveResponse: union` @@ -746,6 +788,20 @@ Update Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class ResourceUpdateResponse: union` @@ -978,6 +1034,20 @@ Delete Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeleteSessionResource:` diff --git a/content/en/api/csharp/beta/sessions/resources/add.md b/content/en/api/csharp/beta/sessions/resources/add.md index 5d8bc0089..080a8b5b9 100644 --- a/content/en/api/csharp/beta/sessions/resources/add.md +++ b/content/en/api/csharp/beta/sessions/resources/add.md @@ -104,6 +104,20 @@ Add Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsFileResource:` diff --git a/content/en/api/csharp/beta/sessions/resources/delete.md b/content/en/api/csharp/beta/sessions/resources/delete.md index 5a053f12d..4821802d4 100644 --- a/content/en/api/csharp/beta/sessions/resources/delete.md +++ b/content/en/api/csharp/beta/sessions/resources/delete.md @@ -90,6 +90,20 @@ Delete Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeleteSessionResource:` diff --git a/content/en/api/csharp/beta/sessions/resources/list.md b/content/en/api/csharp/beta/sessions/resources/list.md index 6dc92a3a9..cb658410e 100644 --- a/content/en/api/csharp/beta/sessions/resources/list.md +++ b/content/en/api/csharp/beta/sessions/resources/list.md @@ -96,6 +96,20 @@ List Session Resources - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class ResourceListPageResponse:` diff --git a/content/en/api/csharp/beta/sessions/resources/retrieve.md b/content/en/api/csharp/beta/sessions/resources/retrieve.md index 280aacfcf..87a2532c4 100644 --- a/content/en/api/csharp/beta/sessions/resources/retrieve.md +++ b/content/en/api/csharp/beta/sessions/resources/retrieve.md @@ -90,6 +90,20 @@ Get Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class ResourceRetrieveResponse: union` diff --git a/content/en/api/csharp/beta/sessions/resources/update.md b/content/en/api/csharp/beta/sessions/resources/update.md index 17a16905b..c76bcc862 100644 --- a/content/en/api/csharp/beta/sessions/resources/update.md +++ b/content/en/api/csharp/beta/sessions/resources/update.md @@ -96,6 +96,20 @@ Update Session Resource - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class ResourceUpdateResponse: union` diff --git a/content/en/api/csharp/beta/sessions/retrieve.md b/content/en/api/csharp/beta/sessions/retrieve.md index 9486c9cfd..8bfeed5db 100644 --- a/content/en/api/csharp/beta/sessions/retrieve.md +++ b/content/en/api/csharp/beta/sessions/retrieve.md @@ -86,6 +86,20 @@ Get Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsSession:` diff --git a/content/en/api/csharp/beta/sessions/threads.md b/content/en/api/csharp/beta/sessions/threads.md index 2d44896e0..9dca9da3d 100644 --- a/content/en/api/csharp/beta/sessions/threads.md +++ b/content/en/api/csharp/beta/sessions/threads.md @@ -98,6 +98,20 @@ List Session Threads - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class ThreadListPageResponse:` @@ -114,7 +128,7 @@ List Session Threads - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -931,6 +945,20 @@ Get Session Thread - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsSessionThread:` @@ -943,7 +971,7 @@ Get Session Thread - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -1750,6 +1778,20 @@ Archive Session Thread - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsSessionThread:` @@ -1762,7 +1804,7 @@ Archive Session Thread - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -2491,7 +2533,7 @@ Console.WriteLine(betaManagedAgentsSessionThread); - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -5491,6 +5533,20 @@ List Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class EventListPageResponse:` @@ -7756,6 +7812,20 @@ Stream Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` diff --git a/content/en/api/csharp/beta/sessions/threads/archive.md b/content/en/api/csharp/beta/sessions/threads/archive.md index ea554af33..3d217bd53 100644 --- a/content/en/api/csharp/beta/sessions/threads/archive.md +++ b/content/en/api/csharp/beta/sessions/threads/archive.md @@ -90,6 +90,20 @@ Archive Session Thread - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsSessionThread:` @@ -102,7 +116,7 @@ Archive Session Thread - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` diff --git a/content/en/api/csharp/beta/sessions/threads/events.md b/content/en/api/csharp/beta/sessions/threads/events.md index ab9410170..9bd281734 100644 --- a/content/en/api/csharp/beta/sessions/threads/events.md +++ b/content/en/api/csharp/beta/sessions/threads/events.md @@ -102,6 +102,20 @@ List Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class EventListPageResponse:` @@ -2367,6 +2381,20 @@ Stream Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` diff --git a/content/en/api/csharp/beta/sessions/threads/events/list.md b/content/en/api/csharp/beta/sessions/threads/events/list.md index cf0fc3032..cc1645268 100644 --- a/content/en/api/csharp/beta/sessions/threads/events/list.md +++ b/content/en/api/csharp/beta/sessions/threads/events/list.md @@ -100,6 +100,20 @@ List Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class EventListPageResponse:` diff --git a/content/en/api/csharp/beta/sessions/threads/events/stream.md b/content/en/api/csharp/beta/sessions/threads/events/stream.md index 39d4c50ad..dc06a3c7c 100644 --- a/content/en/api/csharp/beta/sessions/threads/events/stream.md +++ b/content/en/api/csharp/beta/sessions/threads/events/stream.md @@ -98,6 +98,20 @@ Stream Session Thread Events - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` diff --git a/content/en/api/csharp/beta/sessions/threads/list.md b/content/en/api/csharp/beta/sessions/threads/list.md index 3620dab79..857e6826e 100644 --- a/content/en/api/csharp/beta/sessions/threads/list.md +++ b/content/en/api/csharp/beta/sessions/threads/list.md @@ -96,6 +96,20 @@ List Session Threads - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class ThreadListPageResponse:` @@ -112,7 +126,7 @@ List Session Threads - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` diff --git a/content/en/api/csharp/beta/sessions/threads/retrieve.md b/content/en/api/csharp/beta/sessions/threads/retrieve.md index 60c9de4f6..6e7a6b006 100644 --- a/content/en/api/csharp/beta/sessions/threads/retrieve.md +++ b/content/en/api/csharp/beta/sessions/threads/retrieve.md @@ -90,6 +90,20 @@ Get Session Thread - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsSessionThread:` @@ -102,7 +116,7 @@ Get Session Thread - `required Agent Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` diff --git a/content/en/api/csharp/beta/sessions/update.md b/content/en/api/csharp/beta/sessions/update.md index 37d74cc36..e57eeedf7 100644 --- a/content/en/api/csharp/beta/sessions/update.md +++ b/content/en/api/csharp/beta/sessions/update.md @@ -108,6 +108,20 @@ Update Session - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsSession:` diff --git a/content/en/api/csharp/beta/skills.md b/content/en/api/csharp/beta/skills.md index 84a8cd387..83dedabe3 100644 --- a/content/en/api/csharp/beta/skills.md +++ b/content/en/api/csharp/beta/skills.md @@ -96,6 +96,20 @@ Create Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class SkillCreateResponse:` @@ -276,6 +290,20 @@ List Skills - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class SkillListPageResponse:` @@ -459,6 +487,20 @@ Get Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class SkillRetrieveResponse:` @@ -618,6 +660,20 @@ Delete Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class SkillDeleteResponse:` @@ -751,6 +807,20 @@ Create Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionCreateResponse:` @@ -931,6 +1001,20 @@ List Skill Versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionListPageResponse:` @@ -1120,6 +1204,20 @@ Download a skill version's content as a zip archive. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Example ```csharp @@ -1230,6 +1328,20 @@ Get Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionRetrieveResponse:` @@ -1403,6 +1515,20 @@ Delete Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class VersionDeleteResponse:` diff --git a/content/en/api/csharp/beta/skills/create.md b/content/en/api/csharp/beta/skills/create.md index 804367369..25c30c7f8 100644 --- a/content/en/api/csharp/beta/skills/create.md +++ b/content/en/api/csharp/beta/skills/create.md @@ -94,6 +94,20 @@ Create Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class SkillCreateResponse:` diff --git a/content/en/api/csharp/beta/skills/delete.md b/content/en/api/csharp/beta/skills/delete.md index 4ba0322ed..ffa8f99b1 100644 --- a/content/en/api/csharp/beta/skills/delete.md +++ b/content/en/api/csharp/beta/skills/delete.md @@ -88,6 +88,20 @@ Delete Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class SkillDeleteResponse:` diff --git a/content/en/api/csharp/beta/skills/list.md b/content/en/api/csharp/beta/skills/list.md index 0b0623f18..8d234804b 100644 --- a/content/en/api/csharp/beta/skills/list.md +++ b/content/en/api/csharp/beta/skills/list.md @@ -103,6 +103,20 @@ List Skills - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class SkillListPageResponse:` diff --git a/content/en/api/csharp/beta/skills/retrieve.md b/content/en/api/csharp/beta/skills/retrieve.md index a8c792371..fd5c9b626 100644 --- a/content/en/api/csharp/beta/skills/retrieve.md +++ b/content/en/api/csharp/beta/skills/retrieve.md @@ -88,6 +88,20 @@ Get Skill - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class SkillRetrieveResponse:` diff --git a/content/en/api/csharp/beta/skills/versions.md b/content/en/api/csharp/beta/skills/versions.md index eb022f58a..05278a8da 100644 --- a/content/en/api/csharp/beta/skills/versions.md +++ b/content/en/api/csharp/beta/skills/versions.md @@ -96,6 +96,20 @@ Create Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class VersionCreateResponse:` @@ -276,6 +290,20 @@ List Skill Versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class VersionListPageResponse:` @@ -465,6 +493,20 @@ Download a skill version's content as a zip archive. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Example ```csharp @@ -575,6 +617,20 @@ Get Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class VersionRetrieveResponse:` @@ -748,6 +804,20 @@ Delete Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class VersionDeleteResponse:` diff --git a/content/en/api/csharp/beta/skills/versions/create.md b/content/en/api/csharp/beta/skills/versions/create.md index 1a1bc105e..0e122ad06 100644 --- a/content/en/api/csharp/beta/skills/versions/create.md +++ b/content/en/api/csharp/beta/skills/versions/create.md @@ -94,6 +94,20 @@ Create Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class VersionCreateResponse:` diff --git a/content/en/api/csharp/beta/skills/versions/delete.md b/content/en/api/csharp/beta/skills/versions/delete.md index 7a6427a9d..06ba62e98 100644 --- a/content/en/api/csharp/beta/skills/versions/delete.md +++ b/content/en/api/csharp/beta/skills/versions/delete.md @@ -94,6 +94,20 @@ Delete Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class VersionDeleteResponse:` diff --git a/content/en/api/csharp/beta/skills/versions/download.md b/content/en/api/csharp/beta/skills/versions/download.md index 1f27a795a..86e0bcc42 100644 --- a/content/en/api/csharp/beta/skills/versions/download.md +++ b/content/en/api/csharp/beta/skills/versions/download.md @@ -94,6 +94,20 @@ Download a skill version's content as a zip archive. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Example ```csharp diff --git a/content/en/api/csharp/beta/skills/versions/list.md b/content/en/api/csharp/beta/skills/versions/list.md index eb8785be4..20d2c9c91 100644 --- a/content/en/api/csharp/beta/skills/versions/list.md +++ b/content/en/api/csharp/beta/skills/versions/list.md @@ -98,6 +98,20 @@ List Skill Versions - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class VersionListPageResponse:` diff --git a/content/en/api/csharp/beta/skills/versions/retrieve.md b/content/en/api/csharp/beta/skills/versions/retrieve.md index 81ba8be89..de6676bca 100644 --- a/content/en/api/csharp/beta/skills/versions/retrieve.md +++ b/content/en/api/csharp/beta/skills/versions/retrieve.md @@ -94,6 +94,20 @@ Get Skill Version - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class VersionRetrieveResponse:` diff --git a/content/en/api/csharp/beta/tunnels.md b/content/en/api/csharp/beta/tunnels.md index 5f07d8cbf..099eb13f6 100644 --- a/content/en/api/csharp/beta/tunnels.md +++ b/content/en/api/csharp/beta/tunnels.md @@ -92,6 +92,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaTunnel:` @@ -237,6 +251,20 @@ Fetches a tunnel by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaTunnel:` @@ -392,6 +420,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class TunnelListPageResponse:` @@ -552,6 +594,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaTunnel:` @@ -697,6 +753,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaTunnelToken:` @@ -829,6 +899,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaTunnelToken:` @@ -1013,6 +1097,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaTunnelCertificate:` @@ -1057,7 +1155,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's CertificateCreateParams parameters = new() { TunnelID = "tunnel_id", - CaCertificatePem = "ca_certificate_pem", + CACertificatePem = "ca_certificate_pem", }; var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Create(parameters); @@ -1173,6 +1271,20 @@ Fetches a tunnel certificate by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaTunnelCertificate:` @@ -1343,6 +1455,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class CertificateListPageResponse:` @@ -1514,6 +1640,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/csharp/beta/tunnels/archive.md b/content/en/api/csharp/beta/tunnels/archive.md index 691a1f018..bed418ca0 100644 --- a/content/en/api/csharp/beta/tunnels/archive.md +++ b/content/en/api/csharp/beta/tunnels/archive.md @@ -88,6 +88,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaTunnel:` diff --git a/content/en/api/csharp/beta/tunnels/certificates.md b/content/en/api/csharp/beta/tunnels/certificates.md index c46d98b1d..6a53fc5ed 100644 --- a/content/en/api/csharp/beta/tunnels/certificates.md +++ b/content/en/api/csharp/beta/tunnels/certificates.md @@ -96,6 +96,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaTunnelCertificate:` @@ -140,7 +154,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's CertificateCreateParams parameters = new() { TunnelID = "tunnel_id", - CaCertificatePem = "ca_certificate_pem", + CACertificatePem = "ca_certificate_pem", }; var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Create(parameters); @@ -256,6 +270,20 @@ Fetches a tunnel certificate by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaTunnelCertificate:` @@ -426,6 +454,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class CertificateListPageResponse:` @@ -597,6 +639,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/csharp/beta/tunnels/certificates/archive.md b/content/en/api/csharp/beta/tunnels/certificates/archive.md index 4c0b0e7e3..73247ea43 100644 --- a/content/en/api/csharp/beta/tunnels/certificates/archive.md +++ b/content/en/api/csharp/beta/tunnels/certificates/archive.md @@ -92,6 +92,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/csharp/beta/tunnels/certificates/create.md b/content/en/api/csharp/beta/tunnels/certificates/create.md index 29d8eb943..0eb300ec5 100644 --- a/content/en/api/csharp/beta/tunnels/certificates/create.md +++ b/content/en/api/csharp/beta/tunnels/certificates/create.md @@ -94,6 +94,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaTunnelCertificate:` @@ -138,7 +152,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's CertificateCreateParams parameters = new() { TunnelID = "tunnel_id", - CaCertificatePem = "ca_certificate_pem", + CACertificatePem = "ca_certificate_pem", }; var betaTunnelCertificate = await client.Beta.Tunnels.Certificates.Create(parameters); diff --git a/content/en/api/csharp/beta/tunnels/certificates/list.md b/content/en/api/csharp/beta/tunnels/certificates/list.md index 4d338689c..62d63fa67 100644 --- a/content/en/api/csharp/beta/tunnels/certificates/list.md +++ b/content/en/api/csharp/beta/tunnels/certificates/list.md @@ -102,6 +102,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class CertificateListPageResponse:` diff --git a/content/en/api/csharp/beta/tunnels/certificates/retrieve.md b/content/en/api/csharp/beta/tunnels/certificates/retrieve.md index 3af37e72f..06be80ae8 100644 --- a/content/en/api/csharp/beta/tunnels/certificates/retrieve.md +++ b/content/en/api/csharp/beta/tunnels/certificates/retrieve.md @@ -92,6 +92,20 @@ Fetches a tunnel certificate by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/csharp/beta/tunnels/create.md b/content/en/api/csharp/beta/tunnels/create.md index e146c5349..f015f566a 100644 --- a/content/en/api/csharp/beta/tunnels/create.md +++ b/content/en/api/csharp/beta/tunnels/create.md @@ -90,6 +90,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaTunnel:` diff --git a/content/en/api/csharp/beta/tunnels/list.md b/content/en/api/csharp/beta/tunnels/list.md index 6de8c0388..2cc9a64c7 100644 --- a/content/en/api/csharp/beta/tunnels/list.md +++ b/content/en/api/csharp/beta/tunnels/list.md @@ -98,6 +98,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class TunnelListPageResponse:` diff --git a/content/en/api/csharp/beta/tunnels/retrieve.md b/content/en/api/csharp/beta/tunnels/retrieve.md index b7ad0faf9..378413d7f 100644 --- a/content/en/api/csharp/beta/tunnels/retrieve.md +++ b/content/en/api/csharp/beta/tunnels/retrieve.md @@ -88,6 +88,20 @@ Fetches a tunnel by ID. - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaTunnel:` diff --git a/content/en/api/csharp/beta/tunnels/reveal_token.md b/content/en/api/csharp/beta/tunnels/reveal_token.md index 7beca25de..c66f4e306 100644 --- a/content/en/api/csharp/beta/tunnels/reveal_token.md +++ b/content/en/api/csharp/beta/tunnels/reveal_token.md @@ -88,6 +88,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaTunnelToken:` diff --git a/content/en/api/csharp/beta/tunnels/rotate_token.md b/content/en/api/csharp/beta/tunnels/rotate_token.md index deb35804b..b8c8a1f70 100644 --- a/content/en/api/csharp/beta/tunnels/rotate_token.md +++ b/content/en/api/csharp/beta/tunnels/rotate_token.md @@ -94,6 +94,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaTunnelToken:` diff --git a/content/en/api/csharp/beta/user_profiles.md b/content/en/api/csharp/beta/user_profiles.md index 01ee13b76..0b0ca5264 100644 --- a/content/en/api/csharp/beta/user_profiles.md +++ b/content/en/api/csharp/beta/user_profiles.md @@ -118,6 +118,20 @@ Create User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaUserProfile:` @@ -319,6 +333,20 @@ List User Profiles - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class UserProfileListPageResponse:` @@ -521,6 +549,20 @@ Get User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaUserProfile:` @@ -745,6 +787,20 @@ Update User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaUserProfile:` @@ -935,6 +991,20 @@ Create Enrollment URL - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaUserProfileEnrollmentUrl:` diff --git a/content/en/api/csharp/beta/user_profiles/create.md b/content/en/api/csharp/beta/user_profiles/create.md index 96b62422f..6b3f33a0d 100644 --- a/content/en/api/csharp/beta/user_profiles/create.md +++ b/content/en/api/csharp/beta/user_profiles/create.md @@ -116,6 +116,20 @@ Create User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaUserProfile:` diff --git a/content/en/api/csharp/beta/user_profiles/create_enrollment_url.md b/content/en/api/csharp/beta/user_profiles/create_enrollment_url.md index d0aefd291..11f36751f 100644 --- a/content/en/api/csharp/beta/user_profiles/create_enrollment_url.md +++ b/content/en/api/csharp/beta/user_profiles/create_enrollment_url.md @@ -86,6 +86,20 @@ Create Enrollment URL - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaUserProfileEnrollmentUrl:` diff --git a/content/en/api/csharp/beta/user_profiles/list.md b/content/en/api/csharp/beta/user_profiles/list.md index f92f276d5..fa759041a 100644 --- a/content/en/api/csharp/beta/user_profiles/list.md +++ b/content/en/api/csharp/beta/user_profiles/list.md @@ -100,6 +100,20 @@ List User Profiles - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class UserProfileListPageResponse:` diff --git a/content/en/api/csharp/beta/user_profiles/retrieve.md b/content/en/api/csharp/beta/user_profiles/retrieve.md index 4b5850caa..fe9efa5e6 100644 --- a/content/en/api/csharp/beta/user_profiles/retrieve.md +++ b/content/en/api/csharp/beta/user_profiles/retrieve.md @@ -86,6 +86,20 @@ Get User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaUserProfile:` diff --git a/content/en/api/csharp/beta/user_profiles/update.md b/content/en/api/csharp/beta/user_profiles/update.md index 04f138d80..1fbfe0381 100644 --- a/content/en/api/csharp/beta/user_profiles/update.md +++ b/content/en/api/csharp/beta/user_profiles/update.md @@ -120,6 +120,20 @@ Update User Profile - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaUserProfile:` diff --git a/content/en/api/csharp/beta/vaults.md b/content/en/api/csharp/beta/vaults.md index e5642f798..2ffd0ee74 100644 --- a/content/en/api/csharp/beta/vaults.md +++ b/content/en/api/csharp/beta/vaults.md @@ -94,6 +94,20 @@ Create Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsVault:` @@ -256,6 +270,20 @@ List Vaults - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class VaultListPageResponse:` @@ -423,6 +451,20 @@ Get Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsVault:` @@ -588,6 +630,20 @@ Update Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsVault:` @@ -743,6 +799,20 @@ Delete Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeletedVault:` @@ -865,6 +935,20 @@ Archive Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsVault:` @@ -1248,6 +1332,20 @@ Create Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredential:` @@ -1546,6 +1644,20 @@ List Credentials - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class CredentialListPageResponse:` @@ -1843,6 +1955,20 @@ Get Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredential:` @@ -2258,6 +2384,20 @@ Update Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredential:` @@ -2541,6 +2681,20 @@ Delete Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsDeletedCredential:` @@ -2668,6 +2822,20 @@ Archive Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredential:` @@ -2951,6 +3119,20 @@ Validate Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + #### Returns - `class BetaManagedAgentsCredentialValidation:` diff --git a/content/en/api/csharp/beta/vaults/archive.md b/content/en/api/csharp/beta/vaults/archive.md index df5eb9acd..4f9c42a30 100644 --- a/content/en/api/csharp/beta/vaults/archive.md +++ b/content/en/api/csharp/beta/vaults/archive.md @@ -86,6 +86,20 @@ Archive Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsVault:` diff --git a/content/en/api/csharp/beta/vaults/create.md b/content/en/api/csharp/beta/vaults/create.md index 60b34d0ef..56e096dc0 100644 --- a/content/en/api/csharp/beta/vaults/create.md +++ b/content/en/api/csharp/beta/vaults/create.md @@ -92,6 +92,20 @@ Create Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsVault:` diff --git a/content/en/api/csharp/beta/vaults/credentials.md b/content/en/api/csharp/beta/vaults/credentials.md index 1928b2920..bb50a1f11 100644 --- a/content/en/api/csharp/beta/vaults/credentials.md +++ b/content/en/api/csharp/beta/vaults/credentials.md @@ -262,6 +262,20 @@ Create Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsCredential:` @@ -560,6 +574,20 @@ List Credentials - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class CredentialListPageResponse:` @@ -857,6 +885,20 @@ Get Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsCredential:` @@ -1272,6 +1314,20 @@ Update Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsCredential:` @@ -1555,6 +1611,20 @@ Delete Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsDeletedCredential:` @@ -1682,6 +1752,20 @@ Archive Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsCredential:` @@ -1965,6 +2049,20 @@ Validate Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class BetaManagedAgentsCredentialValidation:` diff --git a/content/en/api/csharp/beta/vaults/credentials/archive.md b/content/en/api/csharp/beta/vaults/credentials/archive.md index ade53277b..2a8e1dad5 100644 --- a/content/en/api/csharp/beta/vaults/credentials/archive.md +++ b/content/en/api/csharp/beta/vaults/credentials/archive.md @@ -90,6 +90,20 @@ Archive Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsCredential:` diff --git a/content/en/api/csharp/beta/vaults/credentials/create.md b/content/en/api/csharp/beta/vaults/credentials/create.md index f822a7e07..8dcaf7b3e 100644 --- a/content/en/api/csharp/beta/vaults/credentials/create.md +++ b/content/en/api/csharp/beta/vaults/credentials/create.md @@ -260,6 +260,20 @@ Create Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsCredential:` diff --git a/content/en/api/csharp/beta/vaults/credentials/delete.md b/content/en/api/csharp/beta/vaults/credentials/delete.md index a7e8aaf82..9df1d52aa 100644 --- a/content/en/api/csharp/beta/vaults/credentials/delete.md +++ b/content/en/api/csharp/beta/vaults/credentials/delete.md @@ -90,6 +90,20 @@ Delete Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeletedCredential:` diff --git a/content/en/api/csharp/beta/vaults/credentials/list.md b/content/en/api/csharp/beta/vaults/credentials/list.md index 25b103dd0..62741399c 100644 --- a/content/en/api/csharp/beta/vaults/credentials/list.md +++ b/content/en/api/csharp/beta/vaults/credentials/list.md @@ -100,6 +100,20 @@ List Credentials - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class CredentialListPageResponse:` diff --git a/content/en/api/csharp/beta/vaults/credentials/mcp_oauth_validate.md b/content/en/api/csharp/beta/vaults/credentials/mcp_oauth_validate.md index e48fa76e9..5072e9a5d 100644 --- a/content/en/api/csharp/beta/vaults/credentials/mcp_oauth_validate.md +++ b/content/en/api/csharp/beta/vaults/credentials/mcp_oauth_validate.md @@ -90,6 +90,20 @@ Validate Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsCredentialValidation:` diff --git a/content/en/api/csharp/beta/vaults/credentials/retrieve.md b/content/en/api/csharp/beta/vaults/credentials/retrieve.md index a5c888394..210a14a71 100644 --- a/content/en/api/csharp/beta/vaults/credentials/retrieve.md +++ b/content/en/api/csharp/beta/vaults/credentials/retrieve.md @@ -90,6 +90,20 @@ Get Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsCredential:` diff --git a/content/en/api/csharp/beta/vaults/credentials/update.md b/content/en/api/csharp/beta/vaults/credentials/update.md index 1ea37c5f1..dc70ac57d 100644 --- a/content/en/api/csharp/beta/vaults/credentials/update.md +++ b/content/en/api/csharp/beta/vaults/credentials/update.md @@ -222,6 +222,20 @@ Update Credential - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsCredential:` diff --git a/content/en/api/csharp/beta/vaults/delete.md b/content/en/api/csharp/beta/vaults/delete.md index 5c6141a5c..ca73b9de8 100644 --- a/content/en/api/csharp/beta/vaults/delete.md +++ b/content/en/api/csharp/beta/vaults/delete.md @@ -86,6 +86,20 @@ Delete Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsDeletedVault:` diff --git a/content/en/api/csharp/beta/vaults/list.md b/content/en/api/csharp/beta/vaults/list.md index 297fe4c1c..b58abfe4f 100644 --- a/content/en/api/csharp/beta/vaults/list.md +++ b/content/en/api/csharp/beta/vaults/list.md @@ -96,6 +96,20 @@ List Vaults - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class VaultListPageResponse:` diff --git a/content/en/api/csharp/beta/vaults/retrieve.md b/content/en/api/csharp/beta/vaults/retrieve.md index 454cc1b8a..046048852 100644 --- a/content/en/api/csharp/beta/vaults/retrieve.md +++ b/content/en/api/csharp/beta/vaults/retrieve.md @@ -86,6 +86,20 @@ Get Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsVault:` diff --git a/content/en/api/csharp/beta/vaults/update.md b/content/en/api/csharp/beta/vaults/update.md index 154e458c3..72e70f026 100644 --- a/content/en/api/csharp/beta/vaults/update.md +++ b/content/en/api/csharp/beta/vaults/update.md @@ -96,6 +96,20 @@ Update Vault - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class BetaManagedAgentsVault:` diff --git a/content/en/api/csharp/models.md b/content/en/api/csharp/models.md index b123521d5..23dfb30d2 100644 --- a/content/en/api/csharp/models.md +++ b/content/en/api/csharp/models.md @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class ModelListPageResponse:` @@ -431,6 +445,20 @@ The Models API response can be used to determine information about a specific mo - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ### Returns - `class ModelInfo:` diff --git a/content/en/api/csharp/models/list.md b/content/en/api/csharp/models/list.md index 5154c003f..a706efdb6 100644 --- a/content/en/api/csharp/models/list.md +++ b/content/en/api/csharp/models/list.md @@ -100,6 +100,20 @@ The Models API response can be used to determine which models are available for - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class ModelListPageResponse:` diff --git a/content/en/api/csharp/models/retrieve.md b/content/en/api/csharp/models/retrieve.md index 57b033926..c11c17fbc 100644 --- a/content/en/api/csharp/models/retrieve.md +++ b/content/en/api/csharp/models/retrieve.md @@ -88,6 +88,20 @@ The Models API response can be used to determine information about a specific mo - `MidConversationToolChanges2026_07_01` + - `Compact2026_01_12` + + - `ComputerUse2025_11_24` + + - `McpTunnels2026_06_22` + + - `StructuredOutputs2025_11_13` + + - `TaskBudgets2026_03_13` + + - `ThinkingDisplayUpdates2026_08_18` + + - `CEUserManagement2026_07_13` + ## Returns - `class ModelInfo:` diff --git a/content/en/api/go/beta.md b/content/en/api/go/beta.md index c6eaef775..b8326e0cc 100644 --- a/content/en/api/go/beta.md +++ b/content/en/api/go/beta.md @@ -78,6 +78,20 @@ - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Beta API Error - `type BetaAPIError struct{…}` @@ -508,6 +522,20 @@ The Models API response can be used to determine which models are available for - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaModelInfo struct{…}` @@ -849,6 +877,20 @@ The Models API response can be used to determine information about a specific mo - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaModelInfo struct{…}` @@ -4648,6 +4690,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -6113,12 +6169,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -6428,12 +6486,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `OutputTokens int64` The cumulative number of output tokens which were used. @@ -10169,6 +10229,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -11959,6 +12033,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` + - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` + - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` @@ -11975,6 +12051,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` + - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` + - `Default` - `InferenceGeo string Optional` @@ -14142,6 +14220,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -14414,6 +14506,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaMessageBatch struct{…}` @@ -14682,6 +14788,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaMessageBatch struct{…}` @@ -14943,6 +15063,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaMessageBatch struct{…}` @@ -15201,6 +15335,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaDeletedMessageBatch struct{…}` @@ -15351,6 +15499,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaMessageBatchIndividualResponse struct{…}` @@ -16786,12 +16948,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -17873,6 +18037,20 @@ Create Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -18624,6 +18802,20 @@ List Agents - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -19357,6 +19549,20 @@ Get Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -20689,6 +20895,20 @@ Update Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -21417,6 +21637,20 @@ Archive Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -22155,6 +22389,20 @@ List Agent Versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -22860,7 +23108,7 @@ Create a new environment with the specified configuration. - `AllowPackageManagers bool Optional` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `AllowedHosts []string Optional` @@ -22872,6 +23120,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Apt []string Optional` Ubuntu/Debian packages to install @@ -23004,6 +23254,20 @@ Create a new environment with the specified configuration. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaEnvironment struct{…}` @@ -23316,6 +23580,20 @@ List environments with pagination support. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaEnvironment struct{…}` @@ -23619,6 +23897,20 @@ Retrieve a specific environment by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaEnvironment struct{…}` @@ -23889,7 +24181,7 @@ Update an existing environment's configuration. - `AllowPackageManagers bool Optional` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `AllowedHosts []string Optional` @@ -23901,6 +24193,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Apt []string Optional` Ubuntu/Debian packages to install @@ -24039,6 +24333,20 @@ Update an existing environment's configuration. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaEnvironment struct{…}` @@ -24341,6 +24649,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaEnvironmentDeleteResponse struct{…}` @@ -24485,6 +24807,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaEnvironment struct{…}` @@ -24795,6 +25131,20 @@ Retrieve detailed information about a specific work item. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -25037,6 +25387,20 @@ Long poll for work items in the queue. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `AnthropicWorkerID param.Field[string] Optional` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -25273,6 +25637,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -25515,6 +25893,20 @@ Record a heartbeat for a work item to maintain the lease. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWorkHeartbeatResponse struct{…}` @@ -25696,6 +26088,20 @@ Stop a work item, initiating graceful or forced shutdown. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -25937,6 +26343,20 @@ List work items in an environment. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -26178,6 +26598,20 @@ Update work item metadata with merge semantics. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -26411,6 +26845,20 @@ Get statistics about the work queue for an environment. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWorkQueueStats struct{…}` @@ -27516,6 +27964,20 @@ Create Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSession struct{…}` @@ -28738,6 +29200,20 @@ List Sessions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSession struct{…}` @@ -29887,6 +30363,20 @@ Get Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSession struct{…}` @@ -31056,6 +31546,20 @@ Update Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSession struct{…}` @@ -32203,6 +32707,20 @@ Delete Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeletedSession struct{…}` @@ -32341,6 +32859,20 @@ Archive Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSession struct{…}` @@ -33536,6 +34068,20 @@ List Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` @@ -36177,6 +36723,20 @@ Send Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSendSessionEvents struct{…}` @@ -36782,6 +37342,20 @@ Stream Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsStreamSessionEventsUnion interface{…}` @@ -39110,6 +39684,20 @@ Add Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsFileResource struct{…}` @@ -39281,6 +39869,20 @@ List Session Resources - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionResourceUnion interface{…}` @@ -39542,6 +40144,20 @@ Get Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSessionResourceGetResponseUnion interface{…}` @@ -39798,6 +40414,20 @@ Update Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSessionResourceUpdateResponseUnion interface{…}` @@ -40049,6 +40679,20 @@ Delete Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeleteSessionResource struct{…}` @@ -40201,6 +40845,20 @@ List Session Threads - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -40213,7 +40871,7 @@ List Session Threads - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -41050,6 +41708,20 @@ Get Session Thread - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -41062,7 +41734,7 @@ Get Session Thread - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -41896,6 +42568,20 @@ Archive Session Thread - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -41908,7 +42594,7 @@ Archive Session Thread - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -42754,6 +43440,20 @@ List Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` @@ -45036,6 +45736,20 @@ Stream Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsStreamSessionThreadEventsUnion interface{…}` @@ -47732,6 +48446,20 @@ Create Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -48479,6 +49207,20 @@ List Deployments - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -49182,6 +49924,20 @@ Get Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -50256,6 +51012,20 @@ Update Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -50958,6 +51728,20 @@ Archive Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -51660,6 +52444,20 @@ Run Deployment Now - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeploymentRun struct{…}` @@ -52028,6 +52826,20 @@ Pause Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -52730,6 +53542,20 @@ Unpause Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -53478,6 +54304,20 @@ List Deployment Runs - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeploymentRun struct{…}` @@ -53847,6 +54687,20 @@ Get Deployment Run - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeploymentRun struct{…}` @@ -54225,6 +55079,20 @@ Create Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsVault struct{…}` @@ -54408,6 +55276,20 @@ List Vaults - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsVault struct{…}` @@ -54582,6 +55464,20 @@ Get Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsVault struct{…}` @@ -54765,6 +55661,20 @@ Update Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsVault struct{…}` @@ -54938,6 +55848,20 @@ Delete Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeletedVault struct{…}` @@ -55078,6 +56002,20 @@ Archive Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsVault struct{…}` @@ -55427,6 +56365,20 @@ Create Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -55745,6 +56697,20 @@ List Credentials - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -56050,6 +57016,20 @@ Get Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -56484,6 +57464,20 @@ Update Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -56786,6 +57780,20 @@ Delete Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeletedCredential struct{…}` @@ -56932,6 +57940,20 @@ Archive Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -57234,6 +58256,20 @@ Validate Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredentialValidation struct{…}` @@ -57488,6 +58524,20 @@ Create a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -57688,6 +58738,20 @@ List memory stores - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -57867,6 +58931,20 @@ Retrieve a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -58061,6 +59139,20 @@ Update a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -58239,6 +59331,20 @@ Delete a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeletedMemoryStore struct{…}` @@ -58379,6 +59485,20 @@ Archive a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -58573,6 +59693,20 @@ Create a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemory struct{…}` @@ -58605,7 +59739,7 @@ Create a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -58786,6 +59920,20 @@ List memories - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryListItemUnion interface{…}` @@ -58822,7 +59970,7 @@ List memories - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -58999,215 +60147,19 @@ Retrieve a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` -#### Returns - -- `type BetaManagedAgentsMemory struct{…}` - - A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - - - `ID string` - - Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - - - `ContentSha256 string` - - Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. - - - `ContentSizeBytes int64` - - Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. - - format: int32 - - - `CreatedAt Time` - - A timestamp in RFC 3339 format - - format: date-time - - - `MemoryStoreID string` - - ID of the memory store this memory belongs to (a `memstore_...` value). - - - `MemoryVersionID string` - - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - - - `Path string` - - Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - - - `Type BetaManagedAgentsMemoryType` - - - `UpdatedAt Time` - - A timestamp in RFC 3339 format - - format: date-time - - - `Content string Optional` - - The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). - -#### Example - -```go -package main - -import ( - "context" - "fmt" - - "github.com/anthropics/anthropic-sdk-go" - "github.com/anthropics/anthropic-sdk-go/option" -) - -func main() { - client := anthropic.NewClient( - option.WithAPIKey("my-anthropic-api-key"), - ) - betaManagedAgentsMemory, err := client.Beta.MemoryStores.Memories.Get( - context.TODO(), - "memory_id", - anthropic.BetaMemoryStoreMemoryGetParams{ - MemoryStoreID: "memory_store_id", - }, - ) - if err != nil { - panic(err.Error()) - } - fmt.Printf("%+v\n", betaManagedAgentsMemory.ID) -} -``` - -##### Response (200) + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` -```json -{ - "id": "id", - "content_sha256": "content_sha256", - "content_size_bytes": 0, - "created_at": "2019-12-27T18:11:19.117Z", - "memory_store_id": "memory_store_id", - "memory_version_id": "memory_version_id", - "path": "path", - "type": "memory", - "updated_at": "2019-12-27T18:11:19.117Z", - "content": "content" -} -``` - -### Update a memory - -`client.Beta.MemoryStores.Memories.Update(ctx, memoryID, params) (*BetaManagedAgentsMemory, error)` - -**POST** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` -Update a memory + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` -#### Parameters + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` -- `memoryID string` + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` -- `params BetaMemoryStoreMemoryUpdateParams` + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - - `MemoryStoreID param.Field[string]` - - Path param: Path parameter memory_store_id - - - `View param.Field[BetaManagedAgentsMemoryView] Optional` - - Query param: Query parameter for view - - - `Content param.Field[string] Optional` - - Body param: New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). - - - `Path param.Field[string] Optional` - - Body param: New path for the memory (a rename). Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged. - - minLength: 2, maxLength: 1024 - - - `Precondition param.Field[BetaManagedAgentsPrecondition] Optional` - - Body param: Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409. - - - `Betas param.Field[[]AnthropicBeta] Optional` - - Header param: Optional header to specify the beta version(s) you want to use. - - - `string` - - - `type AnthropicBeta string` - - - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - - - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - - - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - - - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - - - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - - - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - - - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - - - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - - - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - - - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - - - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - - - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - - - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - - - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - - - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - - - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - - - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - - - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - - - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - - - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - - - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - - - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - - - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - - - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - - - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - - - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - - - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - - - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - - - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - - - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - - - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - - - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - - - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - - - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` #### Returns @@ -59241,7 +60193,231 @@ Update a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + + - `Path string` + + Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. + + - `Type BetaManagedAgentsMemoryType` + + - `UpdatedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `Content string Optional` + + The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaManagedAgentsMemory, err := client.Beta.MemoryStores.Memories.Get( + context.TODO(), + "memory_id", + anthropic.BetaMemoryStoreMemoryGetParams{ + MemoryStoreID: "memory_store_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaManagedAgentsMemory.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "id", + "content_sha256": "content_sha256", + "content_size_bytes": 0, + "created_at": "2019-12-27T18:11:19.117Z", + "memory_store_id": "memory_store_id", + "memory_version_id": "memory_version_id", + "path": "path", + "type": "memory", + "updated_at": "2019-12-27T18:11:19.117Z", + "content": "content" +} +``` + +### Update a memory + +`client.Beta.MemoryStores.Memories.Update(ctx, memoryID, params) (*BetaManagedAgentsMemory, error)` + +**POST** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` + +Update a memory + +#### Parameters + +- `memoryID string` + +- `params BetaMemoryStoreMemoryUpdateParams` + + - `MemoryStoreID param.Field[string]` + + Path param: Path parameter memory_store_id + + - `View param.Field[BetaManagedAgentsMemoryView] Optional` + + Query param: Query parameter for view + + - `Content param.Field[string] Optional` + + Body param: New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). + + - `Path param.Field[string] Optional` + + Body param: New path for the memory (a rename). Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged. + + minLength: 2, maxLength: 1024 + + - `Precondition param.Field[BetaManagedAgentsPrecondition] Optional` + + Body param: Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaManagedAgentsMemory struct{…}` + + A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. + + - `ID string` + + Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. + + - `ContentSha256 string` + + Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. + + - `ContentSizeBytes int64` + + Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. + + format: int32 + + - `CreatedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `MemoryStoreID string` + + ID of the memory store this memory belongs to (a `memstore_...` value). + + - `MemoryVersionID string` + + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -59405,11 +60581,25 @@ Delete a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeletedMemory struct{…}` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `ID string` @@ -59595,11 +60785,25 @@ List memory versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -59613,7 +60817,7 @@ List memory versions - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` @@ -59869,11 +61073,25 @@ Retrieve a memory version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -59887,7 +61105,7 @@ Retrieve a memory version - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` @@ -60136,11 +61354,25 @@ Redact a memory version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -60154,7 +61386,7 @@ Redact a memory version - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` @@ -60405,6 +61637,20 @@ Upload File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaFileMetadata struct{…}` @@ -60618,6 +61864,20 @@ List Files - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaFileMetadata struct{…}` @@ -60818,6 +62078,20 @@ Download File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaFileDownloadResponse interface{…}` @@ -60943,6 +62217,20 @@ Get File Metadata - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaFileMetadata struct{…}` @@ -61140,6 +62428,20 @@ Delete File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaDeletedFile struct{…}` @@ -61296,6 +62598,20 @@ Create Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillNewResponse struct{…}` @@ -61495,6 +62811,20 @@ List Skills - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillListResponse struct{…}` @@ -61681,6 +63011,20 @@ Get Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillGetResponse struct{…}` @@ -61865,6 +63209,20 @@ Delete Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillDeleteResponse struct{…}` @@ -62023,6 +63381,20 @@ Create Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionNewResponse struct{…}` @@ -62225,6 +63597,20 @@ List Skill Versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionListResponse struct{…}` @@ -62425,6 +63811,20 @@ Download a skill version's content as a zip archive. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionDownloadResponse interface{…}` @@ -62560,6 +63960,20 @@ Get Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionGetResponse struct{…}` @@ -62756,6 +64170,20 @@ Delete Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionDeleteResponse struct{…}` @@ -62967,6 +64395,20 @@ Create User Profile - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaUserProfile struct{…}` @@ -63187,214 +64629,242 @@ List User Profiles - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` -#### Returns + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` -- `type BetaUserProfile struct{…}` + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - - `ID string` - - Unique identifier for this user profile, prefixed `uprof_`. - - - `CreatedAt Time` - - A timestamp in RFC 3339 format - - format: date-time + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - - `Metadata map[string, string]` + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - - `TrustGrants map[string, BetaUserProfileTrustGrant]` - - Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - - - `Status BetaUserProfileTrustGrantStatus` - - Status of the trust grant. - - - `const BetaUserProfileTrustGrantStatusActive BetaUserProfileTrustGrantStatus = "active"` - - - `const BetaUserProfileTrustGrantStatusPending BetaUserProfileTrustGrantStatus = "pending"` - - - `const BetaUserProfileTrustGrantStatusRejected BetaUserProfileTrustGrantStatus = "rejected"` - - - `Type BetaUserProfileType` - - Object type. Always `user_profile`. - - - `UpdatedAt Time` - - A timestamp in RFC 3339 format - - format: date-time - - - `AccessType BetaUserProfileAccessType Optional` - - How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. - - - `const BetaUserProfileAccessTypeApplication BetaUserProfileAccessType = "application"` - - - `const BetaUserProfileAccessTypePassthrough BetaUserProfileAccessType = "passthrough"` - - - `ExternalID string Optional` - - Platform's own identifier for this user. Not enforced unique. - - - `Name string Optional` - - Real-world name of the entity this profile represents (company or individual). For a resold-to company (`access_type` `passthrough`, or `relationship` `resold` under the `user-profiles-2026-03-24` header) this is that company's name. - - - `Relationship BetaUserProfileRelationship Optional` - - How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - - `const BetaUserProfileRelationshipExternal BetaUserProfileRelationship = "external"` - - - `const BetaUserProfileRelationshipResold BetaUserProfileRelationship = "resold"` - - - `const BetaUserProfileRelationshipInternal BetaUserProfileRelationship = "internal"` - -#### Example - -```go -package main - -import ( - "context" - "fmt" - - "github.com/anthropics/anthropic-sdk-go" - "github.com/anthropics/anthropic-sdk-go/option" -) - -func main() { - client := anthropic.NewClient( - option.WithAPIKey("my-anthropic-api-key"), - ) - page, err := client.Beta.UserProfiles.List(context.TODO(), anthropic.BetaUserProfileListParams{}) - if err != nil { - panic(err.Error()) - } - fmt.Printf("%+v\n", page) -} -``` - -##### Response (200) - -```json -{ - "data": [ - { - "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", - "created_at": "2026-03-15T10:00:00Z", - "metadata": {}, - "trust_grants": { - "cyber": { - "status": "active" - } - }, - "type": "user_profile", - "updated_at": "2026-03-15T10:00:00Z", - "access_type": "application", - "external_id": "user_12345", - "name": "Example User", - "relationship": "external" - } - ], - "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" -} -``` - -### Get User Profile - -`client.Beta.UserProfiles.Get(ctx, userProfileID, query) (*BetaUserProfile, error)` - -**GET** `/v1/user_profiles/{user_profile_id}` - -Get User Profile - -#### Parameters - -- `userProfileID string` - -- `query BetaUserProfileGetParams` - - - `Betas param.Field[[]AnthropicBeta] Optional` - - Optional header to specify the beta version(s) you want to use. - - - `string` - - - `type AnthropicBeta string` - - - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - - - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - - - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - - - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - - - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - - - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - - - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - - - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - - - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - - - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - - - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - - - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - - - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - - - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - - - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - - - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - - - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - - - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - - - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - - - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - - - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - - - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - - - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - - - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - - - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - - - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - - - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - - - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - - - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - - - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - - - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - - - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - - - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - - - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaUserProfile struct{…}` + + - `ID string` + + Unique identifier for this user profile, prefixed `uprof_`. + + - `CreatedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `Metadata map[string, string]` + + Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. + + - `TrustGrants map[string, BetaUserProfileTrustGrant]` + + Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. + + - `Status BetaUserProfileTrustGrantStatus` + + Status of the trust grant. + + - `const BetaUserProfileTrustGrantStatusActive BetaUserProfileTrustGrantStatus = "active"` + + - `const BetaUserProfileTrustGrantStatusPending BetaUserProfileTrustGrantStatus = "pending"` + + - `const BetaUserProfileTrustGrantStatusRejected BetaUserProfileTrustGrantStatus = "rejected"` + + - `Type BetaUserProfileType` + + Object type. Always `user_profile`. + + - `UpdatedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `AccessType BetaUserProfileAccessType Optional` + + How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. + + - `const BetaUserProfileAccessTypeApplication BetaUserProfileAccessType = "application"` + + - `const BetaUserProfileAccessTypePassthrough BetaUserProfileAccessType = "passthrough"` + + - `ExternalID string Optional` + + Platform's own identifier for this user. Not enforced unique. + + - `Name string Optional` + + Real-world name of the entity this profile represents (company or individual). For a resold-to company (`access_type` `passthrough`, or `relationship` `resold` under the `user-profiles-2026-03-24` header) this is that company's name. + + - `Relationship BetaUserProfileRelationship Optional` + + How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. + + - `const BetaUserProfileRelationshipExternal BetaUserProfileRelationship = "external"` + + - `const BetaUserProfileRelationshipResold BetaUserProfileRelationship = "resold"` + + - `const BetaUserProfileRelationshipInternal BetaUserProfileRelationship = "internal"` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.UserProfiles.List(context.TODO(), anthropic.BetaUserProfileListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", + "created_at": "2026-03-15T10:00:00Z", + "metadata": {}, + "trust_grants": { + "cyber": { + "status": "active" + } + }, + "type": "user_profile", + "updated_at": "2026-03-15T10:00:00Z", + "access_type": "application", + "external_id": "user_12345", + "name": "Example User", + "relationship": "external" + } + ], + "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" +} +``` + +### Get User Profile + +`client.Beta.UserProfiles.Get(ctx, userProfileID, query) (*BetaUserProfile, error)` + +**GET** `/v1/user_profiles/{user_profile_id}` + +Get User Profile + +#### Parameters + +- `userProfileID string` + +- `query BetaUserProfileGetParams` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` #### Returns @@ -63638,6 +65108,20 @@ Update User Profile - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaUserProfile struct{…}` @@ -63846,6 +65330,20 @@ Create Enrollment URL - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaUserProfileEnrollmentURL struct{…}` @@ -64049,6 +65547,20 @@ Create a Dream - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaDream struct{…}` @@ -64402,6 +65914,20 @@ List Dreams - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaDream struct{…}` @@ -64712,6 +66238,20 @@ Get a Dream - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaDream struct{…}` @@ -65021,6 +66561,20 @@ Cancel a Dream - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaDream struct{…}` @@ -65330,6 +66884,20 @@ Archive a Dream - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaDream struct{…}` @@ -65647,6 +67215,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnel struct{…}` @@ -65809,6 +67391,20 @@ Fetches a tunnel by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnel struct{…}` @@ -65987,6 +67583,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnel struct{…}` @@ -66154,6 +67764,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnel struct{…}` @@ -66320,6 +67944,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnelToken struct{…}` @@ -66473,6 +68111,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnelToken struct{…}` @@ -66546,7 +68198,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `params BetaTunnelCertificateNewParams` - - `CaCertificatePem param.Field[string]` + - `CACertificatePEM param.Field[string]` Body param: PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -66628,43 +68280,11027 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaTunnelCertificate struct{…}` + + A CA certificate attached to a tunnel. + + - `ID string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `ArchivedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `CreatedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `ExpiresAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `Fingerprint string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `TunnelID string` + + ID of the tunnel the certificate is registered against. + + - `Type TunnelCertificate` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaTunnelCertificate, err := client.Beta.Tunnels.Certificates.New( + context.TODO(), + "tunnel_id", + anthropic.BetaTunnelCertificateNewParams{ + CACertificatePEM: "ca_certificate_pem", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaTunnelCertificate.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### Get Tunnel Certificate + +`client.Beta.Tunnels.Certificates.Get(ctx, certificateID, params) (*BetaTunnelCertificate, error)` + +**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Fetches a tunnel certificate by ID. + +#### Parameters + +- `certificateID string` + +- `params BetaTunnelCertificateGetParams` + + - `TunnelID param.Field[string]` + + Path param: Path parameter tunnel_id + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaTunnelCertificate struct{…}` + + A CA certificate attached to a tunnel. + + - `ID string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `ArchivedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `CreatedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `ExpiresAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `Fingerprint string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `TunnelID string` + + ID of the tunnel the certificate is registered against. + + - `Type TunnelCertificate` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaTunnelCertificate, err := client.Beta.Tunnels.Certificates.Get( + context.TODO(), + "certificate_id", + anthropic.BetaTunnelCertificateGetParams{ + TunnelID: "tunnel_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaTunnelCertificate.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### List Tunnel Certificates + +`client.Beta.Tunnels.Certificates.List(ctx, tunnelID, params) (*PageCursor[BetaTunnelCertificate], error)` + +**GET** `/v1/tunnels/{tunnel_id}/certificates` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. + +#### Parameters + +- `tunnelID string` + +- `params BetaTunnelCertificateListParams` + + - `IncludeArchived param.Field[bool] Optional` + + Query param: Whether to include archived certificates in the results. Defaults to false. + + - `Limit param.Field[int64] Optional` + + Query param: Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + + format: int32 + + - `Page param.Field[string] Optional` + + Query param: Opaque pagination cursor from a previous `list_tunnel_certificates` response. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaTunnelCertificate struct{…}` + + A CA certificate attached to a tunnel. + + - `ID string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `ArchivedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `CreatedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `ExpiresAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `Fingerprint string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `TunnelID string` + + ID of the tunnel the certificate is registered against. + + - `Type TunnelCertificate` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Tunnels.Certificates.List( + context.TODO(), + "tunnel_id", + anthropic.BetaTunnelCertificateListParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" + } + ], + "next_page": "next_page" +} +``` + +### Archive Tunnel Certificate + +`client.Beta.Tunnels.Certificates.Archive(ctx, certificateID, params) (*BetaTunnelCertificate, error)` + +**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. + +#### Parameters + +- `certificateID string` + +- `params BetaTunnelCertificateArchiveParams` + + - `TunnelID param.Field[string]` + + Path param: Path parameter tunnel_id + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaTunnelCertificate struct{…}` + + A CA certificate attached to a tunnel. + + - `ID string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `ArchivedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `CreatedAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `ExpiresAt Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `Fingerprint string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `TunnelID string` + + ID of the tunnel the certificate is registered against. + + - `Type TunnelCertificate` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaTunnelCertificate, err := client.Beta.Tunnels.Certificates.Archive( + context.TODO(), + "certificate_id", + anthropic.BetaTunnelCertificateArchiveParams{ + TunnelID: "tunnel_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaTunnelCertificate.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +## Beta › Organization + +### Get Current Organization + +`client.Beta.Organization.Get(ctx) (*BetaOrganization, error)` + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Returns + +- `type BetaOrganization struct{…}` + + - `ID string` + + ID of the Organization. + + format: uuid + + - `Name string` + + Name of the Organization. + + - `Type Organization` + + Object type. + + For Organizations, this is always `"organization"`. + + default: organization + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaOrganization, err := client.Beta.Organization.Get(context.TODO()) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaOrganization.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +`client.Beta.Organization.APIKeys.List(ctx, query) (*Page[BetaAPIKey], error)` + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Parameters + +- `query BetaOrganizationAPIKeyListParams` + + - `AfterID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `BeforeID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `CreatedByUserID param.Field[string] Optional` + + Filter by the ID of the User who created the object. + + - `Limit param.Field[int64] Optional` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `Status param.Field[BetaOrganizationAPIKeyListParamsStatus] Optional` + + Filter by API key status. + + - `const BetaOrganizationAPIKeyListParamsStatusActive BetaOrganizationAPIKeyListParamsStatus = "active"` + + - `const BetaOrganizationAPIKeyListParamsStatusArchived BetaOrganizationAPIKeyListParamsStatus = "archived"` + + - `const BetaOrganizationAPIKeyListParamsStatusExpired BetaOrganizationAPIKeyListParamsStatus = "expired"` + + - `const BetaOrganizationAPIKeyListParamsStatusInactive BetaOrganizationAPIKeyListParamsStatus = "inactive"` + + - `WorkspaceID param.Field[string] Optional` + + Filter by Workspace ID. + +#### Returns + +- `type BetaAPIKey struct{…}` + + - `ID string` + + ID of the API key. + + - `CreatedAt Time` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `CreatedBy BetaAPIKeyCreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `ID string` + + ID of the actor that created the object. + + - `Type BetaAPIKeyCreatedByType` + + Type of the actor that created the object. + + - `const BetaAPIKeyCreatedByTypeServiceAccount BetaAPIKeyCreatedByType = "service_account"` + + - `const BetaAPIKeyCreatedByTypeUser BetaAPIKeyCreatedByType = "user"` + + - `ExpiresAt Time` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `Name string` + + Name of the API key. + + - `PartialKeyHint string` + + Partially redacted hint for the API key. + + - `Principal BetaAPIKeyPrincipalUnion` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `type BetaAPIKeyUserActor struct{…}` + + - `Type UserActor` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `UserID string` + + ID of the User the API key acts as. + + - `type BetaAPIKeyServiceAccountActor struct{…}` + + - `ServiceAccountID string` + + ID of the Service Account the API key acts as. + + - `Type ServiceAccountActor` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `Scope BetaAPIKeyScopeUnion` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `type BetaAPIKeyOrganizationScope struct{…}` + + - `Type Organization` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `type BetaAPIKeyWorkspaceScope struct{…}` + + - `Type Workspace` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `WorkspaceID string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `Status BetaAPIKeyStatus` + + Status of the API key. + + - `const BetaAPIKeyStatusActive BetaAPIKeyStatus = "active"` + + - `const BetaAPIKeyStatusArchived BetaAPIKeyStatus = "archived"` + + - `const BetaAPIKeyStatusExpired BetaAPIKeyStatus = "expired"` + + - `const BetaAPIKeyStatusInactive BetaAPIKeyStatus = "inactive"` + + - `Type APIKey` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `WorkspaceID string` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.APIKeys.List(context.TODO(), anthropic.BetaOrganizationAPIKeyListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +`client.Beta.Organization.APIKeys.Get(ctx, apiKeyID) (*BetaAPIKey, error)` + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Parameters + +- `apiKeyID string` + + ID of the API key. + +#### Returns + +- `type BetaAPIKey struct{…}` + + - `ID string` + + ID of the API key. + + - `CreatedAt Time` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `CreatedBy BetaAPIKeyCreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `ID string` + + ID of the actor that created the object. + + - `Type BetaAPIKeyCreatedByType` + + Type of the actor that created the object. + + - `const BetaAPIKeyCreatedByTypeServiceAccount BetaAPIKeyCreatedByType = "service_account"` + + - `const BetaAPIKeyCreatedByTypeUser BetaAPIKeyCreatedByType = "user"` + + - `ExpiresAt Time` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `Name string` + + Name of the API key. + + - `PartialKeyHint string` + + Partially redacted hint for the API key. + + - `Principal BetaAPIKeyPrincipalUnion` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `type BetaAPIKeyUserActor struct{…}` + + - `Type UserActor` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `UserID string` + + ID of the User the API key acts as. + + - `type BetaAPIKeyServiceAccountActor struct{…}` + + - `ServiceAccountID string` + + ID of the Service Account the API key acts as. + + - `Type ServiceAccountActor` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `Scope BetaAPIKeyScopeUnion` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `type BetaAPIKeyOrganizationScope struct{…}` + + - `Type Organization` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `type BetaAPIKeyWorkspaceScope struct{…}` + + - `Type Workspace` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `WorkspaceID string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `Status BetaAPIKeyStatus` + + Status of the API key. + + - `const BetaAPIKeyStatusActive BetaAPIKeyStatus = "active"` + + - `const BetaAPIKeyStatusArchived BetaAPIKeyStatus = "archived"` + + - `const BetaAPIKeyStatusExpired BetaAPIKeyStatus = "expired"` + + - `const BetaAPIKeyStatusInactive BetaAPIKeyStatus = "inactive"` + + - `Type APIKey` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `WorkspaceID string` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaAPIKey, err := client.Beta.Organization.APIKeys.Get(context.TODO(), "api_key_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaAPIKey.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +`client.Beta.Organization.APIKeys.Update(ctx, apiKeyID, body) (*BetaAPIKey, error)` + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Parameters + +- `apiKeyID string` + + ID of the API key. + +- `body BetaOrganizationAPIKeyUpdateParams` + + - `Name param.Field[string] Optional` + + Name of the API key. + + maxLength: 500, minLength: 1 + + - `Status param.Field[BetaOrganizationAPIKeyUpdateParamsStatus] Optional` + + Status of the API key. + + - `const BetaOrganizationAPIKeyUpdateParamsStatusActive BetaOrganizationAPIKeyUpdateParamsStatus = "active"` + + - `const BetaOrganizationAPIKeyUpdateParamsStatusArchived BetaOrganizationAPIKeyUpdateParamsStatus = "archived"` + + - `const BetaOrganizationAPIKeyUpdateParamsStatusInactive BetaOrganizationAPIKeyUpdateParamsStatus = "inactive"` + +#### Returns + +- `type BetaAPIKey struct{…}` + + - `ID string` + + ID of the API key. + + - `CreatedAt Time` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `CreatedBy BetaAPIKeyCreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `ID string` + + ID of the actor that created the object. + + - `Type BetaAPIKeyCreatedByType` + + Type of the actor that created the object. + + - `const BetaAPIKeyCreatedByTypeServiceAccount BetaAPIKeyCreatedByType = "service_account"` + + - `const BetaAPIKeyCreatedByTypeUser BetaAPIKeyCreatedByType = "user"` + + - `ExpiresAt Time` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `Name string` + + Name of the API key. + + - `PartialKeyHint string` + + Partially redacted hint for the API key. + + - `Principal BetaAPIKeyPrincipalUnion` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `type BetaAPIKeyUserActor struct{…}` + + - `Type UserActor` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `UserID string` + + ID of the User the API key acts as. + + - `type BetaAPIKeyServiceAccountActor struct{…}` + + - `ServiceAccountID string` + + ID of the Service Account the API key acts as. + + - `Type ServiceAccountActor` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `Scope BetaAPIKeyScopeUnion` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `type BetaAPIKeyOrganizationScope struct{…}` + + - `Type Organization` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `type BetaAPIKeyWorkspaceScope struct{…}` + + - `Type Workspace` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `WorkspaceID string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `Status BetaAPIKeyStatus` + + Status of the API key. + + - `const BetaAPIKeyStatusActive BetaAPIKeyStatus = "active"` + + - `const BetaAPIKeyStatusArchived BetaAPIKeyStatus = "archived"` + + - `const BetaAPIKeyStatusExpired BetaAPIKeyStatus = "expired"` + + - `const BetaAPIKeyStatusInactive BetaAPIKeyStatus = "inactive"` + + - `Type APIKey` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `WorkspaceID string` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaAPIKey, err := client.Beta.Organization.APIKeys.Update( + context.TODO(), + "api_key_id", + anthropic.BetaOrganizationAPIKeyUpdateParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaAPIKey.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +`client.Beta.Organization.ExternalKeys.New(ctx, body) (*BetaExternalKey, error)` + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Parameters + +- `body BetaOrganizationExternalKeyNewParams` + + - `ProviderConfig param.Field[BetaOrganizationExternalKeyNewParamsProviderConfigUnion]` + + KMS provider identity and auth coordinates. + + - `type BetaAWSExternalKeyConfig struct{…}` + + - `KMSARN string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `Type AWS` + + - `Region string Optional` + + AWS region. Derived from `kms_arn` if omitted. + + - `RoleARN string Optional` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `type BetaGCPExternalKeyConfig struct{…}` + + - `KeyName string` + + Full resource name of the Cloud KMS key. + + - `Type GCP` + + - `type BetaAzureExternalKeyConfigParamResp struct{…}` + + Azure Key Vault provider configuration. + + - `KeyName string` + + Name of the key within the vault. + + - `TenantID string` + + Azure AD tenant ID. + + - `Type Azure` + + - `VaultURI string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `ClientID string Optional` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `DisplayName param.Field[string] Optional` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + + - `Geo param.Field[BetaOrganizationExternalKeyNewParamsGeo] Optional` + + Data residency geo. Only `us` is supported. + + - `const BetaOrganizationExternalKeyNewParamsGeoUs BetaOrganizationExternalKeyNewParamsGeo = "us"` + +#### Returns + +- `type BetaExternalKey struct{…}` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `ID string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment BetaExternalKeyAttachmentUnion` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `type BetaExternalKeyAttachedAttachment struct{…}` + + - `Type Attached` + + default: attached + + - `type BetaExternalKeyUnattachedAttachment struct{…}` + + - `Type Unattached` + + default: unattached + + - `CreatedAt Time` + + format: date-time + + - `DisplayName string` + + Human-friendly display name. Null if none was set. + + - `Geo string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig BetaExternalKeyProviderConfigUnion` + + KMS provider identity and auth coordinates. + + - `type BetaAWSExternalKeyConfig struct{…}` + + - `KMSARN string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `Type AWS` + + - `Region string Optional` + + AWS region. Derived from `kms_arn` if omitted. + + - `RoleARN string Optional` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `type BetaGCPExternalKeyConfig struct{…}` + + - `KeyName string` + + Full resource name of the Cloud KMS key. + + - `Type GCP` + + - `type BetaAzureExternalKeyConfig struct{…}` + + - `KeyName string` + + Name of the key within the vault. + + - `TenantID string` + + Azure AD tenant ID. + + - `Type Azure` + + - `VaultURI string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `ClientID string Optional` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `Type ExternalKey` + + default: external_key + + - `UpdatedAt Time` + + format: date-time + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaExternalKey, err := client.Beta.Organization.ExternalKeys.New(context.TODO(), anthropic.BetaOrganizationExternalKeyNewParams{ + ProviderConfig: anthropic.BetaOrganizationExternalKeyNewParamsProviderConfigUnion{ + OfAWS: &anthropic.BetaAWSExternalKeyConfigParam{ + KMSARN: "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + }, + }, + }) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaExternalKey.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +`client.Beta.Organization.ExternalKeys.List(ctx, query) (*PageCursor[BetaExternalKey], error)` + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Parameters + +- `query BetaOrganizationExternalKeyListParams` + + - `Limit param.Field[int64] Optional` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `Page param.Field[string] Optional` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `type BetaExternalKey struct{…}` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `ID string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment BetaExternalKeyAttachmentUnion` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `type BetaExternalKeyAttachedAttachment struct{…}` + + - `Type Attached` + + default: attached + + - `type BetaExternalKeyUnattachedAttachment struct{…}` + + - `Type Unattached` + + default: unattached + + - `CreatedAt Time` + + format: date-time + + - `DisplayName string` + + Human-friendly display name. Null if none was set. + + - `Geo string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig BetaExternalKeyProviderConfigUnion` + + KMS provider identity and auth coordinates. + + - `type BetaAWSExternalKeyConfig struct{…}` + + - `KMSARN string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `Type AWS` + + - `Region string Optional` + + AWS region. Derived from `kms_arn` if omitted. + + - `RoleARN string Optional` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `type BetaGCPExternalKeyConfig struct{…}` + + - `KeyName string` + + Full resource name of the Cloud KMS key. + + - `Type GCP` + + - `type BetaAzureExternalKeyConfig struct{…}` + + - `KeyName string` + + Name of the key within the vault. + + - `TenantID string` + + Azure AD tenant ID. + + - `Type Azure` + + - `VaultURI string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `ClientID string Optional` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `Type ExternalKey` + + default: external_key + + - `UpdatedAt Time` + + format: date-time + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.ExternalKeys.List(context.TODO(), anthropic.BetaOrganizationExternalKeyListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +`client.Beta.Organization.ExternalKeys.Get(ctx, externalKeyID) (*BetaExternalKey, error)` + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Parameters + +- `externalKeyID string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `type BetaExternalKey struct{…}` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `ID string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment BetaExternalKeyAttachmentUnion` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `type BetaExternalKeyAttachedAttachment struct{…}` + + - `Type Attached` + + default: attached + + - `type BetaExternalKeyUnattachedAttachment struct{…}` + + - `Type Unattached` + + default: unattached + + - `CreatedAt Time` + + format: date-time + + - `DisplayName string` + + Human-friendly display name. Null if none was set. + + - `Geo string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig BetaExternalKeyProviderConfigUnion` + + KMS provider identity and auth coordinates. + + - `type BetaAWSExternalKeyConfig struct{…}` + + - `KMSARN string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `Type AWS` + + - `Region string Optional` + + AWS region. Derived from `kms_arn` if omitted. + + - `RoleARN string Optional` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `type BetaGCPExternalKeyConfig struct{…}` + + - `KeyName string` + + Full resource name of the Cloud KMS key. + + - `Type GCP` + + - `type BetaAzureExternalKeyConfig struct{…}` + + - `KeyName string` + + Name of the key within the vault. + + - `TenantID string` + + Azure AD tenant ID. + + - `Type Azure` + + - `VaultURI string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `ClientID string Optional` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `Type ExternalKey` + + default: external_key + + - `UpdatedAt Time` + + format: date-time + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaExternalKey, err := client.Beta.Organization.ExternalKeys.Get(context.TODO(), "external_key_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaExternalKey.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +`client.Beta.Organization.ExternalKeys.Update(ctx, externalKeyID, body) (*BetaExternalKey, error)` + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Parameters + +- `externalKeyID string` + + ID of the External Key. + + maxLength: 2048 + +- `body BetaOrganizationExternalKeyUpdateParams` + + - `DisplayName param.Field[string] Optional` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + + - `Geo param.Field[BetaOrganizationExternalKeyUpdateParamsGeo] Optional` + + Data residency geo. Only `us` is supported. + + - `const BetaOrganizationExternalKeyUpdateParamsGeoUs BetaOrganizationExternalKeyUpdateParamsGeo = "us"` + + - `ProviderConfig param.Field[BetaOrganizationExternalKeyUpdateParamsProviderConfigUnion] Optional` + + KMS provider identity and auth coordinates. + + - `type BetaAWSExternalKeyConfig struct{…}` + + - `KMSARN string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `Type AWS` + + - `Region string Optional` + + AWS region. Derived from `kms_arn` if omitted. + + - `RoleARN string Optional` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `type BetaGCPExternalKeyConfig struct{…}` + + - `KeyName string` + + Full resource name of the Cloud KMS key. + + - `Type GCP` + + - `type BetaAzureExternalKeyConfigParamResp struct{…}` + + Azure Key Vault provider configuration. + + - `KeyName string` + + Name of the key within the vault. + + - `TenantID string` + + Azure AD tenant ID. + + - `Type Azure` + + - `VaultURI string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `ClientID string Optional` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +#### Returns + +- `type BetaExternalKey struct{…}` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `ID string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment BetaExternalKeyAttachmentUnion` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `type BetaExternalKeyAttachedAttachment struct{…}` + + - `Type Attached` + + default: attached + + - `type BetaExternalKeyUnattachedAttachment struct{…}` + + - `Type Unattached` + + default: unattached + + - `CreatedAt Time` + + format: date-time + + - `DisplayName string` + + Human-friendly display name. Null if none was set. + + - `Geo string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig BetaExternalKeyProviderConfigUnion` + + KMS provider identity and auth coordinates. + + - `type BetaAWSExternalKeyConfig struct{…}` + + - `KMSARN string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `Type AWS` + + - `Region string Optional` + + AWS region. Derived from `kms_arn` if omitted. + + - `RoleARN string Optional` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `type BetaGCPExternalKeyConfig struct{…}` + + - `KeyName string` + + Full resource name of the Cloud KMS key. + + - `Type GCP` + + - `type BetaAzureExternalKeyConfig struct{…}` + + - `KeyName string` + + Name of the key within the vault. + + - `TenantID string` + + Azure AD tenant ID. + + - `Type Azure` + + - `VaultURI string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `ClientID string Optional` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `Type ExternalKey` + + default: external_key + + - `UpdatedAt Time` + + format: date-time + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaExternalKey, err := client.Beta.Organization.ExternalKeys.Update( + context.TODO(), + "external_key_id", + anthropic.BetaOrganizationExternalKeyUpdateParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaExternalKey.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +`client.Beta.Organization.ExternalKeys.Delete(ctx, externalKeyID) (*BetaOrganizationExternalKeyDeleteResponse, error)` + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Parameters + +- `externalKeyID string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `type BetaOrganizationExternalKeyDeleteResponse struct{…}` + + - `ID string` + + ID of the deleted External Key. + + - `Type ExternalKeyDeleted` + + default: external_key_deleted + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + externalKey, err := client.Beta.Organization.ExternalKeys.Delete(context.TODO(), "external_key_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", externalKey.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +`client.Beta.Organization.ExternalKeys.Validate(ctx, externalKeyID) (*BetaOrganizationExternalKeyValidateResponse, error)` + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Parameters + +- `externalKeyID string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `type BetaOrganizationExternalKeyValidateResponse struct{…}` + + Result of a validation roundtrip against the customer's KMS. + + HTTP 200 for both outcomes — the operation completed; `status` says + whether the key works. + + - `Error string` + + Error message when status is `failure`. Null otherwise. + + - `Status BetaOrganizationExternalKeyValidateResponseStatus` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `const BetaOrganizationExternalKeyValidateResponseStatusFailure BetaOrganizationExternalKeyValidateResponseStatus = "failure"` + + - `const BetaOrganizationExternalKeyValidateResponseStatusSuccess BetaOrganizationExternalKeyValidateResponseStatus = "success"` + + - `Type ExternalKeyValidation` + + default: external_key_validation + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + response, err := client.Beta.Organization.ExternalKeys.Validate(context.TODO(), "external_key_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", response.Error) +} +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +`client.Beta.Organization.Federation.Issuers.New(ctx, params) (*BetaFederationIssuer, error)` + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Parameters + +- `params BetaOrganizationFederationIssuerNewParams` + + - `IssuerURL param.Field[string]` + + Body param: The `iss` claim value to match against. + + minLength: 1 + + - `Name param.Field[string]` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `CheckJTI param.Field[bool] Optional` + + Body param: Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `JWKS param.Field[BetaOrganizationFederationIssuerNewParamsJWKSUnion] Optional` + + Body param: How signing keys are obtained. Defaults to OIDC discovery. + + - `type BetaJWKSDiscovery struct{…}` + + JWKS via the issuer's OIDC discovery document. + + - `Type Discovery` + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `DiscoveryBase string Optional` + + Set when the discovery URL differs from `issuer_url`. + + - `type BetaJWKSExplicitURL struct{…}` + + JWKS fetched from a fixed endpoint. + + - `Type ExplicitURL` + + - `URL string` + + JWKS endpoint. + + minLength: 1 + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `type BetaJWKSInline struct{…}` + + JWKS supplied directly; no network fetch. + + - `Keys []map[string, any]` + + Inline JWK objects. + + minItems: 1 + + - `Type Inline` + + - `MaxJWTLifetimeSeconds param.Field[int64] Optional` + + Body param: Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationIssuer struct{…}` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `ID string` + + Tagged ID of the federation issuer. + + - `ArchivedAt Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `CheckJTI bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `CreatedAt Time` + + When this issuer was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `IssuerURL string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS BetaFederationIssuerJWKSUnion` + + How signing keys are obtained for signature verification. + + - `type BetaJWKSDiscovery struct{…}` + + JWKS via the issuer's OIDC discovery document. + + - `Type Discovery` + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `DiscoveryBase string Optional` + + Set when the discovery URL differs from `issuer_url`. + + - `type BetaJWKSExplicitURL struct{…}` + + JWKS fetched from a fixed endpoint. + + - `Type ExplicitURL` + + - `URL string` + + JWKS endpoint. + + minLength: 1 + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `type BetaJWKSInline struct{…}` + + JWKS supplied directly; no network fetch. + + - `Keys []map[string, any]` + + Inline JWK objects. + + minItems: 1 + + - `Type Inline` + + - `JWKSPollingDisabledAt Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `MaxJWTLifetimeSeconds int64` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `Name string` + + Admin-chosen slug identifier. + + - `PollStatus BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `ConsecutiveFailures int64` + + Consecutive fetch failures since the last success. + + - `LastFetchedAt Time` + + When the last successful fetch completed. + + format: date-time + + - `NextPollAt Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `Type FederationIssuer` + + default: federation_issuer + + - `UpdatedAt Time` + + When this issuer was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationIssuer, err := client.Beta.Organization.Federation.Issuers.New(context.TODO(), anthropic.BetaOrganizationFederationIssuerNewParams{ + IssuerURL: "x", + Name: "x", + }) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationIssuer.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +`client.Beta.Organization.Federation.Issuers.List(ctx, params) (*PageCursor[BetaFederationIssuer], error)` + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Parameters + +- `params BetaOrganizationFederationIssuerListParams` + + - `IncludeArchived param.Field[bool] Optional` + + Query param: Include archived resources. Defaults to false. + + - `Limit param.Field[int64] Optional` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `Page param.Field[string] Optional` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationIssuer struct{…}` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `ID string` + + Tagged ID of the federation issuer. + + - `ArchivedAt Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `CheckJTI bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `CreatedAt Time` + + When this issuer was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `IssuerURL string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS BetaFederationIssuerJWKSUnion` + + How signing keys are obtained for signature verification. + + - `type BetaJWKSDiscovery struct{…}` + + JWKS via the issuer's OIDC discovery document. + + - `Type Discovery` + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `DiscoveryBase string Optional` + + Set when the discovery URL differs from `issuer_url`. + + - `type BetaJWKSExplicitURL struct{…}` + + JWKS fetched from a fixed endpoint. + + - `Type ExplicitURL` + + - `URL string` + + JWKS endpoint. + + minLength: 1 + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `type BetaJWKSInline struct{…}` + + JWKS supplied directly; no network fetch. + + - `Keys []map[string, any]` + + Inline JWK objects. + + minItems: 1 + + - `Type Inline` + + - `JWKSPollingDisabledAt Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `MaxJWTLifetimeSeconds int64` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `Name string` + + Admin-chosen slug identifier. + + - `PollStatus BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `ConsecutiveFailures int64` + + Consecutive fetch failures since the last success. + + - `LastFetchedAt Time` + + When the last successful fetch completed. + + format: date-time + + - `NextPollAt Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `Type FederationIssuer` + + default: federation_issuer + + - `UpdatedAt Time` + + When this issuer was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Federation.Issuers.List(context.TODO(), anthropic.BetaOrganizationFederationIssuerListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +`client.Beta.Organization.Federation.Issuers.Get(ctx, federationIssuerID, query) (*BetaFederationIssuer, error)` + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Parameters + +- `federationIssuerID string` + + ID of the federation issuer. + +- `query BetaOrganizationFederationIssuerGetParams` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationIssuer struct{…}` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `ID string` + + Tagged ID of the federation issuer. + + - `ArchivedAt Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `CheckJTI bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `CreatedAt Time` + + When this issuer was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `IssuerURL string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS BetaFederationIssuerJWKSUnion` + + How signing keys are obtained for signature verification. + + - `type BetaJWKSDiscovery struct{…}` + + JWKS via the issuer's OIDC discovery document. + + - `Type Discovery` + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `DiscoveryBase string Optional` + + Set when the discovery URL differs from `issuer_url`. + + - `type BetaJWKSExplicitURL struct{…}` + + JWKS fetched from a fixed endpoint. + + - `Type ExplicitURL` + + - `URL string` + + JWKS endpoint. + + minLength: 1 + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `type BetaJWKSInline struct{…}` + + JWKS supplied directly; no network fetch. + + - `Keys []map[string, any]` + + Inline JWK objects. + + minItems: 1 + + - `Type Inline` + + - `JWKSPollingDisabledAt Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `MaxJWTLifetimeSeconds int64` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `Name string` + + Admin-chosen slug identifier. + + - `PollStatus BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `ConsecutiveFailures int64` + + Consecutive fetch failures since the last success. + + - `LastFetchedAt Time` + + When the last successful fetch completed. + + format: date-time + + - `NextPollAt Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `Type FederationIssuer` + + default: federation_issuer + + - `UpdatedAt Time` + + When this issuer was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationIssuer, err := client.Beta.Organization.Federation.Issuers.Get( + context.TODO(), + "federation_issuer_id", + anthropic.BetaOrganizationFederationIssuerGetParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationIssuer.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +`client.Beta.Organization.Federation.Issuers.Update(ctx, federationIssuerID, params) (*BetaFederationIssuer, error)` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Parameters + +- `federationIssuerID string` + + ID of the federation issuer to update. + +- `params BetaOrganizationFederationIssuerUpdateParams` + + - `CheckJTI param.Field[bool] Optional` + + Body param: Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `IssuerURL param.Field[string] Optional` + + Body param: Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + + - `JWKS param.Field[BetaOrganizationFederationIssuerUpdateParamsJWKSUnion] Optional` + + Body param: Replaces the entire JWKS configuration. + + - `type BetaJWKSDiscovery struct{…}` + + JWKS via the issuer's OIDC discovery document. + + - `Type Discovery` + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `DiscoveryBase string Optional` + + Set when the discovery URL differs from `issuer_url`. + + - `type BetaJWKSExplicitURL struct{…}` + + JWKS fetched from a fixed endpoint. + + - `Type ExplicitURL` + + - `URL string` + + JWKS endpoint. + + minLength: 1 + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `type BetaJWKSInline struct{…}` + + JWKS supplied directly; no network fetch. + + - `Keys []map[string, any]` + + Inline JWK objects. + + minItems: 1 + + - `Type Inline` + + - `JWKSPollingDisabled param.Field[bool] Optional` + + Body param: Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + + - `MaxJWTLifetimeSeconds param.Field[int64] Optional` + + Body param: Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + + - `Name param.Field[string] Optional` + + Body param: Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationIssuer struct{…}` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `ID string` + + Tagged ID of the federation issuer. + + - `ArchivedAt Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `CheckJTI bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `CreatedAt Time` + + When this issuer was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `IssuerURL string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS BetaFederationIssuerJWKSUnion` + + How signing keys are obtained for signature verification. + + - `type BetaJWKSDiscovery struct{…}` + + JWKS via the issuer's OIDC discovery document. + + - `Type Discovery` + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `DiscoveryBase string Optional` + + Set when the discovery URL differs from `issuer_url`. + + - `type BetaJWKSExplicitURL struct{…}` + + JWKS fetched from a fixed endpoint. + + - `Type ExplicitURL` + + - `URL string` + + JWKS endpoint. + + minLength: 1 + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `type BetaJWKSInline struct{…}` + + JWKS supplied directly; no network fetch. + + - `Keys []map[string, any]` + + Inline JWK objects. + + minItems: 1 + + - `Type Inline` + + - `JWKSPollingDisabledAt Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `MaxJWTLifetimeSeconds int64` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `Name string` + + Admin-chosen slug identifier. + + - `PollStatus BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `ConsecutiveFailures int64` + + Consecutive fetch failures since the last success. + + - `LastFetchedAt Time` + + When the last successful fetch completed. + + format: date-time + + - `NextPollAt Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `Type FederationIssuer` + + default: federation_issuer + + - `UpdatedAt Time` + + When this issuer was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationIssuer, err := client.Beta.Organization.Federation.Issuers.Update( + context.TODO(), + "federation_issuer_id", + anthropic.BetaOrganizationFederationIssuerUpdateParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationIssuer.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +`client.Beta.Organization.Federation.Issuers.Archive(ctx, federationIssuerID, body) (*BetaFederationIssuer, error)` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Parameters + +- `federationIssuerID string` + + ID of the federation issuer to archive. + +- `body BetaOrganizationFederationIssuerArchiveParams` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationIssuer struct{…}` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `ID string` + + Tagged ID of the federation issuer. + + - `ArchivedAt Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `CheckJTI bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `CreatedAt Time` + + When this issuer was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `IssuerURL string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS BetaFederationIssuerJWKSUnion` + + How signing keys are obtained for signature verification. + + - `type BetaJWKSDiscovery struct{…}` + + JWKS via the issuer's OIDC discovery document. + + - `Type Discovery` + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `DiscoveryBase string Optional` + + Set when the discovery URL differs from `issuer_url`. + + - `type BetaJWKSExplicitURL struct{…}` + + JWKS fetched from a fixed endpoint. + + - `Type ExplicitURL` + + - `URL string` + + JWKS endpoint. + + minLength: 1 + + - `CACertPEM string Optional` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `type BetaJWKSInline struct{…}` + + JWKS supplied directly; no network fetch. + + - `Keys []map[string, any]` + + Inline JWK objects. + + minItems: 1 + + - `Type Inline` + + - `JWKSPollingDisabledAt Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `MaxJWTLifetimeSeconds int64` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `Name string` + + Admin-chosen slug identifier. + + - `PollStatus BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `ConsecutiveFailures int64` + + Consecutive fetch failures since the last success. + + - `LastFetchedAt Time` + + When the last successful fetch completed. + + format: date-time + + - `NextPollAt Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `Type FederationIssuer` + + default: federation_issuer + + - `UpdatedAt Time` + + When this issuer was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationIssuer, err := client.Beta.Organization.Federation.Issuers.Archive( + context.TODO(), + "federation_issuer_id", + anthropic.BetaOrganizationFederationIssuerArchiveParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationIssuer.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +`client.Beta.Organization.Federation.Rules.New(ctx, params) (*BetaFederationRule, error)` + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Parameters + +- `params BetaOrganizationFederationRuleNewParams` + + - `IssuerID param.Field[string]` + + Body param: Tagged ID of the federation issuer. + + - `Match param.Field[BetaFederationRuleMatch]` + + Body param: Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `Name param.Field[string]` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `OAuthScope param.Field[string]` + + Body param: Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + + - `Target param.Field[BetaServiceAccountTarget]` + + Body param: Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `AppliesToAllWorkspaces param.Field[bool] Optional` + + Body param: When true, enable this rule for every workspace in the org (including workspaces created later). + + - `Attributes param.Field[map[string, string]] Optional` + + Body param: CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + + - `Description param.Field[string] Optional` + + Body param: Optional free-text description. + + maxLength: 2000 + + - `TokenLifetimeSeconds param.Field[int64] Optional` + + Body param: Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + + - `WorkspaceID param.Field[string] Optional` + + Body param: Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationRule struct{…}` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `ID string` + + Tagged ID of the federation rule. + + - `AppliesToAllWorkspaces bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `ArchivedAt Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Attributes map[string, string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `CreatedAt Time` + + When this rule was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Description string` + + Optional free-text description. + + - `IssuerID string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `IssuerName string` + + Issuer's display name at read time. + + - `Match BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Audience string Optional` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Claims map[string, string] Optional` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Condition string Optional` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `SubjectPrefix string Optional` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `Name string` + + Admin-chosen slug identifier. + + - `OAuthScope string` + + Space-separated OAuth scopes granted on the minted token. + + - `Target BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `ServiceAccountID string` + + Tagged ID of the service account to mint tokens for. + + - `Type ServiceAccount` + + - `ServiceAccountName string Optional` + + Service account's display name at read time. Ignored on writes. + + - `TokenLifetimeSeconds int64` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `Type FederationRule` + + default: federation_rule + + - `UpdatedAt Time` + + When this rule was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `WorkspaceID string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `WorkspaceIDs []string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationRule, err := client.Beta.Organization.Federation.Rules.New(context.TODO(), anthropic.BetaOrganizationFederationRuleNewParams{ + IssuerID: "issuer_id", + Match: anthropic.BetaFederationRuleMatchParam{}, + Name: "x", + OAuthScope: "x", + Target: anthropic.BetaServiceAccountTargetParam{ + ServiceAccountID: "svac_01SDCCSbTxrXDpWc1phhtcfK", + }, + }) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationRule.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +`client.Beta.Organization.Federation.Rules.List(ctx, params) (*PageCursor[BetaFederationRule], error)` + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Parameters + +- `params BetaOrganizationFederationRuleListParams` + + - `IncludeArchived param.Field[bool] Optional` + + Query param: Include archived resources. Defaults to false. + + - `IssuerID param.Field[string] Optional` + + Query param: Filter to rules referencing this federation issuer. + + - `Limit param.Field[int64] Optional` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `Page param.Field[string] Optional` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationRule struct{…}` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `ID string` + + Tagged ID of the federation rule. + + - `AppliesToAllWorkspaces bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `ArchivedAt Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Attributes map[string, string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `CreatedAt Time` + + When this rule was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Description string` + + Optional free-text description. + + - `IssuerID string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `IssuerName string` + + Issuer's display name at read time. + + - `Match BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Audience string Optional` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Claims map[string, string] Optional` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Condition string Optional` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `SubjectPrefix string Optional` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `Name string` + + Admin-chosen slug identifier. + + - `OAuthScope string` + + Space-separated OAuth scopes granted on the minted token. + + - `Target BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `ServiceAccountID string` + + Tagged ID of the service account to mint tokens for. + + - `Type ServiceAccount` + + - `ServiceAccountName string Optional` + + Service account's display name at read time. Ignored on writes. + + - `TokenLifetimeSeconds int64` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `Type FederationRule` + + default: federation_rule + + - `UpdatedAt Time` + + When this rule was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `WorkspaceID string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `WorkspaceIDs []string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Federation.Rules.List(context.TODO(), anthropic.BetaOrganizationFederationRuleListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +`client.Beta.Organization.Federation.Rules.Get(ctx, federationRuleID, query) (*BetaFederationRule, error)` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Parameters + +- `federationRuleID string` + + ID of the federation rule. + +- `query BetaOrganizationFederationRuleGetParams` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationRule struct{…}` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `ID string` + + Tagged ID of the federation rule. + + - `AppliesToAllWorkspaces bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `ArchivedAt Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Attributes map[string, string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `CreatedAt Time` + + When this rule was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Description string` + + Optional free-text description. + + - `IssuerID string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `IssuerName string` + + Issuer's display name at read time. + + - `Match BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Audience string Optional` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Claims map[string, string] Optional` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Condition string Optional` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `SubjectPrefix string Optional` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `Name string` + + Admin-chosen slug identifier. + + - `OAuthScope string` + + Space-separated OAuth scopes granted on the minted token. + + - `Target BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `ServiceAccountID string` + + Tagged ID of the service account to mint tokens for. + + - `Type ServiceAccount` + + - `ServiceAccountName string Optional` + + Service account's display name at read time. Ignored on writes. + + - `TokenLifetimeSeconds int64` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `Type FederationRule` + + default: federation_rule + + - `UpdatedAt Time` + + When this rule was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `WorkspaceID string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `WorkspaceIDs []string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationRule, err := client.Beta.Organization.Federation.Rules.Get( + context.TODO(), + "federation_rule_id", + anthropic.BetaOrganizationFederationRuleGetParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationRule.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +`client.Beta.Organization.Federation.Rules.Update(ctx, federationRuleID, params) (*BetaFederationRule, error)` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `federationRuleID string` + + ID of the federation rule to update. + +- `params BetaOrganizationFederationRuleUpdateParams` + + - `AppliesToAllWorkspaces param.Field[bool] Optional` + + Body param: When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + + - `Attributes param.Field[map[string, string]] Optional` + + Body param: Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + + - `Description param.Field[string] Optional` + + Body param: Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + + - `Match param.Field[BetaFederationRuleMatch] Optional` + + Body param: Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `Name param.Field[string] Optional` + + Body param: Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `OAuthScope param.Field[string] Optional` + + Body param: Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + + - `Target param.Field[BetaServiceAccountTarget] Optional` + + Body param: Bind to a fixed service account by ID. + + - `TokenLifetimeSeconds param.Field[int64] Optional` + + Body param: Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + + - `WorkspaceID param.Field[string] Optional` + + Body param: Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationRule struct{…}` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `ID string` + + Tagged ID of the federation rule. + + - `AppliesToAllWorkspaces bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `ArchivedAt Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Attributes map[string, string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `CreatedAt Time` + + When this rule was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Description string` + + Optional free-text description. + + - `IssuerID string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `IssuerName string` + + Issuer's display name at read time. + + - `Match BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Audience string Optional` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Claims map[string, string] Optional` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Condition string Optional` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `SubjectPrefix string Optional` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `Name string` + + Admin-chosen slug identifier. + + - `OAuthScope string` + + Space-separated OAuth scopes granted on the minted token. + + - `Target BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `ServiceAccountID string` + + Tagged ID of the service account to mint tokens for. + + - `Type ServiceAccount` + + - `ServiceAccountName string Optional` + + Service account's display name at read time. Ignored on writes. + + - `TokenLifetimeSeconds int64` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `Type FederationRule` + + default: federation_rule + + - `UpdatedAt Time` + + When this rule was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `WorkspaceID string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `WorkspaceIDs []string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationRule, err := client.Beta.Organization.Federation.Rules.Update( + context.TODO(), + "federation_rule_id", + anthropic.BetaOrganizationFederationRuleUpdateParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationRule.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +`client.Beta.Organization.Federation.Rules.Archive(ctx, federationRuleID, body) (*BetaFederationRule, error)` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federationRuleID string` + + ID of the federation rule to archive. + +- `body BetaOrganizationFederationRuleArchiveParams` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationRule struct{…}` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `ID string` + + Tagged ID of the federation rule. + + - `AppliesToAllWorkspaces bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `ArchivedAt Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Attributes map[string, string]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `CreatedAt Time` + + When this rule was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Description string` + + Optional free-text description. + + - `IssuerID string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `IssuerName string` + + Issuer's display name at read time. + + - `Match BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Audience string Optional` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Claims map[string, string] Optional` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Condition string Optional` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `SubjectPrefix string Optional` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `Name string` + + Admin-chosen slug identifier. + + - `OAuthScope string` + + Space-separated OAuth scopes granted on the minted token. + + - `Target BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `ServiceAccountID string` + + Tagged ID of the service account to mint tokens for. + + - `Type ServiceAccount` + + - `ServiceAccountName string Optional` + + Service account's display name at read time. Ignored on writes. + + - `TokenLifetimeSeconds int64` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `Type FederationRule` + + default: federation_rule + + - `UpdatedAt Time` + + When this rule was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `WorkspaceID string` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `WorkspaceIDs []string` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationRule, err := client.Beta.Organization.Federation.Rules.Archive( + context.TODO(), + "federation_rule_id", + anthropic.BetaOrganizationFederationRuleArchiveParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationRule.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +`client.Beta.Organization.Federation.Rules.Workspaces.Add(ctx, federationRuleID, params) (*BetaFederationRuleWorkspace, error)` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federationRuleID string` + + ID of the federation rule. + +- `params BetaOrganizationFederationRuleWorkspaceAddParams` + + - `WorkspaceID param.Field[string]` + + Body param: Tagged ID of the workspace to enable this rule for. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationRuleWorkspace struct{…}` + + - `CreatedAt Time` + + When this workspace was enabled for the rule. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `FederationRuleID string` + + Tagged ID of the federation rule. + + - `Type FederationRuleWorkspace` + + default: federation_rule_workspace + + - `WorkspaceID string` + + Tagged ID of the workspace this rule is enabled for. + + - `WorkspaceName string` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaFederationRuleWorkspace, err := client.Beta.Organization.Federation.Rules.Workspaces.Add( + context.TODO(), + "federation_rule_id", + anthropic.BetaOrganizationFederationRuleWorkspaceAddParams{ + WorkspaceID: "workspace_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaFederationRuleWorkspace.CreatedByActorID) +} +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +`client.Beta.Organization.Federation.Rules.Workspaces.List(ctx, federationRuleID, params) (*PageCursor[BetaFederationRuleWorkspace], error)` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Parameters + +- `federationRuleID string` + + ID of the federation rule. + +- `params BetaOrganizationFederationRuleWorkspaceListParams` + + - `Limit param.Field[int64] Optional` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `Page param.Field[string] Optional` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaFederationRuleWorkspace struct{…}` + + - `CreatedAt Time` + + When this workspace was enabled for the rule. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `FederationRuleID string` + + Tagged ID of the federation rule. + + - `Type FederationRuleWorkspace` + + default: federation_rule_workspace + + - `WorkspaceID string` + + Tagged ID of the workspace this rule is enabled for. + + - `WorkspaceName string` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Federation.Rules.Workspaces.List( + context.TODO(), + "federation_rule_id", + anthropic.BetaOrganizationFederationRuleWorkspaceListParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +`client.Beta.Organization.Federation.Rules.Workspaces.Remove(ctx, workspaceID, params) (*BetaOrganizationFederationRuleWorkspaceRemoveResponse, error)` + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `workspaceID string` + + ID of the workspace to disable for. + +- `params BetaOrganizationFederationRuleWorkspaceRemoveParams` + + - `FederationRuleID param.Field[string]` + + Path param: ID of the federation rule. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaOrganizationFederationRuleWorkspaceRemoveResponse struct{…}` + + - `FederationRuleID string` + + Tagged ID of the federation rule. + + - `Type FederationRuleWorkspaceDeleted` + + default: federation_rule_workspace_deleted + + - `WorkspaceID string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + workspace, err := client.Beta.Organization.Federation.Rules.Workspaces.Remove( + context.TODO(), + "workspace_id", + anthropic.BetaOrganizationFederationRuleWorkspaceRemoveParams{ + FederationRuleID: "federation_rule_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", workspace.FederationRuleID) +} +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +`client.Beta.Organization.Invites.New(ctx, body) (*BetaOrganizationInvite, error)` + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Parameters + +- `body BetaOrganizationInviteNewParams` + + - `Email param.Field[string]` + + Email of the User. + + format: email + + - `Role param.Field[BetaOrganizationInviteNewParamsRole]` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `const BetaOrganizationInviteNewParamsRoleBilling BetaOrganizationInviteNewParamsRole = "billing"` + + - `const BetaOrganizationInviteNewParamsRoleClaudeCodeUser BetaOrganizationInviteNewParamsRole = "claude_code_user"` + + - `const BetaOrganizationInviteNewParamsRoleDeveloper BetaOrganizationInviteNewParamsRole = "developer"` + + - `const BetaOrganizationInviteNewParamsRoleManaged BetaOrganizationInviteNewParamsRole = "managed"` + + - `const BetaOrganizationInviteNewParamsRoleUser BetaOrganizationInviteNewParamsRole = "user"` + + - `RBACGroupIDs param.Field[[]string] Optional` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `type BetaOrganizationInvite struct{…}` + + - `ID string` + + ID of the Invite. + + - `AcceptedAt Time` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `Email string` + + Email of the User being invited. + + - `ExpiresAt Time` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `InvitedAt Time` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `RBACGroupIDs []string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `Role BetaOrganizationRole` + + Organization role of the User. + + - `const BetaOrganizationRoleAdmin BetaOrganizationRole = "admin"` + + - `const BetaOrganizationRoleBilling BetaOrganizationRole = "billing"` + + - `const BetaOrganizationRoleClaudeCodeUser BetaOrganizationRole = "claude_code_user"` + + - `const BetaOrganizationRoleDeveloper BetaOrganizationRole = "developer"` + + - `const BetaOrganizationRoleManaged BetaOrganizationRole = "managed"` + + - `const BetaOrganizationRoleMembershipAdmin BetaOrganizationRole = "membership_admin"` + + - `const BetaOrganizationRoleOwner BetaOrganizationRole = "owner"` + + - `const BetaOrganizationRolePrimaryOwner BetaOrganizationRole = "primary_owner"` + + - `const BetaOrganizationRoleUser BetaOrganizationRole = "user"` + + - `Status BetaOrganizationInviteStatus` + + Status of the Invite. + + - `const BetaOrganizationInviteStatusAccepted BetaOrganizationInviteStatus = "accepted"` + + - `const BetaOrganizationInviteStatusDeleted BetaOrganizationInviteStatus = "deleted"` + + - `const BetaOrganizationInviteStatusExpired BetaOrganizationInviteStatus = "expired"` + + - `const BetaOrganizationInviteStatusPending BetaOrganizationInviteStatus = "pending"` + + - `Type Invite` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaOrganizationInvite, err := client.Beta.Organization.Invites.New(context.TODO(), anthropic.BetaOrganizationInviteNewParams{ + Email: "user@emaildomain.com", + Role: anthropic.BetaOrganizationInviteNewParamsRoleUser, + }) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaOrganizationInvite.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +`client.Beta.Organization.Invites.List(ctx, query) (*Page[BetaOrganizationInvite], error)` + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Parameters + +- `query BetaOrganizationInviteListParams` + + - `AfterID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `BeforeID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `Email param.Field[string] Optional` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + + - `Limit param.Field[int64] Optional` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `Roles param.Field[[]string] Optional` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + + - `Statuses param.Field[[]string] Optional` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `const BetaOrganizationInviteListParamsStatusAccepted BetaOrganizationInviteListParamsStatus = "accepted"` + + - `const BetaOrganizationInviteListParamsStatusExpired BetaOrganizationInviteListParamsStatus = "expired"` + + - `const BetaOrganizationInviteListParamsStatusPending BetaOrganizationInviteListParamsStatus = "pending"` + +#### Returns + +- `type BetaOrganizationInvite struct{…}` + + - `ID string` + + ID of the Invite. + + - `AcceptedAt Time` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `Email string` + + Email of the User being invited. + + - `ExpiresAt Time` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `InvitedAt Time` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `RBACGroupIDs []string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `Role BetaOrganizationRole` + + Organization role of the User. + + - `const BetaOrganizationRoleAdmin BetaOrganizationRole = "admin"` + + - `const BetaOrganizationRoleBilling BetaOrganizationRole = "billing"` + + - `const BetaOrganizationRoleClaudeCodeUser BetaOrganizationRole = "claude_code_user"` + + - `const BetaOrganizationRoleDeveloper BetaOrganizationRole = "developer"` + + - `const BetaOrganizationRoleManaged BetaOrganizationRole = "managed"` + + - `const BetaOrganizationRoleMembershipAdmin BetaOrganizationRole = "membership_admin"` + + - `const BetaOrganizationRoleOwner BetaOrganizationRole = "owner"` + + - `const BetaOrganizationRolePrimaryOwner BetaOrganizationRole = "primary_owner"` + + - `const BetaOrganizationRoleUser BetaOrganizationRole = "user"` + + - `Status BetaOrganizationInviteStatus` + + Status of the Invite. + + - `const BetaOrganizationInviteStatusAccepted BetaOrganizationInviteStatus = "accepted"` + + - `const BetaOrganizationInviteStatusDeleted BetaOrganizationInviteStatus = "deleted"` + + - `const BetaOrganizationInviteStatusExpired BetaOrganizationInviteStatus = "expired"` + + - `const BetaOrganizationInviteStatusPending BetaOrganizationInviteStatus = "pending"` + + - `Type Invite` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Invites.List(context.TODO(), anthropic.BetaOrganizationInviteListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +`client.Beta.Organization.Invites.Get(ctx, inviteID) (*BetaOrganizationInvite, error)` + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Parameters + +- `inviteID string` + + ID of the Invite. + +#### Returns + +- `type BetaOrganizationInvite struct{…}` + + - `ID string` + + ID of the Invite. + + - `AcceptedAt Time` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `Email string` + + Email of the User being invited. + + - `ExpiresAt Time` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `InvitedAt Time` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `RBACGroupIDs []string` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `Role BetaOrganizationRole` + + Organization role of the User. + + - `const BetaOrganizationRoleAdmin BetaOrganizationRole = "admin"` + + - `const BetaOrganizationRoleBilling BetaOrganizationRole = "billing"` + + - `const BetaOrganizationRoleClaudeCodeUser BetaOrganizationRole = "claude_code_user"` + + - `const BetaOrganizationRoleDeveloper BetaOrganizationRole = "developer"` + + - `const BetaOrganizationRoleManaged BetaOrganizationRole = "managed"` + + - `const BetaOrganizationRoleMembershipAdmin BetaOrganizationRole = "membership_admin"` + + - `const BetaOrganizationRoleOwner BetaOrganizationRole = "owner"` + + - `const BetaOrganizationRolePrimaryOwner BetaOrganizationRole = "primary_owner"` + + - `const BetaOrganizationRoleUser BetaOrganizationRole = "user"` + + - `Status BetaOrganizationInviteStatus` + + Status of the Invite. + + - `const BetaOrganizationInviteStatusAccepted BetaOrganizationInviteStatus = "accepted"` + + - `const BetaOrganizationInviteStatusDeleted BetaOrganizationInviteStatus = "deleted"` + + - `const BetaOrganizationInviteStatusExpired BetaOrganizationInviteStatus = "expired"` + + - `const BetaOrganizationInviteStatusPending BetaOrganizationInviteStatus = "pending"` + + - `Type Invite` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaOrganizationInvite, err := client.Beta.Organization.Invites.Get(context.TODO(), "invite_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaOrganizationInvite.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +`client.Beta.Organization.Invites.Delete(ctx, inviteID) (*BetaOrganizationInviteDeleteResponse, error)` + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Parameters + +- `inviteID string` + + ID of the Invite. + +#### Returns + +- `type BetaOrganizationInviteDeleteResponse struct{…}` + + - `ID string` + + ID of the Invite. + + - `Type InviteDeleted` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + + default: invite_deleted + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + invite, err := client.Beta.Organization.Invites.Delete(context.TODO(), "invite_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", invite.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +`client.Beta.Organization.ServiceAccounts.New(ctx, params) (*BetaServiceAccount, error)` + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Parameters + +- `params BetaOrganizationServiceAccountNewParams` + + - `Name param.Field[string]` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `Description param.Field[string] Optional` + + Body param: Optional free-text description. + + maxLength: 2000 + + - `OrganizationRole param.Field[BetaOrganizationServiceAccountNewParamsOrganizationRole] Optional` + + Body param: Org-level role. Defaults to `developer`. + + - `const BetaOrganizationServiceAccountNewParamsOrganizationRoleAdmin BetaOrganizationServiceAccountNewParamsOrganizationRole = "admin"` + + - `const BetaOrganizationServiceAccountNewParamsOrganizationRoleDeveloper BetaOrganizationServiceAccountNewParamsOrganizationRole = "developer"` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaServiceAccount struct{…}` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `ID string` + + Tagged ID of the service account. + + - `ArchivedAt Time` + + If set, this service account is archived. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `CreatedAt Time` + + When this service account was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Description string` + + Optional free-text description. + + - `Name string` + + Admin-chosen slug identifier. + + - `OrganizationRole BetaServiceAccountOrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `const BetaServiceAccountOrganizationRoleAdmin BetaServiceAccountOrganizationRole = "admin"` + + - `const BetaServiceAccountOrganizationRoleDeveloper BetaServiceAccountOrganizationRole = "developer"` + + - `Type ServiceAccount` + + default: service_account + + - `UpdatedAt Time` + + When this service account was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaServiceAccount, err := client.Beta.Organization.ServiceAccounts.New(context.TODO(), anthropic.BetaOrganizationServiceAccountNewParams{ + Name: "ci-deploy-bot", + }) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaServiceAccount.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +`client.Beta.Organization.ServiceAccounts.List(ctx, params) (*PageCursor[BetaServiceAccount], error)` + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Parameters + +- `params BetaOrganizationServiceAccountListParams` + + - `IncludeArchived param.Field[bool] Optional` + + Query param: Include archived resources. Defaults to false. + + - `Limit param.Field[int64] Optional` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `Page param.Field[string] Optional` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaServiceAccount struct{…}` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `ID string` + + Tagged ID of the service account. + + - `ArchivedAt Time` + + If set, this service account is archived. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `CreatedAt Time` + + When this service account was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Description string` + + Optional free-text description. + + - `Name string` + + Admin-chosen slug identifier. + + - `OrganizationRole BetaServiceAccountOrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `const BetaServiceAccountOrganizationRoleAdmin BetaServiceAccountOrganizationRole = "admin"` + + - `const BetaServiceAccountOrganizationRoleDeveloper BetaServiceAccountOrganizationRole = "developer"` + + - `Type ServiceAccount` + + default: service_account + + - `UpdatedAt Time` + + When this service account was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.ServiceAccounts.List(context.TODO(), anthropic.BetaOrganizationServiceAccountListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +`client.Beta.Organization.ServiceAccounts.Get(ctx, serviceAccountID, query) (*BetaServiceAccount, error)` + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Parameters + +- `serviceAccountID string` + + ID of the service account. + +- `query BetaOrganizationServiceAccountGetParams` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaServiceAccount struct{…}` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `ID string` + + Tagged ID of the service account. + + - `ArchivedAt Time` + + If set, this service account is archived. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `CreatedAt Time` + + When this service account was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Description string` + + Optional free-text description. + + - `Name string` + + Admin-chosen slug identifier. + + - `OrganizationRole BetaServiceAccountOrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `const BetaServiceAccountOrganizationRoleAdmin BetaServiceAccountOrganizationRole = "admin"` + + - `const BetaServiceAccountOrganizationRoleDeveloper BetaServiceAccountOrganizationRole = "developer"` + + - `Type ServiceAccount` + + default: service_account + + - `UpdatedAt Time` + + When this service account was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaServiceAccount, err := client.Beta.Organization.ServiceAccounts.Get( + context.TODO(), + "service_account_id", + anthropic.BetaOrganizationServiceAccountGetParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaServiceAccount.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +`client.Beta.Organization.ServiceAccounts.Update(ctx, serviceAccountID, params) (*BetaServiceAccount, error)` + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Parameters + +- `serviceAccountID string` + + ID of the service account to update. + +- `params BetaOrganizationServiceAccountUpdateParams` + + - `Description param.Field[string] Optional` + + Body param: Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + + - `OrganizationRole param.Field[BetaOrganizationServiceAccountUpdateParamsOrganizationRole] Optional` + + Body param: Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `const BetaOrganizationServiceAccountUpdateParamsOrganizationRoleAdmin BetaOrganizationServiceAccountUpdateParamsOrganizationRole = "admin"` + + - `const BetaOrganizationServiceAccountUpdateParamsOrganizationRoleDeveloper BetaOrganizationServiceAccountUpdateParamsOrganizationRole = "developer"` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaServiceAccount struct{…}` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `ID string` + + Tagged ID of the service account. + + - `ArchivedAt Time` + + If set, this service account is archived. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `CreatedAt Time` + + When this service account was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Description string` + + Optional free-text description. + + - `Name string` + + Admin-chosen slug identifier. + + - `OrganizationRole BetaServiceAccountOrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `const BetaServiceAccountOrganizationRoleAdmin BetaServiceAccountOrganizationRole = "admin"` + + - `const BetaServiceAccountOrganizationRoleDeveloper BetaServiceAccountOrganizationRole = "developer"` + + - `Type ServiceAccount` + + default: service_account + + - `UpdatedAt Time` + + When this service account was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaServiceAccount, err := client.Beta.Organization.ServiceAccounts.Update( + context.TODO(), + "service_account_id", + anthropic.BetaOrganizationServiceAccountUpdateParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaServiceAccount.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +`client.Beta.Organization.ServiceAccounts.Archive(ctx, serviceAccountID, body) (*BetaServiceAccount, error)` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Parameters + +- `serviceAccountID string` + + ID of the service account to archive. + +- `body BetaOrganizationServiceAccountArchiveParams` + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaServiceAccount struct{…}` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `ID string` + + Tagged ID of the service account. + + - `ArchivedAt Time` + + If set, this service account is archived. + + format: date-time + + - `ArchivedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `CreatedAt Time` + + When this service account was created. + + format: date-time + + - `CreatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Description string` + + Optional free-text description. + + - `Name string` + + Admin-chosen slug identifier. + + - `OrganizationRole BetaServiceAccountOrganizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `const BetaServiceAccountOrganizationRoleAdmin BetaServiceAccountOrganizationRole = "admin"` + + - `const BetaServiceAccountOrganizationRoleDeveloper BetaServiceAccountOrganizationRole = "developer"` + + - `Type ServiceAccount` + + default: service_account + + - `UpdatedAt Time` + + When this service account was last updated. + + format: date-time + + - `UpdatedByActorID string` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaServiceAccount, err := client.Beta.Organization.ServiceAccounts.Archive( + context.TODO(), + "service_account_id", + anthropic.BetaOrganizationServiceAccountArchiveParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaServiceAccount.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +`client.Beta.Organization.ServiceAccounts.Workspaces.Add(ctx, serviceAccountID, params) (*BetaServiceAccountWorkspaceMember, error)` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Parameters + +- `serviceAccountID string` + + ID of the service account. + +- `params BetaOrganizationServiceAccountWorkspaceAddParams` + + - `WorkspaceID param.Field[string]` + + Body param: Tagged workspace ID to add the service account to. + + - `WorkspaceRole param.Field[BetaNoBillingWorkspaceRole]` + + Body param: Role to assign to the service account in this workspace. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaServiceAccountWorkspaceMember struct{…}` + + - `CreatedByActorID string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `Implicit bool` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `ServiceAccountID string` + + Tagged service account ID (`svac_...`). + + - `Type ServiceAccountWorkspaceMember` + + default: service_account_workspace_member + + - `WorkspaceID string` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` + + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` + + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` + + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` + + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaServiceAccountWorkspaceMember, err := client.Beta.Organization.ServiceAccounts.Workspaces.Add( + context.TODO(), + "service_account_id", + anthropic.BetaOrganizationServiceAccountWorkspaceAddParams{ + WorkspaceID: "workspace_id", + WorkspaceRole: anthropic.BetaNoBillingWorkspaceRoleWorkspaceAdmin, + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaServiceAccountWorkspaceMember.CreatedByActorID) +} +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +`client.Beta.Organization.ServiceAccounts.Workspaces.List(ctx, serviceAccountID, params) (*PageCursor[BetaServiceAccountWorkspaceMember], error)` + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Parameters + +- `serviceAccountID string` + + ID of the service account. + +- `params BetaOrganizationServiceAccountWorkspaceListParams` + + - `Limit param.Field[int64] Optional` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `Page param.Field[string] Optional` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaServiceAccountWorkspaceMember struct{…}` + + - `CreatedByActorID string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `Implicit bool` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `ServiceAccountID string` + + Tagged service account ID (`svac_...`). + + - `Type ServiceAccountWorkspaceMember` + + default: service_account_workspace_member + + - `WorkspaceID string` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` + + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` + + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` + + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` + + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.ServiceAccounts.Workspaces.List( + context.TODO(), + "service_account_id", + anthropic.BetaOrganizationServiceAccountWorkspaceListParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +`client.Beta.Organization.ServiceAccounts.Workspaces.Remove(ctx, workspaceID, params) (*BetaOrganizationServiceAccountWorkspaceRemoveResponse, error)` + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Parameters + +- `workspaceID string` + + ID of the workspace. + +- `params BetaOrganizationServiceAccountWorkspaceRemoveParams` + + - `ServiceAccountID param.Field[string]` + + Path param: ID of the service account. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaOrganizationServiceAccountWorkspaceRemoveResponse struct{…}` + + - `ServiceAccountID string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `Type ServiceAccountWorkspaceMemberDeleted` + + default: service_account_workspace_member_deleted + + - `WorkspaceID string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + workspace, err := client.Beta.Organization.ServiceAccounts.Workspaces.Remove( + context.TODO(), + "workspace_id", + anthropic.BetaOrganizationServiceAccountWorkspaceRemoveParams{ + ServiceAccountID: "service_account_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", workspace.ServiceAccountID) +} +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +`client.Beta.Organization.Users.List(ctx, query) (*Page[BetaOrganizationUser], error)` + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Parameters + +- `query BetaOrganizationUserListParams` + + - `AfterID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `BeforeID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `Email param.Field[string] Optional` + + Filter by user email. + + format: email + + - `Limit param.Field[int64] Optional` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `Roles param.Field[[]string] Optional` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `type BetaOrganizationUser struct{…}` + + - `ID string` + + ID of the User. + + - `AddedAt Time` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `Email string` + + Email of the User. + + - `Name string` + + Name of the User. + + - `Role BetaOrganizationRole` + + Organization role of the User. + + - `const BetaOrganizationRoleAdmin BetaOrganizationRole = "admin"` + + - `const BetaOrganizationRoleBilling BetaOrganizationRole = "billing"` + + - `const BetaOrganizationRoleClaudeCodeUser BetaOrganizationRole = "claude_code_user"` + + - `const BetaOrganizationRoleDeveloper BetaOrganizationRole = "developer"` + + - `const BetaOrganizationRoleManaged BetaOrganizationRole = "managed"` + + - `const BetaOrganizationRoleMembershipAdmin BetaOrganizationRole = "membership_admin"` + + - `const BetaOrganizationRoleOwner BetaOrganizationRole = "owner"` + + - `const BetaOrganizationRolePrimaryOwner BetaOrganizationRole = "primary_owner"` + + - `const BetaOrganizationRoleUser BetaOrganizationRole = "user"` + + - `Type User` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Users.List(context.TODO(), anthropic.BetaOrganizationUserListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +`client.Beta.Organization.Users.Get(ctx, userID) (*BetaOrganizationUser, error)` + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Parameters + +- `userID string` + + ID of the User. + +#### Returns + +- `type BetaOrganizationUser struct{…}` + + - `ID string` + + ID of the User. + + - `AddedAt Time` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `Email string` + + Email of the User. + + - `Name string` + + Name of the User. + + - `Role BetaOrganizationRole` + + Organization role of the User. + + - `const BetaOrganizationRoleAdmin BetaOrganizationRole = "admin"` + + - `const BetaOrganizationRoleBilling BetaOrganizationRole = "billing"` + + - `const BetaOrganizationRoleClaudeCodeUser BetaOrganizationRole = "claude_code_user"` + + - `const BetaOrganizationRoleDeveloper BetaOrganizationRole = "developer"` + + - `const BetaOrganizationRoleManaged BetaOrganizationRole = "managed"` + + - `const BetaOrganizationRoleMembershipAdmin BetaOrganizationRole = "membership_admin"` + + - `const BetaOrganizationRoleOwner BetaOrganizationRole = "owner"` + + - `const BetaOrganizationRolePrimaryOwner BetaOrganizationRole = "primary_owner"` + + - `const BetaOrganizationRoleUser BetaOrganizationRole = "user"` + + - `Type User` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaOrganizationUser, err := client.Beta.Organization.Users.Get(context.TODO(), "user_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaOrganizationUser.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +`client.Beta.Organization.Users.Update(ctx, userID, body) (*BetaOrganizationUser, error)` + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Parameters + +- `userID string` + + ID of the User. + +- `body BetaOrganizationUserUpdateParams` + + - `Role param.Field[BetaOrganizationUserUpdateParamsRole]` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `const BetaOrganizationUserUpdateParamsRoleBilling BetaOrganizationUserUpdateParamsRole = "billing"` + + - `const BetaOrganizationUserUpdateParamsRoleClaudeCodeUser BetaOrganizationUserUpdateParamsRole = "claude_code_user"` + + - `const BetaOrganizationUserUpdateParamsRoleDeveloper BetaOrganizationUserUpdateParamsRole = "developer"` + + - `const BetaOrganizationUserUpdateParamsRoleManaged BetaOrganizationUserUpdateParamsRole = "managed"` + + - `const BetaOrganizationUserUpdateParamsRoleUser BetaOrganizationUserUpdateParamsRole = "user"` + +#### Returns + +- `type BetaOrganizationUser struct{…}` + + - `ID string` + + ID of the User. + + - `AddedAt Time` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `Email string` + + Email of the User. + + - `Name string` + + Name of the User. + + - `Role BetaOrganizationRole` + + Organization role of the User. + + - `const BetaOrganizationRoleAdmin BetaOrganizationRole = "admin"` + + - `const BetaOrganizationRoleBilling BetaOrganizationRole = "billing"` + + - `const BetaOrganizationRoleClaudeCodeUser BetaOrganizationRole = "claude_code_user"` + + - `const BetaOrganizationRoleDeveloper BetaOrganizationRole = "developer"` + + - `const BetaOrganizationRoleManaged BetaOrganizationRole = "managed"` + + - `const BetaOrganizationRoleMembershipAdmin BetaOrganizationRole = "membership_admin"` + + - `const BetaOrganizationRoleOwner BetaOrganizationRole = "owner"` + + - `const BetaOrganizationRolePrimaryOwner BetaOrganizationRole = "primary_owner"` + + - `const BetaOrganizationRoleUser BetaOrganizationRole = "user"` + + - `Type User` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaOrganizationUser, err := client.Beta.Organization.Users.Update( + context.TODO(), + "user_id", + anthropic.BetaOrganizationUserUpdateParams{ + Role: anthropic.BetaOrganizationUserUpdateParamsRoleUser, + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaOrganizationUser.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +`client.Beta.Organization.Users.Remove(ctx, userID) (*BetaOrganizationUserRemoveResponse, error)` + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Parameters + +- `userID string` + + ID of the User. + +#### Returns + +- `type BetaOrganizationUserRemoveResponse struct{…}` + + - `ID string` + + ID of the User. + + - `Type UserDeleted` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + + default: user_deleted + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + user, err := client.Beta.Organization.Users.Remove(context.TODO(), "user_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", user.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +`client.Beta.Organization.Workspaces.List(ctx, query) (*Page[BetaWorkspace], error)` + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Parameters + +- `query BetaOrganizationWorkspaceListParams` + + - `AfterID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `BeforeID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `IncludeArchived param.Field[bool] Optional` + + Whether to include Workspaces that have been archived in the response + + - `Limit param.Field[int64] Optional` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `type BetaWorkspace struct{…}` + + - `ID string` + + ID of the Workspace. + + - `ArchivedAt Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `CompartmentID string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `CreatedAt Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `DataResidency BetaDataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos BetaDataResidencyAllowedInferenceGeosUnion` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `type BetaDataResidencyAllowedInferenceGeosGeos []string` + + - `type Unrestricted string` + + - `DefaultInferenceGeo string` + + Default inference geo applied when requests omit the parameter. + + - `WorkspaceGeo string` + + Geographic region for workspace data storage. Immutable after creation. + + - `DisplayColor string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `ExternalKeyID string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Name string` + + Name of the Workspace. + + - `Tags map[string, string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `Type Workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Workspaces.List(context.TODO(), anthropic.BetaOrganizationWorkspaceListParams{}) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +`client.Beta.Organization.Workspaces.New(ctx, params) (*BetaWorkspace, error)` + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Parameters + +- `params BetaOrganizationWorkspaceNewParams` + + - `Name param.Field[string]` + + Body param: Name of the Workspace. + + maxLength: 40, minLength: 1 + + - `DataResidency param.Field[BetaDataResidencyCreateConfig] Optional` + + Body param: Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `DisplayColor param.Field[string] Optional` + + Body param: Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + + - `ExternalKeyID param.Field[string] Optional` + + Body param: ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Tags param.Field[map[string, string]] Optional` + + Body param: User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaWorkspace struct{…}` + + - `ID string` + + ID of the Workspace. + + - `ArchivedAt Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `CompartmentID string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `CreatedAt Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `DataResidency BetaDataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos BetaDataResidencyAllowedInferenceGeosUnion` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `type BetaDataResidencyAllowedInferenceGeosGeos []string` + + - `type Unrestricted string` + + - `DefaultInferenceGeo string` + + Default inference geo applied when requests omit the parameter. + + - `WorkspaceGeo string` + + Geographic region for workspace data storage. Immutable after creation. + + - `DisplayColor string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `ExternalKeyID string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Name string` + + Name of the Workspace. + + - `Tags map[string, string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `Type Workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaWorkspace, err := client.Beta.Organization.Workspaces.New(context.TODO(), anthropic.BetaOrganizationWorkspaceNewParams{ + Name: "x", + }) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaWorkspace.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +`client.Beta.Organization.Workspaces.Get(ctx, workspaceID) (*BetaWorkspace, error)` + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Parameters + +- `workspaceID string` + + ID of the Workspace. + +#### Returns + +- `type BetaWorkspace struct{…}` + + - `ID string` + + ID of the Workspace. + + - `ArchivedAt Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `CompartmentID string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `CreatedAt Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `DataResidency BetaDataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos BetaDataResidencyAllowedInferenceGeosUnion` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `type BetaDataResidencyAllowedInferenceGeosGeos []string` + + - `type Unrestricted string` + + - `DefaultInferenceGeo string` + + Default inference geo applied when requests omit the parameter. + + - `WorkspaceGeo string` + + Geographic region for workspace data storage. Immutable after creation. + + - `DisplayColor string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `ExternalKeyID string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Name string` + + Name of the Workspace. + + - `Tags map[string, string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `Type Workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaWorkspace, err := client.Beta.Organization.Workspaces.Get(context.TODO(), "workspace_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaWorkspace.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +`client.Beta.Organization.Workspaces.Update(ctx, workspaceID, body) (*BetaWorkspace, error)` + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Parameters + +- `workspaceID string` + +- `body BetaOrganizationWorkspaceUpdateParams` + + - `DataResidency param.Field[BetaDataResidencyUpdateConfig] Optional` + + Data residency configuration for the workspace. + + - `DisplayColor param.Field[string] Optional` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + + - `ExternalKeyID param.Field[string] Optional` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Name param.Field[string] Optional` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + + - `Tags param.Field[map[string, string]] Optional` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `type BetaWorkspace struct{…}` + + - `ID string` + + ID of the Workspace. + + - `ArchivedAt Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `CompartmentID string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `CreatedAt Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `DataResidency BetaDataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos BetaDataResidencyAllowedInferenceGeosUnion` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `type BetaDataResidencyAllowedInferenceGeosGeos []string` + + - `type Unrestricted string` + + - `DefaultInferenceGeo string` + + Default inference geo applied when requests omit the parameter. + + - `WorkspaceGeo string` + + Geographic region for workspace data storage. Immutable after creation. + + - `DisplayColor string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `ExternalKeyID string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Name string` + + Name of the Workspace. + + - `Tags map[string, string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `Type Workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaWorkspace, err := client.Beta.Organization.Workspaces.Update( + context.TODO(), + "workspace_id", + anthropic.BetaOrganizationWorkspaceUpdateParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaWorkspace.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +`client.Beta.Organization.Workspaces.Archive(ctx, workspaceID) (*BetaWorkspace, error)` + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Parameters + +- `workspaceID string` + +#### Returns + +- `type BetaWorkspace struct{…}` + + - `ID string` + + ID of the Workspace. + + - `ArchivedAt Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `CompartmentID string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `CreatedAt Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `DataResidency BetaDataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos BetaDataResidencyAllowedInferenceGeosUnion` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `type BetaDataResidencyAllowedInferenceGeosGeos []string` + + - `type Unrestricted string` + + - `DefaultInferenceGeo string` + + Default inference geo applied when requests omit the parameter. + + - `WorkspaceGeo string` + + Geographic region for workspace data storage. Immutable after creation. + + - `DisplayColor string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `ExternalKeyID string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Name string` + + Name of the Workspace. + + - `Tags map[string, string]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `Type Workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaWorkspace, err := client.Beta.Organization.Workspaces.Archive(context.TODO(), "workspace_id") + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaWorkspace.ID) +} +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +`client.Beta.Organization.Workspaces.RateLimits.List(ctx, workspaceID, query) (*PageCursor[BetaWorkspaceRateLimit], error)` + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `workspaceID string` + + The ID of the workspace. + +- `query BetaOrganizationWorkspaceRateLimitListParams` + + - `GroupType param.Field[BetaOrganizationWorkspaceRateLimitListParamsGroupType] Optional` + + Filter by group type. + + - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeBatch BetaOrganizationWorkspaceRateLimitListParamsGroupType = "batch"` + + - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeFiles BetaOrganizationWorkspaceRateLimitListParamsGroupType = "files"` + + - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeModelGroup BetaOrganizationWorkspaceRateLimitListParamsGroupType = "model_group"` + + - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeSkills BetaOrganizationWorkspaceRateLimitListParamsGroupType = "skills"` + + - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeTokenCount BetaOrganizationWorkspaceRateLimitListParamsGroupType = "token_count"` + + - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeWebSearch BetaOrganizationWorkspaceRateLimitListParamsGroupType = "web_search"` + + - `Limit param.Field[int64] Optional` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + + - `Page param.Field[string] Optional` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `type BetaWorkspaceRateLimit struct{…}` + + - `GroupType BetaWorkspaceRateLimitGroupType` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `const BetaWorkspaceRateLimitGroupTypeBatch BetaWorkspaceRateLimitGroupType = "batch"` + + - `const BetaWorkspaceRateLimitGroupTypeFiles BetaWorkspaceRateLimitGroupType = "files"` + + - `const BetaWorkspaceRateLimitGroupTypeModelGroup BetaWorkspaceRateLimitGroupType = "model_group"` + + - `const BetaWorkspaceRateLimitGroupTypeSkills BetaWorkspaceRateLimitGroupType = "skills"` + + - `const BetaWorkspaceRateLimitGroupTypeTokenCount BetaWorkspaceRateLimitGroupType = "token_count"` + + - `const BetaWorkspaceRateLimitGroupTypeWebSearch BetaWorkspaceRateLimitGroupType = "web_search"` + + - `Limits []BetaWorkspaceRateLimitValue` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `OrgLimit int64` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `Type string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `Value int64` + + The workspace-level override value for this limiter type. + + - `Models []string` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `RateLimitID string` + + The `id` of the RateLimit group this override applies to. + + - `Type WorkspaceRateLimit` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `WorkspaceID string` + + ID of the Workspace this override applies to. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Workspaces.RateLimits.List( + context.TODO(), + "workspace_id", + anthropic.BetaOrganizationWorkspaceRateLimitListParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +`client.Beta.Organization.Workspaces.Members.List(ctx, workspaceID, query) (*Page[BetaWorkspaceMember], error)` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Parameters + +- `workspaceID string` + + ID of the Workspace. + +- `query BetaOrganizationWorkspaceMemberListParams` + + - `AfterID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `BeforeID param.Field[string] Optional` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `Limit param.Field[int64] Optional` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `type BetaWorkspaceMember struct{…}` + + - `Type WorkspaceMember` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `UserID string` + + ID of the User. + + - `WorkspaceID string` + + ID of the Workspace. + + - `WorkspaceRole BetaWorkspaceRole` + + Role of the Workspace Member. + + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` + + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` + + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` + + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` + + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Workspaces.Members.List( + context.TODO(), + "workspace_id", + anthropic.BetaOrganizationWorkspaceMemberListParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +`client.Beta.Organization.Workspaces.Members.Add(ctx, workspaceID, body) (*BetaWorkspaceMember, error)` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Parameters + +- `workspaceID string` + + ID of the Workspace. + +- `body BetaOrganizationWorkspaceMemberAddParams` + + - `UserID param.Field[string]` + + ID of the User. + + - `WorkspaceRole param.Field[BetaNoBillingWorkspaceRole]` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + +#### Returns + +- `type BetaWorkspaceMember struct{…}` + + - `Type WorkspaceMember` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `UserID string` + + ID of the User. + + - `WorkspaceID string` + + ID of the Workspace. + + - `WorkspaceRole BetaWorkspaceRole` + + Role of the Workspace Member. + + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` + + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` + + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` + + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` + + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaWorkspaceMember, err := client.Beta.Organization.Workspaces.Members.Add( + context.TODO(), + "workspace_id", + anthropic.BetaOrganizationWorkspaceMemberAddParams{ + UserID: "user_01WCz1FkmYMm4gnmykNKUu3Q", + WorkspaceRole: anthropic.BetaNoBillingWorkspaceRoleWorkspaceAdmin, + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaWorkspaceMember.UserID) +} +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +`client.Beta.Organization.Workspaces.Members.Get(ctx, userID, query) (*BetaWorkspaceMember, error)` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Parameters + +- `userID string` + + ID of the User. + +- `query BetaOrganizationWorkspaceMemberGetParams` + + - `WorkspaceID param.Field[string]` + + ID of the Workspace. + +#### Returns + +- `type BetaWorkspaceMember struct{…}` + + - `Type WorkspaceMember` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `UserID string` + + ID of the User. + + - `WorkspaceID string` + + ID of the Workspace. + + - `WorkspaceRole BetaWorkspaceRole` + + Role of the Workspace Member. + + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` + + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` + + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` + + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` + + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaWorkspaceMember, err := client.Beta.Organization.Workspaces.Members.Get( + context.TODO(), + "user_id", + anthropic.BetaOrganizationWorkspaceMemberGetParams{ + WorkspaceID: "workspace_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaWorkspaceMember.UserID) +} +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +`client.Beta.Organization.Workspaces.Members.Update(ctx, userID, params) (*BetaWorkspaceMember, error)` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Parameters + +- `userID string` + + ID of the User. + +- `params BetaOrganizationWorkspaceMemberUpdateParams` + + - `WorkspaceID param.Field[string]` + + Path param: ID of the Workspace. + + - `WorkspaceRole param.Field[BetaWorkspaceRole]` + + Body param: New workspace role for the User. + +#### Returns + +- `type BetaWorkspaceMember struct{…}` + + - `Type WorkspaceMember` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `UserID string` + + ID of the User. + + - `WorkspaceID string` + + ID of the Workspace. + + - `WorkspaceRole BetaWorkspaceRole` + + Role of the Workspace Member. + + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` + + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` + + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` + + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` + + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + betaWorkspaceMember, err := client.Beta.Organization.Workspaces.Members.Update( + context.TODO(), + "user_id", + anthropic.BetaOrganizationWorkspaceMemberUpdateParams{ + WorkspaceID: "workspace_id", + WorkspaceRole: anthropic.BetaWorkspaceRoleWorkspaceAdmin, + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", betaWorkspaceMember.UserID) +} +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +`client.Beta.Organization.Workspaces.Members.Remove(ctx, userID, body) (*BetaOrganizationWorkspaceMemberRemoveResponse, error)` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Parameters + +- `userID string` + + ID of the User. + +- `body BetaOrganizationWorkspaceMemberRemoveParams` + + - `WorkspaceID param.Field[string]` + + ID of the Workspace. + +#### Returns + +- `type BetaOrganizationWorkspaceMemberRemoveResponse struct{…}` + + - `Type WorkspaceMemberDeleted` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + + - `UserID string` + + ID of the User. + + - `WorkspaceID string` + + ID of the Workspace. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + member, err := client.Beta.Organization.Workspaces.Members.Remove( + context.TODO(), + "user_id", + anthropic.BetaOrganizationWorkspaceMemberRemoveParams{ + WorkspaceID: "workspace_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", member.UserID) +} +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +`client.Beta.Organization.Workspaces.ServiceAccounts.List(ctx, workspaceID, params) (*PageCursor[BetaServiceAccountWorkspaceMember], error)` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Parameters + +- `workspaceID string` + + ID of the workspace. + +- `params BetaOrganizationWorkspaceServiceAccountListParams` + + - `Limit param.Field[int64] Optional` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `Page param.Field[string] Optional` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + +#### Returns + +- `type BetaServiceAccountWorkspaceMember struct{…}` + + - `CreatedByActorID string` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `Implicit bool` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `ServiceAccountID string` + + Tagged service account ID (`svac_...`). + + - `Type ServiceAccountWorkspaceMember` + + default: service_account_workspace_member + + - `WorkspaceID string` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` + + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` + + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` + + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` + + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + page, err := client.Beta.Organization.Workspaces.ServiceAccounts.List( + context.TODO(), + "workspace_id", + anthropic.BetaOrganizationWorkspaceServiceAccountListParams{}, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", page) +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +`client.Beta.Organization.Workspaces.ServiceAccounts.Add(ctx, workspaceID, params) (*BetaServiceAccountWorkspaceMember, error)` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Parameters + +- `workspaceID string` + + ID of the workspace. + +- `params BetaOrganizationWorkspaceServiceAccountAddParams` + + - `ServiceAccountID param.Field[string]` + + Body param: Tagged service account ID to add. + + - `WorkspaceRole param.Field[BetaNoBillingWorkspaceRole]` + + Body param: Role to assign to the service account in this workspace. + + - `Betas param.Field[[]AnthropicBeta] Optional` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `string` + + - `type AnthropicBeta string` + + - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` + + - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` + + - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` + + - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` + + - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` + + - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` + + - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` + + - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` + + - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` + + - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` + + - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` + + - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` + + - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` + + - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` + + - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` + + - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` + + - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` + + - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` + + - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` + + - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` + + - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` + + - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` + + - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` + + - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` + + - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` + + - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` + + - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` + + - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` + + - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` + + - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` + + - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` + + - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` + + - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns -- `type BetaTunnelCertificate struct{…}` +- `type BetaServiceAccountWorkspaceMember struct{…}` - A CA certificate attached to a tunnel. + - `CreatedByActorID string` - - `ID string` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `Implicit bool` - - `ArchivedAt Time` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `ServiceAccountID string` - format: date-time + Tagged service account ID (`svac_...`). - - `CreatedAt Time` + - `Type ServiceAccountWorkspaceMember` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `WorkspaceID string` - - `ExpiresAt Time` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `WorkspaceRole BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `Fingerprint string` + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` - - `TunnelID string` + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` - ID of the tunnel the certificate is registered against. + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` - - `Type TunnelCertificate` + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` #### Example @@ -66683,17 +79319,18 @@ func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) - betaTunnelCertificate, err := client.Beta.Tunnels.Certificates.New( + betaServiceAccountWorkspaceMember, err := client.Beta.Organization.Workspaces.ServiceAccounts.Add( context.TODO(), - "tunnel_id", - anthropic.BetaTunnelCertificateNewParams{ - CaCertificatePem: "ca_certificate_pem", + "workspace_id", + anthropic.BetaOrganizationWorkspaceServiceAccountAddParams{ + ServiceAccountID: "service_account_id", + WorkspaceRole: anthropic.BetaNoBillingWorkspaceRoleWorkspaceAdmin, }, ) if err != nil { panic(err.Error()) } - fmt.Printf("%+v\n", betaTunnelCertificate.ID) + fmt.Printf("%+v\n", betaServiceAccountWorkspaceMember.CreatedByActorID) } ``` @@ -66701,35 +79338,43 @@ func main() { ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Get Tunnel Certificate +### Get Service Account Workspace Member -`client.Beta.Tunnels.Certificates.Get(ctx, certificateID, params) (*BetaTunnelCertificate, error)` +`client.Beta.Organization.Workspaces.ServiceAccounts.Get(ctx, serviceAccountID, params) (*BetaServiceAccountWorkspaceMember, error)` -**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Fetches a tunnel certificate by ID. +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. #### Parameters -- `certificateID string` +- `serviceAccountID string` -- `params BetaTunnelCertificateGetParams` + ID of the service account. - - `TunnelID param.Field[string]` +- `params BetaOrganizationWorkspaceServiceAccountGetParams` - Path param: Path parameter tunnel_id + - `WorkspaceID param.Field[string]` + + Path param: ID of the workspace. - `Betas param.Field[[]AnthropicBeta] Optional` @@ -66807,43 +79452,57 @@ Fetches a tunnel certificate by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns -- `type BetaTunnelCertificate struct{…}` +- `type BetaServiceAccountWorkspaceMember struct{…}` - A CA certificate attached to a tunnel. + - `CreatedByActorID string` - - `ID string` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `Implicit bool` - - `ArchivedAt Time` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `ServiceAccountID string` - format: date-time + Tagged service account ID (`svac_...`). - - `CreatedAt Time` + - `Type ServiceAccountWorkspaceMember` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `WorkspaceID string` - - `ExpiresAt Time` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `WorkspaceRole BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `Fingerprint string` + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` - - `TunnelID string` + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` - ID of the tunnel the certificate is registered against. + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` - - `Type TunnelCertificate` + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` #### Example @@ -66862,17 +79521,17 @@ func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) - betaTunnelCertificate, err := client.Beta.Tunnels.Certificates.Get( + betaServiceAccountWorkspaceMember, err := client.Beta.Organization.Workspaces.ServiceAccounts.Get( context.TODO(), - "certificate_id", - anthropic.BetaTunnelCertificateGetParams{ - TunnelID: "tunnel_id", + "service_account_id", + anthropic.BetaOrganizationWorkspaceServiceAccountGetParams{ + WorkspaceID: "workspace_id", }, ) if err != nil { panic(err.Error()) } - fmt.Printf("%+v\n", betaTunnelCertificate.ID) + fmt.Printf("%+v\n", betaServiceAccountWorkspaceMember.CreatedByActorID) } ``` @@ -66880,45 +79539,47 @@ func main() { ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### List Tunnel Certificates +### Update Service Account Workspace Member -`client.Beta.Tunnels.Certificates.List(ctx, tunnelID, params) (*PageCursor[BetaTunnelCertificate], error)` +`client.Beta.Organization.Workspaces.ServiceAccounts.Update(ctx, serviceAccountID, params) (*BetaServiceAccountWorkspaceMember, error)` -**GET** `/v1/tunnels/{tunnel_id}/certificates` +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. #### Parameters -- `tunnelID string` +- `serviceAccountID string` -- `params BetaTunnelCertificateListParams` + ID of the service account. - - `IncludeArchived param.Field[bool] Optional` +- `params BetaOrganizationWorkspaceServiceAccountUpdateParams` - Query param: Whether to include archived certificates in the results. Defaults to false. + - `WorkspaceID param.Field[string]` - - `Limit param.Field[int64] Optional` + Path param: ID of the workspace. - Query param: Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + - `WorkspaceRole param.Field[BetaNoBillingWorkspaceRole]` - format: int32 - - - `Page param.Field[string] Optional` - - Query param: Opaque pagination cursor from a previous `list_tunnel_certificates` response. + Body param: New role for the service account in this workspace. - `Betas param.Field[[]AnthropicBeta] Optional` @@ -66996,43 +79657,57 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns -- `type BetaTunnelCertificate struct{…}` +- `type BetaServiceAccountWorkspaceMember struct{…}` - A CA certificate attached to a tunnel. + - `CreatedByActorID string` - - `ID string` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `Implicit bool` - - `ArchivedAt Time` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `ServiceAccountID string` - format: date-time + Tagged service account ID (`svac_...`). - - `CreatedAt Time` + - `Type ServiceAccountWorkspaceMember` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `WorkspaceID string` - - `ExpiresAt Time` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `WorkspaceRole BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `Fingerprint string` + - `const BetaWorkspaceRoleWorkspaceAdmin BetaWorkspaceRole = "workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `const BetaWorkspaceRoleWorkspaceBilling BetaWorkspaceRole = "workspace_billing"` - - `TunnelID string` + - `const BetaWorkspaceRoleWorkspaceDeveloper BetaWorkspaceRole = "workspace_developer"` - ID of the tunnel the certificate is registered against. + - `const BetaWorkspaceRoleWorkspaceRestrictedDeveloper BetaWorkspaceRole = "workspace_restricted_developer"` - - `Type TunnelCertificate` + - `const BetaWorkspaceRoleWorkspaceUser BetaWorkspaceRole = "workspace_user"` #### Example @@ -67051,15 +79726,18 @@ func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) - page, err := client.Beta.Tunnels.Certificates.List( + betaServiceAccountWorkspaceMember, err := client.Beta.Organization.Workspaces.ServiceAccounts.Update( context.TODO(), - "tunnel_id", - anthropic.BetaTunnelCertificateListParams{}, + "service_account_id", + anthropic.BetaOrganizationWorkspaceServiceAccountUpdateParams{ + WorkspaceID: "workspace_id", + WorkspaceRole: anthropic.BetaNoBillingWorkspaceRoleWorkspaceAdmin, + }, ) if err != nil { panic(err.Error()) } - fmt.Printf("%+v\n", page) + fmt.Printf("%+v\n", betaServiceAccountWorkspaceMember.CreatedByActorID) } ``` @@ -67067,40 +79745,42 @@ func main() { ```json { - "data": [ - { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" - } - ], - "next_page": "next_page" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Archive Tunnel Certificate +### Delete Service Account Workspace Member -`client.Beta.Tunnels.Certificates.Archive(ctx, certificateID, params) (*BetaTunnelCertificate, error)` +`client.Beta.Organization.Workspaces.ServiceAccounts.Remove(ctx, serviceAccountID, params) (*BetaOrganizationWorkspaceServiceAccountRemoveResponse, error)` -**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. #### Parameters -- `certificateID string` +- `serviceAccountID string` -- `params BetaTunnelCertificateArchiveParams` + ID of the service account. - - `TunnelID param.Field[string]` +- `params BetaOrganizationWorkspaceServiceAccountRemoveParams` - Path param: Path parameter tunnel_id + - `WorkspaceID param.Field[string]` + + Path param: ID of the workspace. - `Betas param.Field[[]AnthropicBeta] Optional` @@ -67178,43 +79858,176 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns -- `type BetaTunnelCertificate struct{…}` +- `type BetaOrganizationWorkspaceServiceAccountRemoveResponse struct{…}` - A CA certificate attached to a tunnel. + - `ServiceAccountID string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `Type ServiceAccountWorkspaceMemberDeleted` + + default: service_account_workspace_member_deleted + + - `WorkspaceID string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```go +package main + +import ( + "context" + "fmt" + + "github.com/anthropics/anthropic-sdk-go" + "github.com/anthropics/anthropic-sdk-go/option" +) + +func main() { + client := anthropic.NewClient( + option.WithAPIKey("my-anthropic-api-key"), + ) + serviceAccount, err := client.Beta.Organization.Workspaces.ServiceAccounts.Remove( + context.TODO(), + "service_account_id", + anthropic.BetaOrganizationWorkspaceServiceAccountRemoveParams{ + WorkspaceID: "workspace_id", + }, + ) + if err != nil { + panic(err.Error()) + } + fmt.Printf("%+v\n", serviceAccount.ServiceAccountID) +} +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Rate Limits + +### List Organization Rate Limits + +`client.Beta.Organization.RateLimits.List(ctx, query) (*PageCursor[BetaOrganizationRateLimit], error)` + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `query BetaOrganizationRateLimitListParams` + + - `GroupType param.Field[BetaOrganizationRateLimitListParamsGroupType] Optional` + + Filter by group type. + + - `const BetaOrganizationRateLimitListParamsGroupTypeBatch BetaOrganizationRateLimitListParamsGroupType = "batch"` + + - `const BetaOrganizationRateLimitListParamsGroupTypeFiles BetaOrganizationRateLimitListParamsGroupType = "files"` + + - `const BetaOrganizationRateLimitListParamsGroupTypeModelGroup BetaOrganizationRateLimitListParamsGroupType = "model_group"` + + - `const BetaOrganizationRateLimitListParamsGroupTypeSkills BetaOrganizationRateLimitListParamsGroupType = "skills"` + + - `const BetaOrganizationRateLimitListParamsGroupTypeTokenCount BetaOrganizationRateLimitListParamsGroupType = "token_count"` + + - `const BetaOrganizationRateLimitListParamsGroupTypeWebSearch BetaOrganizationRateLimitListParamsGroupType = "web_search"` + + - `Limit param.Field[int64] Optional` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + + - `Model param.Field[string] Optional` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + + - `Page param.Field[string] Optional` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `type BetaOrganizationRateLimit struct{…}` - `ID string` - Unique identifier for the certificate, prefixed with `tcrt_`. + Stable identifier for this rate-limit group within the organization. - - `ArchivedAt Time` + - `GroupType BetaOrganizationRateLimitGroupType` - A timestamp in RFC 3339 format + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. - format: date-time + - `const BetaOrganizationRateLimitGroupTypeBatch BetaOrganizationRateLimitGroupType = "batch"` - - `CreatedAt Time` + - `const BetaOrganizationRateLimitGroupTypeFiles BetaOrganizationRateLimitGroupType = "files"` - A timestamp in RFC 3339 format + - `const BetaOrganizationRateLimitGroupTypeModelGroup BetaOrganizationRateLimitGroupType = "model_group"` - format: date-time + - `const BetaOrganizationRateLimitGroupTypeSkills BetaOrganizationRateLimitGroupType = "skills"` - - `ExpiresAt Time` + - `const BetaOrganizationRateLimitGroupTypeTokenCount BetaOrganizationRateLimitGroupType = "token_count"` - A timestamp in RFC 3339 format + - `const BetaOrganizationRateLimitGroupTypeWebSearch BetaOrganizationRateLimitGroupType = "web_search"` - format: date-time + - `Limits []BetaOrganizationRateLimitValue` - - `Fingerprint string` + The limiter values that apply to this group. - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `Type string` - - `TunnelID string` + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - ID of the tunnel the certificate is registered against. + - `Value int64` - - `Type TunnelCertificate` + The configured limit value for this limiter type. + + - `Models []string` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `Type RateLimit` + + Object type. Always `rate_limit` for organization rate-limit entries. + + default: rate_limit #### Example @@ -67233,17 +80046,11 @@ func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) - betaTunnelCertificate, err := client.Beta.Tunnels.Certificates.Archive( - context.TODO(), - "certificate_id", - anthropic.BetaTunnelCertificateArchiveParams{ - TunnelID: "tunnel_id", - }, - ) + page, err := client.Beta.Organization.RateLimits.List(context.TODO(), anthropic.BetaOrganizationRateLimitListParams{}) if err != nil { panic(err.Error()) } - fmt.Printf("%+v\n", betaTunnelCertificate.ID) + fmt.Printf("%+v\n", page) } ``` @@ -67251,12 +80058,22 @@ func main() { ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" } ``` diff --git a/content/en/api/go/beta/agents.md b/content/en/api/go/beta/agents.md index 5b8b4f020..1047711f8 100644 --- a/content/en/api/go/beta/agents.md +++ b/content/en/api/go/beta/agents.md @@ -688,6 +688,20 @@ Create Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -1439,6 +1453,20 @@ List Agents - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -2172,6 +2200,20 @@ Get Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -3504,6 +3546,20 @@ Update Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -4232,6 +4288,20 @@ Archive Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsAgent struct{…}` @@ -8708,6 +8778,20 @@ List Agent Versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsAgent struct{…}` diff --git a/content/en/api/go/beta/agents/archive.md b/content/en/api/go/beta/agents/archive.md index c65041f3d..8005ffab1 100644 --- a/content/en/api/go/beta/agents/archive.md +++ b/content/en/api/go/beta/agents/archive.md @@ -88,6 +88,20 @@ Archive Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsAgent struct{…}` diff --git a/content/en/api/go/beta/agents/create.md b/content/en/api/go/beta/agents/create.md index c2fb55407..f84245a95 100644 --- a/content/en/api/go/beta/agents/create.md +++ b/content/en/api/go/beta/agents/create.md @@ -686,6 +686,20 @@ Create Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsAgent struct{…}` diff --git a/content/en/api/go/beta/agents/list.md b/content/en/api/go/beta/agents/list.md index a3b22266a..ac644aaab 100644 --- a/content/en/api/go/beta/agents/list.md +++ b/content/en/api/go/beta/agents/list.md @@ -112,6 +112,20 @@ List Agents - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsAgent struct{…}` diff --git a/content/en/api/go/beta/agents/retrieve.md b/content/en/api/go/beta/agents/retrieve.md index 086316e40..93adae030 100644 --- a/content/en/api/go/beta/agents/retrieve.md +++ b/content/en/api/go/beta/agents/retrieve.md @@ -94,6 +94,20 @@ Get Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsAgent struct{…}` diff --git a/content/en/api/go/beta/agents/update.md b/content/en/api/go/beta/agents/update.md index 77730aa31..ed8ddb099 100644 --- a/content/en/api/go/beta/agents/update.md +++ b/content/en/api/go/beta/agents/update.md @@ -694,6 +694,20 @@ Update Agent - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsAgent struct{…}` diff --git a/content/en/api/go/beta/agents/versions.md b/content/en/api/go/beta/agents/versions.md index 0450294e3..f309d7c90 100644 --- a/content/en/api/go/beta/agents/versions.md +++ b/content/en/api/go/beta/agents/versions.md @@ -100,6 +100,20 @@ List Agent Versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsAgent struct{…}` diff --git a/content/en/api/go/beta/agents/versions/list.md b/content/en/api/go/beta/agents/versions/list.md index 750d4098f..e6eec5362 100644 --- a/content/en/api/go/beta/agents/versions/list.md +++ b/content/en/api/go/beta/agents/versions/list.md @@ -98,6 +98,20 @@ List Agent Versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsAgent struct{…}` diff --git a/content/en/api/go/beta/deployment_runs.md b/content/en/api/go/beta/deployment_runs.md index 3e3cc44a9..6f82aeb8a 100644 --- a/content/en/api/go/beta/deployment_runs.md +++ b/content/en/api/go/beta/deployment_runs.md @@ -134,6 +134,20 @@ List Deployment Runs - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeploymentRun struct{…}` @@ -503,6 +517,20 @@ Get Deployment Run - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeploymentRun struct{…}` diff --git a/content/en/api/go/beta/deployment_runs/list.md b/content/en/api/go/beta/deployment_runs/list.md index e4ba62814..6e1f6d7e7 100644 --- a/content/en/api/go/beta/deployment_runs/list.md +++ b/content/en/api/go/beta/deployment_runs/list.md @@ -132,6 +132,20 @@ List Deployment Runs - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeploymentRun struct{…}` diff --git a/content/en/api/go/beta/deployment_runs/retrieve.md b/content/en/api/go/beta/deployment_runs/retrieve.md index f0406b4ea..84421faf6 100644 --- a/content/en/api/go/beta/deployment_runs/retrieve.md +++ b/content/en/api/go/beta/deployment_runs/retrieve.md @@ -88,6 +88,20 @@ Get Deployment Run - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeploymentRun struct{…}` diff --git a/content/en/api/go/beta/deployments.md b/content/en/api/go/beta/deployments.md index 0d95671bd..6b3fb3a43 100644 --- a/content/en/api/go/beta/deployments.md +++ b/content/en/api/go/beta/deployments.md @@ -460,6 +460,20 @@ Create Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -1207,6 +1221,20 @@ List Deployments - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -1910,6 +1938,20 @@ Get Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -2984,6 +3026,20 @@ Update Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -3686,6 +3742,20 @@ Archive Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -4388,6 +4458,20 @@ Run Deployment Now - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeploymentRun struct{…}` @@ -4756,6 +4840,20 @@ Pause Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeployment struct{…}` @@ -5458,6 +5556,20 @@ Unpause Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeployment struct{…}` diff --git a/content/en/api/go/beta/deployments/archive.md b/content/en/api/go/beta/deployments/archive.md index 8413b3abd..090f0930a 100644 --- a/content/en/api/go/beta/deployments/archive.md +++ b/content/en/api/go/beta/deployments/archive.md @@ -88,6 +88,20 @@ Archive Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeployment struct{…}` diff --git a/content/en/api/go/beta/deployments/create.md b/content/en/api/go/beta/deployments/create.md index 02a684e9e..2bf8740d5 100644 --- a/content/en/api/go/beta/deployments/create.md +++ b/content/en/api/go/beta/deployments/create.md @@ -458,6 +458,20 @@ Create Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeployment struct{…}` diff --git a/content/en/api/go/beta/deployments/list.md b/content/en/api/go/beta/deployments/list.md index 271cc3664..cedeb20a6 100644 --- a/content/en/api/go/beta/deployments/list.md +++ b/content/en/api/go/beta/deployments/list.md @@ -120,6 +120,20 @@ List Deployments - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeployment struct{…}` diff --git a/content/en/api/go/beta/deployments/pause.md b/content/en/api/go/beta/deployments/pause.md index 2908d4178..0ee5427b6 100644 --- a/content/en/api/go/beta/deployments/pause.md +++ b/content/en/api/go/beta/deployments/pause.md @@ -88,6 +88,20 @@ Pause Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeployment struct{…}` diff --git a/content/en/api/go/beta/deployments/retrieve.md b/content/en/api/go/beta/deployments/retrieve.md index bb6775baa..34bbf1cd9 100644 --- a/content/en/api/go/beta/deployments/retrieve.md +++ b/content/en/api/go/beta/deployments/retrieve.md @@ -88,6 +88,20 @@ Get Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeployment struct{…}` diff --git a/content/en/api/go/beta/deployments/run.md b/content/en/api/go/beta/deployments/run.md index 0da9d865a..76319ce96 100644 --- a/content/en/api/go/beta/deployments/run.md +++ b/content/en/api/go/beta/deployments/run.md @@ -88,6 +88,20 @@ Run Deployment Now - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeploymentRun struct{…}` diff --git a/content/en/api/go/beta/deployments/unpause.md b/content/en/api/go/beta/deployments/unpause.md index 6750e2798..fc951b2b2 100644 --- a/content/en/api/go/beta/deployments/unpause.md +++ b/content/en/api/go/beta/deployments/unpause.md @@ -88,6 +88,20 @@ Unpause Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeployment struct{…}` diff --git a/content/en/api/go/beta/deployments/update.md b/content/en/api/go/beta/deployments/update.md index 37f7eea6c..1837ca9f1 100644 --- a/content/en/api/go/beta/deployments/update.md +++ b/content/en/api/go/beta/deployments/update.md @@ -460,6 +460,20 @@ Update Deployment - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeployment struct{…}` diff --git a/content/en/api/go/beta/environments.md b/content/en/api/go/beta/environments.md index a256a0b06..4ee677cd5 100644 --- a/content/en/api/go/beta/environments.md +++ b/content/en/api/go/beta/environments.md @@ -62,7 +62,7 @@ Create a new environment with the specified configuration. - `AllowPackageManagers bool Optional` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `AllowedHosts []string Optional` @@ -74,6 +74,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Apt []string Optional` Ubuntu/Debian packages to install @@ -206,6 +208,20 @@ Create a new environment with the specified configuration. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaEnvironment struct{…}` @@ -518,6 +534,20 @@ List environments with pagination support. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaEnvironment struct{…}` @@ -821,6 +851,20 @@ Retrieve a specific environment by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaEnvironment struct{…}` @@ -1091,7 +1135,7 @@ Update an existing environment's configuration. - `AllowPackageManagers bool Optional` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `AllowedHosts []string Optional` @@ -1103,6 +1147,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Apt []string Optional` Ubuntu/Debian packages to install @@ -1241,6 +1287,20 @@ Update an existing environment's configuration. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaEnvironment struct{…}` @@ -1543,6 +1603,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaEnvironmentDeleteResponse struct{…}` @@ -1687,6 +1761,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaEnvironment struct{…}` @@ -2019,7 +2107,7 @@ func main() { - `AllowPackageManagers bool Optional` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `AllowedHosts []string Optional` @@ -2031,6 +2119,8 @@ func main() { When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Apt []string Optional` Ubuntu/Debian packages to install @@ -2252,7 +2342,7 @@ func main() { - `AllowPackageManagers bool Optional` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `AllowedHosts []string Optional` @@ -2302,6 +2392,8 @@ func main() { When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Apt []string Optional` Ubuntu/Debian packages to install @@ -2460,6 +2552,20 @@ Retrieve detailed information about a specific work item. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -2702,6 +2808,20 @@ Long poll for work items in the queue. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `AnthropicWorkerID param.Field[string] Optional` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -2938,6 +3058,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -3180,6 +3314,20 @@ Record a heartbeat for a work item to maintain the lease. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWorkHeartbeatResponse struct{…}` @@ -3361,6 +3509,20 @@ Stop a work item, initiating graceful or forced shutdown. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -3602,6 +3764,20 @@ List work items in an environment. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -3843,6 +4019,20 @@ Update work item metadata with merge semantics. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWork struct{…}` @@ -4076,6 +4266,20 @@ Get statistics about the work queue for an environment. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSelfHostedWorkQueueStats struct{…}` diff --git a/content/en/api/go/beta/environments/archive.md b/content/en/api/go/beta/environments/archive.md index ea304a8a0..84ddc6acd 100644 --- a/content/en/api/go/beta/environments/archive.md +++ b/content/en/api/go/beta/environments/archive.md @@ -88,6 +88,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaEnvironment struct{…}` diff --git a/content/en/api/go/beta/environments/create.md b/content/en/api/go/beta/environments/create.md index 5efb5a660..a84793a59 100644 --- a/content/en/api/go/beta/environments/create.md +++ b/content/en/api/go/beta/environments/create.md @@ -60,7 +60,7 @@ Create a new environment with the specified configuration. - `AllowPackageManagers bool Optional` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `AllowedHosts []string Optional` @@ -72,6 +72,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Apt []string Optional` Ubuntu/Debian packages to install @@ -204,6 +206,20 @@ Create a new environment with the specified configuration. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaEnvironment struct{…}` diff --git a/content/en/api/go/beta/environments/delete.md b/content/en/api/go/beta/environments/delete.md index f0777ca65..7dba84c21 100644 --- a/content/en/api/go/beta/environments/delete.md +++ b/content/en/api/go/beta/environments/delete.md @@ -88,6 +88,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaEnvironmentDeleteResponse struct{…}` diff --git a/content/en/api/go/beta/environments/list.md b/content/en/api/go/beta/environments/list.md index e184391af..4aae86429 100644 --- a/content/en/api/go/beta/environments/list.md +++ b/content/en/api/go/beta/environments/list.md @@ -100,6 +100,20 @@ List environments with pagination support. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaEnvironment struct{…}` diff --git a/content/en/api/go/beta/environments/retrieve.md b/content/en/api/go/beta/environments/retrieve.md index 888525987..19063ef92 100644 --- a/content/en/api/go/beta/environments/retrieve.md +++ b/content/en/api/go/beta/environments/retrieve.md @@ -88,6 +88,20 @@ Retrieve a specific environment by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaEnvironment struct{…}` diff --git a/content/en/api/go/beta/environments/update.md b/content/en/api/go/beta/environments/update.md index 0c4cb95a1..1dbceb0b7 100644 --- a/content/en/api/go/beta/environments/update.md +++ b/content/en/api/go/beta/environments/update.md @@ -56,7 +56,7 @@ Update an existing environment's configuration. - `AllowPackageManagers bool Optional` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `AllowedHosts []string Optional` @@ -68,6 +68,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Apt []string Optional` Ubuntu/Debian packages to install @@ -206,6 +208,20 @@ Update an existing environment's configuration. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaEnvironment struct{…}` diff --git a/content/en/api/go/beta/environments/work.md b/content/en/api/go/beta/environments/work.md index 4aa76e6e2..7ebc84ea9 100644 --- a/content/en/api/go/beta/environments/work.md +++ b/content/en/api/go/beta/environments/work.md @@ -96,6 +96,20 @@ Retrieve detailed information about a specific work item. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSelfHostedWork struct{…}` @@ -338,6 +352,20 @@ Long poll for work items in the queue. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `AnthropicWorkerID param.Field[string] Optional` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -574,6 +602,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSelfHostedWork struct{…}` @@ -816,6 +858,20 @@ Record a heartbeat for a work item to maintain the lease. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSelfHostedWorkHeartbeatResponse struct{…}` @@ -997,6 +1053,20 @@ Stop a work item, initiating graceful or forced shutdown. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSelfHostedWork struct{…}` @@ -1238,6 +1308,20 @@ List work items in an environment. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSelfHostedWork struct{…}` @@ -1479,6 +1563,20 @@ Update work item metadata with merge semantics. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSelfHostedWork struct{…}` @@ -1712,6 +1810,20 @@ Get statistics about the work queue for an environment. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSelfHostedWorkQueueStats struct{…}` diff --git a/content/en/api/go/beta/environments/work/ack.md b/content/en/api/go/beta/environments/work/ack.md index ef18cbb16..de01900a0 100644 --- a/content/en/api/go/beta/environments/work/ack.md +++ b/content/en/api/go/beta/environments/work/ack.md @@ -94,6 +94,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSelfHostedWork struct{…}` diff --git a/content/en/api/go/beta/environments/work/heartbeat.md b/content/en/api/go/beta/environments/work/heartbeat.md index 286f65aa2..31c97db5a 100644 --- a/content/en/api/go/beta/environments/work/heartbeat.md +++ b/content/en/api/go/beta/environments/work/heartbeat.md @@ -102,6 +102,20 @@ Record a heartbeat for a work item to maintain the lease. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSelfHostedWorkHeartbeatResponse struct{…}` diff --git a/content/en/api/go/beta/environments/work/list.md b/content/en/api/go/beta/environments/work/list.md index 2fbaa3662..190a85077 100644 --- a/content/en/api/go/beta/environments/work/list.md +++ b/content/en/api/go/beta/environments/work/list.md @@ -100,6 +100,20 @@ List work items in an environment. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSelfHostedWork struct{…}` diff --git a/content/en/api/go/beta/environments/work/poll.md b/content/en/api/go/beta/environments/work/poll.md index 429ce81a5..c446d2ec9 100644 --- a/content/en/api/go/beta/environments/work/poll.md +++ b/content/en/api/go/beta/environments/work/poll.md @@ -102,6 +102,20 @@ Long poll for work items in the queue. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `AnthropicWorkerID param.Field[string] Optional` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console diff --git a/content/en/api/go/beta/environments/work/retrieve.md b/content/en/api/go/beta/environments/work/retrieve.md index 755bba88f..0e6f454b3 100644 --- a/content/en/api/go/beta/environments/work/retrieve.md +++ b/content/en/api/go/beta/environments/work/retrieve.md @@ -94,6 +94,20 @@ Retrieve detailed information about a specific work item. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSelfHostedWork struct{…}` diff --git a/content/en/api/go/beta/environments/work/stats.md b/content/en/api/go/beta/environments/work/stats.md index 3cf8dfc23..ed9f0a3cf 100644 --- a/content/en/api/go/beta/environments/work/stats.md +++ b/content/en/api/go/beta/environments/work/stats.md @@ -88,6 +88,20 @@ Get statistics about the work queue for an environment. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSelfHostedWorkQueueStats struct{…}` diff --git a/content/en/api/go/beta/environments/work/stop.md b/content/en/api/go/beta/environments/work/stop.md index 3e96aa412..f9a3d5b52 100644 --- a/content/en/api/go/beta/environments/work/stop.md +++ b/content/en/api/go/beta/environments/work/stop.md @@ -98,6 +98,20 @@ Stop a work item, initiating graceful or forced shutdown. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSelfHostedWork struct{…}` diff --git a/content/en/api/go/beta/environments/work/update.md b/content/en/api/go/beta/environments/work/update.md index a4c90d7e1..e8407b17c 100644 --- a/content/en/api/go/beta/environments/work/update.md +++ b/content/en/api/go/beta/environments/work/update.md @@ -98,6 +98,20 @@ Update work item metadata with merge semantics. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSelfHostedWork struct{…}` diff --git a/content/en/api/go/beta/files.md b/content/en/api/go/beta/files.md index 129456730..4077408e9 100644 --- a/content/en/api/go/beta/files.md +++ b/content/en/api/go/beta/files.md @@ -94,6 +94,20 @@ Upload File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaFileMetadata struct{…}` @@ -307,6 +321,20 @@ List Files - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaFileMetadata struct{…}` @@ -507,6 +535,20 @@ Download File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaFileDownloadResponse interface{…}` @@ -632,6 +674,20 @@ Get File Metadata - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaFileMetadata struct{…}` @@ -829,6 +885,20 @@ Delete File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaDeletedFile struct{…}` diff --git a/content/en/api/go/beta/files/delete.md b/content/en/api/go/beta/files/delete.md index dcf63a3eb..f8410ef86 100644 --- a/content/en/api/go/beta/files/delete.md +++ b/content/en/api/go/beta/files/delete.md @@ -90,6 +90,20 @@ Delete File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaDeletedFile struct{…}` diff --git a/content/en/api/go/beta/files/download.md b/content/en/api/go/beta/files/download.md index 1cdf99874..15d736d0a 100644 --- a/content/en/api/go/beta/files/download.md +++ b/content/en/api/go/beta/files/download.md @@ -90,6 +90,20 @@ Download File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaFileDownloadResponse interface{…}` diff --git a/content/en/api/go/beta/files/list.md b/content/en/api/go/beta/files/list.md index 6a8fbc684..852d26d6b 100644 --- a/content/en/api/go/beta/files/list.md +++ b/content/en/api/go/beta/files/list.md @@ -106,6 +106,20 @@ List Files - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaFileMetadata struct{…}` diff --git a/content/en/api/go/beta/files/retrieve_metadata.md b/content/en/api/go/beta/files/retrieve_metadata.md index d9ee3b694..cb0d0e92b 100644 --- a/content/en/api/go/beta/files/retrieve_metadata.md +++ b/content/en/api/go/beta/files/retrieve_metadata.md @@ -90,6 +90,20 @@ Get File Metadata - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaFileMetadata struct{…}` diff --git a/content/en/api/go/beta/files/upload.md b/content/en/api/go/beta/files/upload.md index 3e951e66b..057c1e282 100644 --- a/content/en/api/go/beta/files/upload.md +++ b/content/en/api/go/beta/files/upload.md @@ -92,6 +92,20 @@ Upload File - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaFileMetadata struct{…}` diff --git a/content/en/api/go/beta/memory_stores.md b/content/en/api/go/beta/memory_stores.md index 98c248c1c..80b2a91fb 100644 --- a/content/en/api/go/beta/memory_stores.md +++ b/content/en/api/go/beta/memory_stores.md @@ -104,6 +104,20 @@ Create a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -304,6 +318,20 @@ List memory stores - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -483,6 +511,20 @@ Retrieve a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -677,6 +719,20 @@ Update a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -855,6 +911,20 @@ Delete a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeletedMemoryStore struct{…}` @@ -995,6 +1065,20 @@ Archive a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryStore struct{…}` @@ -1245,6 +1329,20 @@ Create a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemory struct{…}` @@ -1277,7 +1375,7 @@ Create a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -1458,6 +1556,20 @@ List memories - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryListItemUnion interface{…}` @@ -1494,7 +1606,7 @@ List memories - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -1671,6 +1783,20 @@ Retrieve a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemory struct{…}` @@ -1703,7 +1829,7 @@ Retrieve a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -1881,6 +2007,20 @@ Update a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemory struct{…}` @@ -1913,7 +2053,7 @@ Update a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -2077,11 +2217,25 @@ Delete a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeletedMemory struct{…}` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `ID string` @@ -2267,11 +2421,25 @@ List memory versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -2285,7 +2453,7 @@ List memory versions - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` @@ -2541,11 +2709,25 @@ Retrieve a memory version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -2559,7 +2741,7 @@ Retrieve a memory version - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` @@ -2808,11 +2990,25 @@ Redact a memory version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -2826,7 +3022,7 @@ Redact a memory version - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` diff --git a/content/en/api/go/beta/memory_stores/archive.md b/content/en/api/go/beta/memory_stores/archive.md index f13e3e130..e0b78badd 100644 --- a/content/en/api/go/beta/memory_stores/archive.md +++ b/content/en/api/go/beta/memory_stores/archive.md @@ -88,6 +88,20 @@ Archive a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryStore struct{…}` diff --git a/content/en/api/go/beta/memory_stores/create.md b/content/en/api/go/beta/memory_stores/create.md index 91779dda6..bb5e87328 100644 --- a/content/en/api/go/beta/memory_stores/create.md +++ b/content/en/api/go/beta/memory_stores/create.md @@ -102,6 +102,20 @@ Create a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryStore struct{…}` diff --git a/content/en/api/go/beta/memory_stores/delete.md b/content/en/api/go/beta/memory_stores/delete.md index ab07080fb..ba672f0bc 100644 --- a/content/en/api/go/beta/memory_stores/delete.md +++ b/content/en/api/go/beta/memory_stores/delete.md @@ -88,6 +88,20 @@ Delete a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeletedMemoryStore struct{…}` diff --git a/content/en/api/go/beta/memory_stores/list.md b/content/en/api/go/beta/memory_stores/list.md index 0c930b84a..6279ffd15 100644 --- a/content/en/api/go/beta/memory_stores/list.md +++ b/content/en/api/go/beta/memory_stores/list.md @@ -112,6 +112,20 @@ List memory stores - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryStore struct{…}` diff --git a/content/en/api/go/beta/memory_stores/memories.md b/content/en/api/go/beta/memory_stores/memories.md index 19161f387..45f9f6fd9 100644 --- a/content/en/api/go/beta/memory_stores/memories.md +++ b/content/en/api/go/beta/memory_stores/memories.md @@ -104,6 +104,20 @@ Create a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemory struct{…}` @@ -136,7 +150,7 @@ Create a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -317,6 +331,20 @@ List memories - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryListItemUnion interface{…}` @@ -353,7 +381,7 @@ List memories - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -530,6 +558,20 @@ Retrieve a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemory struct{…}` @@ -562,7 +604,7 @@ Retrieve a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -740,6 +782,20 @@ Update a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemory struct{…}` @@ -772,7 +828,7 @@ Update a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -936,11 +992,25 @@ Delete a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeletedMemory struct{…}` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `ID string` @@ -1014,7 +1084,7 @@ func main() { - `type BetaManagedAgentsDeletedMemory struct{…}` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `ID string` @@ -1170,7 +1240,7 @@ func main() { - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` @@ -1224,7 +1294,7 @@ func main() { - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` diff --git a/content/en/api/go/beta/memory_stores/memories/create.md b/content/en/api/go/beta/memory_stores/memories/create.md index 7ca367b57..e17afc9a6 100644 --- a/content/en/api/go/beta/memory_stores/memories/create.md +++ b/content/en/api/go/beta/memory_stores/memories/create.md @@ -102,6 +102,20 @@ Create a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemory struct{…}` @@ -134,7 +148,7 @@ Create a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` diff --git a/content/en/api/go/beta/memory_stores/memories/delete.md b/content/en/api/go/beta/memory_stores/memories/delete.md index 61c8faf81..ff6d9d3e6 100644 --- a/content/en/api/go/beta/memory_stores/memories/delete.md +++ b/content/en/api/go/beta/memory_stores/memories/delete.md @@ -96,11 +96,25 @@ Delete a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeletedMemory struct{…}` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `ID string` diff --git a/content/en/api/go/beta/memory_stores/memories/list.md b/content/en/api/go/beta/memory_stores/memories/list.md index 0ace24842..e887b6701 100644 --- a/content/en/api/go/beta/memory_stores/memories/list.md +++ b/content/en/api/go/beta/memory_stores/memories/list.md @@ -112,6 +112,20 @@ List memories - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryListItemUnion interface{…}` @@ -148,7 +162,7 @@ List memories - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` diff --git a/content/en/api/go/beta/memory_stores/memories/retrieve.md b/content/en/api/go/beta/memory_stores/memories/retrieve.md index bf48ab59a..2c38109ee 100644 --- a/content/en/api/go/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/go/beta/memory_stores/memories/retrieve.md @@ -96,6 +96,20 @@ Retrieve a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemory struct{…}` @@ -128,7 +142,7 @@ Retrieve a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` diff --git a/content/en/api/go/beta/memory_stores/memories/update.md b/content/en/api/go/beta/memory_stores/memories/update.md index 977560dc7..c74d89836 100644 --- a/content/en/api/go/beta/memory_stores/memories/update.md +++ b/content/en/api/go/beta/memory_stores/memories/update.md @@ -110,6 +110,20 @@ Update a memory - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemory struct{…}` @@ -142,7 +156,7 @@ Update a memory - `MemoryVersionID string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `Path string` diff --git a/content/en/api/go/beta/memory_stores/memory_versions.md b/content/en/api/go/beta/memory_stores/memory_versions.md index 7893d4c54..d57390a47 100644 --- a/content/en/api/go/beta/memory_stores/memory_versions.md +++ b/content/en/api/go/beta/memory_stores/memory_versions.md @@ -136,11 +136,25 @@ List memory versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -154,7 +168,7 @@ List memory versions - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` @@ -410,11 +424,25 @@ Retrieve a memory version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -428,7 +456,7 @@ Retrieve a memory version - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` @@ -677,11 +705,25 @@ Redact a memory version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -695,7 +737,7 @@ Redact a memory version - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` @@ -924,7 +966,7 @@ func main() { - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -938,7 +980,7 @@ func main() { - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` diff --git a/content/en/api/go/beta/memory_stores/memory_versions/list.md b/content/en/api/go/beta/memory_stores/memory_versions/list.md index 7756c380c..739c47879 100644 --- a/content/en/api/go/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/go/beta/memory_stores/memory_versions/list.md @@ -134,11 +134,25 @@ List memory versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -152,7 +166,7 @@ List memory versions - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` diff --git a/content/en/api/go/beta/memory_stores/memory_versions/redact.md b/content/en/api/go/beta/memory_stores/memory_versions/redact.md index c58f67c7e..9298c9c11 100644 --- a/content/en/api/go/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/go/beta/memory_stores/memory_versions/redact.md @@ -92,11 +92,25 @@ Redact a memory version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -110,7 +124,7 @@ Redact a memory version - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` diff --git a/content/en/api/go/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/go/beta/memory_stores/memory_versions/retrieve.md index eb4886eda..dcf6fbcae 100644 --- a/content/en/api/go/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/go/beta/memory_stores/memory_versions/retrieve.md @@ -96,11 +96,25 @@ Retrieve a memory version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryVersion struct{…}` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `ID string` @@ -114,7 +128,7 @@ Retrieve a memory version - `MemoryID string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `MemoryStoreID string` diff --git a/content/en/api/go/beta/memory_stores/retrieve.md b/content/en/api/go/beta/memory_stores/retrieve.md index 239be7f34..f4aa5cdf6 100644 --- a/content/en/api/go/beta/memory_stores/retrieve.md +++ b/content/en/api/go/beta/memory_stores/retrieve.md @@ -88,6 +88,20 @@ Retrieve a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryStore struct{…}` diff --git a/content/en/api/go/beta/memory_stores/update.md b/content/en/api/go/beta/memory_stores/update.md index d52d911ca..396dd2ad8 100644 --- a/content/en/api/go/beta/memory_stores/update.md +++ b/content/en/api/go/beta/memory_stores/update.md @@ -104,6 +104,20 @@ Update a memory store - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsMemoryStore struct{…}` diff --git a/content/en/api/go/beta/messages.md b/content/en/api/go/beta/messages.md index 4d9c0d30d..f0c2a6dec 100644 --- a/content/en/api/go/beta/messages.md +++ b/content/en/api/go/beta/messages.md @@ -3553,6 +3553,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5018,12 +5032,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -5333,12 +5349,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `OutputTokens int64` The cumulative number of output tokens which were used. @@ -9074,6 +9092,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -17637,6 +17669,8 @@ func main() { - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` + - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` + - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` @@ -17653,6 +17687,8 @@ func main() { - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` + - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` + ### Beta Fallback Refusal Trigger - `type BetaFallbackRefusalTrigger struct{…}` @@ -17849,6 +17885,8 @@ func main() { - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` + - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` + - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` @@ -17865,6 +17903,8 @@ func main() { - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` + - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` + - `Default` ### Beta File Document Source @@ -18004,12 +18044,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -20268,12 +20310,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -20609,12 +20653,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -24131,12 +24177,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -25853,12 +25901,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -27529,12 +27579,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -27838,12 +27890,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `OutputTokens int64` The cumulative number of output tokens which were used. @@ -30100,6 +30154,8 @@ func main() { - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` + - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` + ### Beta Thinking Config Disabled - `type BetaThinkingConfigDisabled struct{…}` @@ -30130,6 +30186,8 @@ func main() { - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` + - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` + ### Beta Thinking Config Param - `type BetaThinkingConfigParamUnionResp interface{…}` @@ -30162,6 +30220,8 @@ func main() { - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` + - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` + - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` @@ -30178,6 +30238,8 @@ func main() { - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` + - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` + ### Beta Thinking Delta - `type BetaThinkingDelta struct{…}` @@ -34022,12 +34084,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -37899,6 +37963,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` + - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` + - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` @@ -37915,6 +37981,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` + - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` + - `Default` - `InferenceGeo string Optional` @@ -40082,6 +40150,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -40354,6 +40436,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaMessageBatch struct{…}` @@ -40622,6 +40718,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaMessageBatch struct{…}` @@ -40883,6 +40993,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaMessageBatch struct{…}` @@ -41141,6 +41265,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaDeletedMessageBatch struct{…}` @@ -41291,6 +41429,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaMessageBatchIndividualResponse struct{…}` @@ -42726,12 +42878,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. diff --git a/content/en/api/go/beta/messages/batches.md b/content/en/api/go/beta/messages/batches.md index e4352a20c..f5801666e 100644 --- a/content/en/api/go/beta/messages/batches.md +++ b/content/en/api/go/beta/messages/batches.md @@ -1714,6 +1714,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` + - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` + - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` @@ -1730,6 +1732,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` + - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` + - `Default` - `InferenceGeo string Optional` @@ -3897,6 +3901,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -4169,6 +4187,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaMessageBatch struct{…}` @@ -4437,6 +4469,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaMessageBatch struct{…}` @@ -4698,6 +4744,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaMessageBatch struct{…}` @@ -4956,6 +5016,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaDeletedMessageBatch struct{…}` @@ -5106,6 +5180,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaMessageBatchIndividualResponse struct{…}` @@ -6541,12 +6629,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -8625,12 +8715,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -10457,12 +10549,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -12241,12 +12335,14 @@ func main() { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. diff --git a/content/en/api/go/beta/messages/batches/cancel.md b/content/en/api/go/beta/messages/batches/cancel.md index 19f4bd20c..88e22ee73 100644 --- a/content/en/api/go/beta/messages/batches/cancel.md +++ b/content/en/api/go/beta/messages/batches/cancel.md @@ -94,6 +94,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaMessageBatch struct{…}` diff --git a/content/en/api/go/beta/messages/batches/create.md b/content/en/api/go/beta/messages/batches/create.md index db70ea4b9..08ed6dc05 100644 --- a/content/en/api/go/beta/messages/batches/create.md +++ b/content/en/api/go/beta/messages/batches/create.md @@ -1712,6 +1712,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` + - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` + - `type BetaThinkingConfigDisabled struct{…}` - `Type Disabled` @@ -1728,6 +1730,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` + - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` + - `Default` - `InferenceGeo string Optional` @@ -3895,6 +3899,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. diff --git a/content/en/api/go/beta/messages/batches/delete.md b/content/en/api/go/beta/messages/batches/delete.md index 4f6589a13..c3bbaa81e 100644 --- a/content/en/api/go/beta/messages/batches/delete.md +++ b/content/en/api/go/beta/messages/batches/delete.md @@ -94,6 +94,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaDeletedMessageBatch struct{…}` diff --git a/content/en/api/go/beta/messages/batches/list.md b/content/en/api/go/beta/messages/batches/list.md index c8cd420f6..7ada3e097 100644 --- a/content/en/api/go/beta/messages/batches/list.md +++ b/content/en/api/go/beta/messages/batches/list.md @@ -104,6 +104,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaMessageBatch struct{…}` diff --git a/content/en/api/go/beta/messages/batches/results.md b/content/en/api/go/beta/messages/batches/results.md index 61b50273a..0934729b1 100644 --- a/content/en/api/go/beta/messages/batches/results.md +++ b/content/en/api/go/beta/messages/batches/results.md @@ -94,6 +94,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaMessageBatchIndividualResponse struct{…}` @@ -1529,12 +1543,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. diff --git a/content/en/api/go/beta/messages/batches/retrieve.md b/content/en/api/go/beta/messages/batches/retrieve.md index ab490d788..227ce0e41 100644 --- a/content/en/api/go/beta/messages/batches/retrieve.md +++ b/content/en/api/go/beta/messages/batches/retrieve.md @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaMessageBatch struct{…}` diff --git a/content/en/api/go/beta/messages/count_tokens.md b/content/en/api/go/beta/messages/count_tokens.md index 7cec31b4e..39d175e0a 100644 --- a/content/en/api/go/beta/messages/count_tokens.md +++ b/content/en/api/go/beta/messages/count_tokens.md @@ -3417,6 +3417,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. diff --git a/content/en/api/go/beta/messages/create.md b/content/en/api/go/beta/messages/create.md index e7e7ab1bb..649a9129a 100644 --- a/content/en/api/go/beta/messages/create.md +++ b/content/en/api/go/beta/messages/create.md @@ -3551,6 +3551,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `UserProfileID param.Field[string] Optional` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5016,12 +5030,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `type BetaMessageIterationUsage struct{…}` Token usage for a sampling iteration. @@ -5331,12 +5347,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `OutputTokens int64` The cumulative number of output tokens which were used. diff --git a/content/en/api/go/beta/models.md b/content/en/api/go/beta/models.md index 7a90321d1..853eca9c0 100644 --- a/content/en/api/go/beta/models.md +++ b/content/en/api/go/beta/models.md @@ -106,6 +106,20 @@ The Models API response can be used to determine which models are available for - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaModelInfo struct{…}` @@ -447,6 +461,20 @@ The Models API response can be used to determine information about a specific mo - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaModelInfo struct{…}` diff --git a/content/en/api/go/beta/models/list.md b/content/en/api/go/beta/models/list.md index c3f1b786a..5b63f4ab2 100644 --- a/content/en/api/go/beta/models/list.md +++ b/content/en/api/go/beta/models/list.md @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaModelInfo struct{…}` diff --git a/content/en/api/go/beta/models/retrieve.md b/content/en/api/go/beta/models/retrieve.md index 3226d08d4..3f661f6d7 100644 --- a/content/en/api/go/beta/models/retrieve.md +++ b/content/en/api/go/beta/models/retrieve.md @@ -92,6 +92,20 @@ The Models API response can be used to determine information about a specific mo - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaModelInfo struct{…}` diff --git a/content/en/api/go/beta/sessions.md b/content/en/api/go/beta/sessions.md index c1272c522..50a3adf2a 100644 --- a/content/en/api/go/beta/sessions.md +++ b/content/en/api/go/beta/sessions.md @@ -1030,6 +1030,20 @@ Create Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSession struct{…}` @@ -2252,6 +2266,20 @@ List Sessions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSession struct{…}` @@ -3401,6 +3429,20 @@ Get Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSession struct{…}` @@ -4570,6 +4612,20 @@ Update Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSession struct{…}` @@ -5717,6 +5773,20 @@ Delete Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeletedSession struct{…}` @@ -5855,6 +5925,20 @@ Archive Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSession struct{…}` @@ -11494,6 +11578,20 @@ List Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` @@ -14135,6 +14233,20 @@ Send Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSendSessionEvents struct{…}` @@ -14740,6 +14852,20 @@ Stream Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsStreamSessionEventsUnion interface{…}` @@ -17068,6 +17194,20 @@ Add Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsFileResource struct{…}` @@ -17239,6 +17379,20 @@ List Session Resources - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionResourceUnion interface{…}` @@ -17500,6 +17654,20 @@ Get Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSessionResourceGetResponseUnion interface{…}` @@ -17756,6 +17924,20 @@ Update Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSessionResourceUpdateResponseUnion interface{…}` @@ -18007,6 +18189,20 @@ Delete Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeleteSessionResource struct{…}` @@ -18159,6 +18355,20 @@ List Session Threads - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -18171,7 +18381,7 @@ List Session Threads - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -19008,6 +19218,20 @@ Get Session Thread - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -19020,7 +19244,7 @@ Get Session Thread - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -19854,6 +20078,20 @@ Archive Session Thread - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -19866,7 +20104,7 @@ Archive Session Thread - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -20712,6 +20950,20 @@ List Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` @@ -22994,6 +23246,20 @@ Stream Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsStreamSessionThreadEventsUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/archive.md b/content/en/api/go/beta/sessions/archive.md index f867f5b32..e6c4459c0 100644 --- a/content/en/api/go/beta/sessions/archive.md +++ b/content/en/api/go/beta/sessions/archive.md @@ -88,6 +88,20 @@ Archive Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSession struct{…}` diff --git a/content/en/api/go/beta/sessions/create.md b/content/en/api/go/beta/sessions/create.md index 9529da1ce..41b488fdc 100644 --- a/content/en/api/go/beta/sessions/create.md +++ b/content/en/api/go/beta/sessions/create.md @@ -1028,6 +1028,20 @@ Create Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSession struct{…}` diff --git a/content/en/api/go/beta/sessions/delete.md b/content/en/api/go/beta/sessions/delete.md index 99f1ac73b..fb077b4bc 100644 --- a/content/en/api/go/beta/sessions/delete.md +++ b/content/en/api/go/beta/sessions/delete.md @@ -88,6 +88,20 @@ Delete Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeletedSession struct{…}` diff --git a/content/en/api/go/beta/sessions/events.md b/content/en/api/go/beta/sessions/events.md index d597e44f4..25124f472 100644 --- a/content/en/api/go/beta/sessions/events.md +++ b/content/en/api/go/beta/sessions/events.md @@ -136,6 +136,20 @@ List Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` @@ -2777,6 +2791,20 @@ Send Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSendSessionEvents struct{…}` @@ -3382,6 +3410,20 @@ Stream Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsStreamSessionEventsUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/events/list.md b/content/en/api/go/beta/sessions/events/list.md index 17741042d..e42dfaf95 100644 --- a/content/en/api/go/beta/sessions/events/list.md +++ b/content/en/api/go/beta/sessions/events/list.md @@ -134,6 +134,20 @@ List Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/events/send.md b/content/en/api/go/beta/sessions/events/send.md index b1281a28e..69aa30653 100644 --- a/content/en/api/go/beta/sessions/events/send.md +++ b/content/en/api/go/beta/sessions/events/send.md @@ -450,6 +450,20 @@ Send Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSendSessionEvents struct{…}` diff --git a/content/en/api/go/beta/sessions/events/stream.md b/content/en/api/go/beta/sessions/events/stream.md index 72abe3102..29900bccb 100644 --- a/content/en/api/go/beta/sessions/events/stream.md +++ b/content/en/api/go/beta/sessions/events/stream.md @@ -96,6 +96,20 @@ Stream Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsStreamSessionEventsUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/list.md b/content/en/api/go/beta/sessions/list.md index 2067ee39a..b70ae7fce 100644 --- a/content/en/api/go/beta/sessions/list.md +++ b/content/en/api/go/beta/sessions/list.md @@ -162,6 +162,20 @@ List Sessions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSession struct{…}` diff --git a/content/en/api/go/beta/sessions/resources.md b/content/en/api/go/beta/sessions/resources.md index 4d206cb0f..400ac1bc3 100644 --- a/content/en/api/go/beta/sessions/resources.md +++ b/content/en/api/go/beta/sessions/resources.md @@ -94,6 +94,20 @@ Add Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsFileResource struct{…}` @@ -265,6 +279,20 @@ List Session Resources - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSessionResourceUnion interface{…}` @@ -526,6 +554,20 @@ Get Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSessionResourceGetResponseUnion interface{…}` @@ -782,6 +824,20 @@ Update Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSessionResourceUpdateResponseUnion interface{…}` @@ -1033,6 +1089,20 @@ Delete Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeleteSessionResource struct{…}` diff --git a/content/en/api/go/beta/sessions/resources/add.md b/content/en/api/go/beta/sessions/resources/add.md index 240560b66..d17588f1b 100644 --- a/content/en/api/go/beta/sessions/resources/add.md +++ b/content/en/api/go/beta/sessions/resources/add.md @@ -92,6 +92,20 @@ Add Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsFileResource struct{…}` diff --git a/content/en/api/go/beta/sessions/resources/delete.md b/content/en/api/go/beta/sessions/resources/delete.md index 304bf71ad..b40cd5e01 100644 --- a/content/en/api/go/beta/sessions/resources/delete.md +++ b/content/en/api/go/beta/sessions/resources/delete.md @@ -92,6 +92,20 @@ Delete Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeleteSessionResource struct{…}` diff --git a/content/en/api/go/beta/sessions/resources/list.md b/content/en/api/go/beta/sessions/resources/list.md index 324a63932..e6996ac92 100644 --- a/content/en/api/go/beta/sessions/resources/list.md +++ b/content/en/api/go/beta/sessions/resources/list.md @@ -98,6 +98,20 @@ List Session Resources - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSessionResourceUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/resources/retrieve.md b/content/en/api/go/beta/sessions/resources/retrieve.md index f66245362..fd9f25775 100644 --- a/content/en/api/go/beta/sessions/resources/retrieve.md +++ b/content/en/api/go/beta/sessions/resources/retrieve.md @@ -92,6 +92,20 @@ Get Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSessionResourceGetResponseUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/resources/update.md b/content/en/api/go/beta/sessions/resources/update.md index a421f64c2..42f07de21 100644 --- a/content/en/api/go/beta/sessions/resources/update.md +++ b/content/en/api/go/beta/sessions/resources/update.md @@ -98,6 +98,20 @@ Update Session Resource - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSessionResourceUpdateResponseUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/retrieve.md b/content/en/api/go/beta/sessions/retrieve.md index ae33cc3c8..b23084a4a 100644 --- a/content/en/api/go/beta/sessions/retrieve.md +++ b/content/en/api/go/beta/sessions/retrieve.md @@ -88,6 +88,20 @@ Get Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSession struct{…}` diff --git a/content/en/api/go/beta/sessions/threads.md b/content/en/api/go/beta/sessions/threads.md index 962ced73b..5d4f89c91 100644 --- a/content/en/api/go/beta/sessions/threads.md +++ b/content/en/api/go/beta/sessions/threads.md @@ -100,6 +100,20 @@ List Session Threads - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -112,7 +126,7 @@ List Session Threads - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -949,6 +963,20 @@ Get Session Thread - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -961,7 +989,7 @@ Get Session Thread - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -1795,6 +1823,20 @@ Archive Session Thread - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -1807,7 +1849,7 @@ Archive Session Thread - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -2561,7 +2603,7 @@ func main() { - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` @@ -5579,6 +5621,20 @@ List Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` @@ -7861,6 +7917,20 @@ Stream Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsStreamSessionThreadEventsUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/threads/archive.md b/content/en/api/go/beta/sessions/threads/archive.md index 5a7b27f7e..72eb946d2 100644 --- a/content/en/api/go/beta/sessions/threads/archive.md +++ b/content/en/api/go/beta/sessions/threads/archive.md @@ -92,6 +92,20 @@ Archive Session Thread - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -104,7 +118,7 @@ Archive Session Thread - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` diff --git a/content/en/api/go/beta/sessions/threads/events.md b/content/en/api/go/beta/sessions/threads/events.md index 191f725c1..162aa85e7 100644 --- a/content/en/api/go/beta/sessions/threads/events.md +++ b/content/en/api/go/beta/sessions/threads/events.md @@ -104,6 +104,20 @@ List Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` @@ -2386,6 +2400,20 @@ Stream Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsStreamSessionThreadEventsUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/threads/events/list.md b/content/en/api/go/beta/sessions/threads/events/list.md index 9dd492cba..5c0b6f8bd 100644 --- a/content/en/api/go/beta/sessions/threads/events/list.md +++ b/content/en/api/go/beta/sessions/threads/events/list.md @@ -102,6 +102,20 @@ List Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSessionEventUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/threads/events/stream.md b/content/en/api/go/beta/sessions/threads/events/stream.md index 7aa69ff00..72efc53f1 100644 --- a/content/en/api/go/beta/sessions/threads/events/stream.md +++ b/content/en/api/go/beta/sessions/threads/events/stream.md @@ -100,6 +100,20 @@ Stream Session Thread Events - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsStreamSessionThreadEventsUnion interface{…}` diff --git a/content/en/api/go/beta/sessions/threads/list.md b/content/en/api/go/beta/sessions/threads/list.md index a93accc95..5c87d9c6e 100644 --- a/content/en/api/go/beta/sessions/threads/list.md +++ b/content/en/api/go/beta/sessions/threads/list.md @@ -98,6 +98,20 @@ List Session Threads - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -110,7 +124,7 @@ List Session Threads - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` diff --git a/content/en/api/go/beta/sessions/threads/retrieve.md b/content/en/api/go/beta/sessions/threads/retrieve.md index 2fbcaeb91..2b40c577e 100644 --- a/content/en/api/go/beta/sessions/threads/retrieve.md +++ b/content/en/api/go/beta/sessions/threads/retrieve.md @@ -92,6 +92,20 @@ Get Session Thread - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSessionThread struct{…}` @@ -104,7 +118,7 @@ Get Session Thread - `Agent BetaManagedAgentsSessionThreadAgentUnion` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `type BetaManagedAgentsSessionThreadAgent struct{…}` diff --git a/content/en/api/go/beta/sessions/update.md b/content/en/api/go/beta/sessions/update.md index 58d6b5d89..7496bc9c4 100644 --- a/content/en/api/go/beta/sessions/update.md +++ b/content/en/api/go/beta/sessions/update.md @@ -110,6 +110,20 @@ Update Session - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsSession struct{…}` diff --git a/content/en/api/go/beta/skills.md b/content/en/api/go/beta/skills.md index ae156b713..1ca3ee352 100644 --- a/content/en/api/go/beta/skills.md +++ b/content/en/api/go/beta/skills.md @@ -100,6 +100,20 @@ Create Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillNewResponse struct{…}` @@ -299,6 +313,20 @@ List Skills - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillListResponse struct{…}` @@ -485,6 +513,20 @@ Get Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillGetResponse struct{…}` @@ -669,6 +711,20 @@ Delete Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillDeleteResponse struct{…}` @@ -827,6 +883,20 @@ Create Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionNewResponse struct{…}` @@ -1029,6 +1099,20 @@ List Skill Versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionListResponse struct{…}` @@ -1229,6 +1313,20 @@ Download a skill version's content as a zip archive. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionDownloadResponse interface{…}` @@ -1364,6 +1462,20 @@ Get Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionGetResponse struct{…}` @@ -1560,6 +1672,20 @@ Delete Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaSkillVersionDeleteResponse struct{…}` diff --git a/content/en/api/go/beta/skills/create.md b/content/en/api/go/beta/skills/create.md index fc51e011a..256573d5d 100644 --- a/content/en/api/go/beta/skills/create.md +++ b/content/en/api/go/beta/skills/create.md @@ -98,6 +98,20 @@ Create Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillNewResponse struct{…}` diff --git a/content/en/api/go/beta/skills/delete.md b/content/en/api/go/beta/skills/delete.md index b9c4eed0f..57cdbede6 100644 --- a/content/en/api/go/beta/skills/delete.md +++ b/content/en/api/go/beta/skills/delete.md @@ -92,6 +92,20 @@ Delete Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillDeleteResponse struct{…}` diff --git a/content/en/api/go/beta/skills/list.md b/content/en/api/go/beta/skills/list.md index c9ddea7de..9966a3bf2 100644 --- a/content/en/api/go/beta/skills/list.md +++ b/content/en/api/go/beta/skills/list.md @@ -107,6 +107,20 @@ List Skills - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillListResponse struct{…}` diff --git a/content/en/api/go/beta/skills/retrieve.md b/content/en/api/go/beta/skills/retrieve.md index f7991d6ff..0137ab141 100644 --- a/content/en/api/go/beta/skills/retrieve.md +++ b/content/en/api/go/beta/skills/retrieve.md @@ -92,6 +92,20 @@ Get Skill - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillGetResponse struct{…}` diff --git a/content/en/api/go/beta/skills/versions.md b/content/en/api/go/beta/skills/versions.md index 8b068adce..d820f808a 100644 --- a/content/en/api/go/beta/skills/versions.md +++ b/content/en/api/go/beta/skills/versions.md @@ -100,6 +100,20 @@ Create Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillVersionNewResponse struct{…}` @@ -302,6 +316,20 @@ List Skill Versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillVersionListResponse struct{…}` @@ -502,6 +530,20 @@ Download a skill version's content as a zip archive. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillVersionDownloadResponse interface{…}` @@ -637,6 +679,20 @@ Get Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillVersionGetResponse struct{…}` @@ -833,6 +889,20 @@ Delete Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaSkillVersionDeleteResponse struct{…}` diff --git a/content/en/api/go/beta/skills/versions/create.md b/content/en/api/go/beta/skills/versions/create.md index eef4fd747..a76919ae9 100644 --- a/content/en/api/go/beta/skills/versions/create.md +++ b/content/en/api/go/beta/skills/versions/create.md @@ -98,6 +98,20 @@ Create Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillVersionNewResponse struct{…}` diff --git a/content/en/api/go/beta/skills/versions/delete.md b/content/en/api/go/beta/skills/versions/delete.md index a70f85583..667384232 100644 --- a/content/en/api/go/beta/skills/versions/delete.md +++ b/content/en/api/go/beta/skills/versions/delete.md @@ -98,6 +98,20 @@ Delete Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillVersionDeleteResponse struct{…}` diff --git a/content/en/api/go/beta/skills/versions/download.md b/content/en/api/go/beta/skills/versions/download.md index 399a547e4..76f117a98 100644 --- a/content/en/api/go/beta/skills/versions/download.md +++ b/content/en/api/go/beta/skills/versions/download.md @@ -98,6 +98,20 @@ Download a skill version's content as a zip archive. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillVersionDownloadResponse interface{…}` diff --git a/content/en/api/go/beta/skills/versions/list.md b/content/en/api/go/beta/skills/versions/list.md index 6edd7aae6..0d3bfe972 100644 --- a/content/en/api/go/beta/skills/versions/list.md +++ b/content/en/api/go/beta/skills/versions/list.md @@ -102,6 +102,20 @@ List Skill Versions - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillVersionListResponse struct{…}` diff --git a/content/en/api/go/beta/skills/versions/retrieve.md b/content/en/api/go/beta/skills/versions/retrieve.md index bfa6686a6..79b21e9d6 100644 --- a/content/en/api/go/beta/skills/versions/retrieve.md +++ b/content/en/api/go/beta/skills/versions/retrieve.md @@ -98,6 +98,20 @@ Get Skill Version - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaSkillVersionGetResponse struct{…}` diff --git a/content/en/api/go/beta/tunnels.md b/content/en/api/go/beta/tunnels.md index bbbc664ed..2cd9ffe41 100644 --- a/content/en/api/go/beta/tunnels.md +++ b/content/en/api/go/beta/tunnels.md @@ -96,6 +96,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnel struct{…}` @@ -258,6 +272,20 @@ Fetches a tunnel by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnel struct{…}` @@ -436,6 +464,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnel struct{…}` @@ -603,6 +645,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnel struct{…}` @@ -769,6 +825,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnelToken struct{…}` @@ -922,6 +992,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnelToken struct{…}` @@ -1045,7 +1129,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `params BetaTunnelCertificateNewParams` - - `CaCertificatePem param.Field[string]` + - `CACertificatePEM param.Field[string]` Body param: PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -1127,6 +1211,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnelCertificate struct{…}` @@ -1186,7 +1284,7 @@ func main() { context.TODO(), "tunnel_id", anthropic.BetaTunnelCertificateNewParams{ - CaCertificatePem: "ca_certificate_pem", + CACertificatePEM: "ca_certificate_pem", }, ) if err != nil { @@ -1306,6 +1404,20 @@ Fetches a tunnel certificate by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnelCertificate struct{…}` @@ -1495,6 +1607,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnelCertificate struct{…}` @@ -1677,6 +1803,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaTunnelCertificate struct{…}` diff --git a/content/en/api/go/beta/tunnels/archive.md b/content/en/api/go/beta/tunnels/archive.md index bcc6c3a27..631fcbe85 100644 --- a/content/en/api/go/beta/tunnels/archive.md +++ b/content/en/api/go/beta/tunnels/archive.md @@ -90,6 +90,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnel struct{…}` diff --git a/content/en/api/go/beta/tunnels/certificates.md b/content/en/api/go/beta/tunnels/certificates.md index aa4ec9f21..5ebcb8452 100644 --- a/content/en/api/go/beta/tunnels/certificates.md +++ b/content/en/api/go/beta/tunnels/certificates.md @@ -16,7 +16,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `params BetaTunnelCertificateNewParams` - - `CaCertificatePem param.Field[string]` + - `CACertificatePEM param.Field[string]` Body param: PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -98,6 +98,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnelCertificate struct{…}` @@ -157,7 +171,7 @@ func main() { context.TODO(), "tunnel_id", anthropic.BetaTunnelCertificateNewParams{ - CaCertificatePem: "ca_certificate_pem", + CACertificatePEM: "ca_certificate_pem", }, ) if err != nil { @@ -277,6 +291,20 @@ Fetches a tunnel certificate by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnelCertificate struct{…}` @@ -466,6 +494,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnelCertificate struct{…}` @@ -648,6 +690,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaTunnelCertificate struct{…}` diff --git a/content/en/api/go/beta/tunnels/certificates/archive.md b/content/en/api/go/beta/tunnels/certificates/archive.md index 8dedee801..b5a973df2 100644 --- a/content/en/api/go/beta/tunnels/certificates/archive.md +++ b/content/en/api/go/beta/tunnels/certificates/archive.md @@ -94,6 +94,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnelCertificate struct{…}` diff --git a/content/en/api/go/beta/tunnels/certificates/create.md b/content/en/api/go/beta/tunnels/certificates/create.md index 3a0106fa7..c6ecfde1c 100644 --- a/content/en/api/go/beta/tunnels/certificates/create.md +++ b/content/en/api/go/beta/tunnels/certificates/create.md @@ -14,7 +14,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `params BetaTunnelCertificateNewParams` - - `CaCertificatePem param.Field[string]` + - `CACertificatePEM param.Field[string]` Body param: PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -96,6 +96,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnelCertificate struct{…}` @@ -155,7 +169,7 @@ func main() { context.TODO(), "tunnel_id", anthropic.BetaTunnelCertificateNewParams{ - CaCertificatePem: "ca_certificate_pem", + CACertificatePEM: "ca_certificate_pem", }, ) if err != nil { diff --git a/content/en/api/go/beta/tunnels/certificates/list.md b/content/en/api/go/beta/tunnels/certificates/list.md index 1a9f78c30..13f613d37 100644 --- a/content/en/api/go/beta/tunnels/certificates/list.md +++ b/content/en/api/go/beta/tunnels/certificates/list.md @@ -104,6 +104,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnelCertificate struct{…}` diff --git a/content/en/api/go/beta/tunnels/certificates/retrieve.md b/content/en/api/go/beta/tunnels/certificates/retrieve.md index c75b567cb..efb45ee46 100644 --- a/content/en/api/go/beta/tunnels/certificates/retrieve.md +++ b/content/en/api/go/beta/tunnels/certificates/retrieve.md @@ -94,6 +94,20 @@ Fetches a tunnel certificate by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnelCertificate struct{…}` diff --git a/content/en/api/go/beta/tunnels/create.md b/content/en/api/go/beta/tunnels/create.md index 1e8225ed1..1b574534e 100644 --- a/content/en/api/go/beta/tunnels/create.md +++ b/content/en/api/go/beta/tunnels/create.md @@ -94,6 +94,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnel struct{…}` diff --git a/content/en/api/go/beta/tunnels/list.md b/content/en/api/go/beta/tunnels/list.md index 7a67f1a2a..7167f5a06 100644 --- a/content/en/api/go/beta/tunnels/list.md +++ b/content/en/api/go/beta/tunnels/list.md @@ -102,6 +102,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnel struct{…}` diff --git a/content/en/api/go/beta/tunnels/retrieve.md b/content/en/api/go/beta/tunnels/retrieve.md index 96c848107..4190a21f7 100644 --- a/content/en/api/go/beta/tunnels/retrieve.md +++ b/content/en/api/go/beta/tunnels/retrieve.md @@ -90,6 +90,20 @@ Fetches a tunnel by ID. - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnel struct{…}` diff --git a/content/en/api/go/beta/tunnels/reveal_token.md b/content/en/api/go/beta/tunnels/reveal_token.md index 769fc2dde..dbb039a22 100644 --- a/content/en/api/go/beta/tunnels/reveal_token.md +++ b/content/en/api/go/beta/tunnels/reveal_token.md @@ -90,6 +90,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnelToken struct{…}` diff --git a/content/en/api/go/beta/tunnels/rotate_token.md b/content/en/api/go/beta/tunnels/rotate_token.md index 644d084c9..8a267f99b 100644 --- a/content/en/api/go/beta/tunnels/rotate_token.md +++ b/content/en/api/go/beta/tunnels/rotate_token.md @@ -96,6 +96,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaTunnelToken struct{…}` diff --git a/content/en/api/go/beta/user_profiles.md b/content/en/api/go/beta/user_profiles.md index d5e525d70..304cda085 100644 --- a/content/en/api/go/beta/user_profiles.md +++ b/content/en/api/go/beta/user_profiles.md @@ -122,6 +122,20 @@ Create User Profile - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaUserProfile struct{…}` @@ -342,6 +356,20 @@ List User Profiles - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaUserProfile struct{…}` @@ -551,6 +579,20 @@ Get User Profile - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaUserProfile struct{…}` @@ -793,6 +835,20 @@ Update User Profile - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaUserProfile struct{…}` @@ -1001,6 +1057,20 @@ Create Enrollment URL - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaUserProfileEnrollmentURL struct{…}` diff --git a/content/en/api/go/beta/user_profiles/create.md b/content/en/api/go/beta/user_profiles/create.md index f606686e5..ba502b9c4 100644 --- a/content/en/api/go/beta/user_profiles/create.md +++ b/content/en/api/go/beta/user_profiles/create.md @@ -120,6 +120,20 @@ Create User Profile - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaUserProfile struct{…}` diff --git a/content/en/api/go/beta/user_profiles/create_enrollment_url.md b/content/en/api/go/beta/user_profiles/create_enrollment_url.md index 45690711e..0109ba884 100644 --- a/content/en/api/go/beta/user_profiles/create_enrollment_url.md +++ b/content/en/api/go/beta/user_profiles/create_enrollment_url.md @@ -88,6 +88,20 @@ Create Enrollment URL - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaUserProfileEnrollmentURL struct{…}` diff --git a/content/en/api/go/beta/user_profiles/list.md b/content/en/api/go/beta/user_profiles/list.md index d26f9e70c..e0638a470 100644 --- a/content/en/api/go/beta/user_profiles/list.md +++ b/content/en/api/go/beta/user_profiles/list.md @@ -104,6 +104,20 @@ List User Profiles - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaUserProfile struct{…}` diff --git a/content/en/api/go/beta/user_profiles/retrieve.md b/content/en/api/go/beta/user_profiles/retrieve.md index f7e92ba38..d445df3a4 100644 --- a/content/en/api/go/beta/user_profiles/retrieve.md +++ b/content/en/api/go/beta/user_profiles/retrieve.md @@ -88,6 +88,20 @@ Get User Profile - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaUserProfile struct{…}` diff --git a/content/en/api/go/beta/user_profiles/update.md b/content/en/api/go/beta/user_profiles/update.md index 6c2605fd9..585e51035 100644 --- a/content/en/api/go/beta/user_profiles/update.md +++ b/content/en/api/go/beta/user_profiles/update.md @@ -122,6 +122,20 @@ Update User Profile - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaUserProfile struct{…}` diff --git a/content/en/api/go/beta/vaults.md b/content/en/api/go/beta/vaults.md index 7c10ea21a..cf58c90e7 100644 --- a/content/en/api/go/beta/vaults.md +++ b/content/en/api/go/beta/vaults.md @@ -98,6 +98,20 @@ Create Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsVault struct{…}` @@ -281,6 +295,20 @@ List Vaults - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsVault struct{…}` @@ -455,6 +483,20 @@ Get Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsVault struct{…}` @@ -638,6 +680,20 @@ Update Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsVault struct{…}` @@ -811,6 +867,20 @@ Delete Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeletedVault struct{…}` @@ -951,6 +1021,20 @@ Archive Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsVault struct{…}` @@ -1352,6 +1436,20 @@ Create Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -1670,6 +1768,20 @@ List Credentials - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -1975,6 +2087,20 @@ Get Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -2409,6 +2535,20 @@ Update Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -2711,6 +2851,20 @@ Delete Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsDeletedCredential struct{…}` @@ -2857,6 +3011,20 @@ Archive Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -3159,6 +3327,20 @@ Validate Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + #### Returns - `type BetaManagedAgentsCredentialValidation struct{…}` diff --git a/content/en/api/go/beta/vaults/archive.md b/content/en/api/go/beta/vaults/archive.md index e515c075c..fd5102b04 100644 --- a/content/en/api/go/beta/vaults/archive.md +++ b/content/en/api/go/beta/vaults/archive.md @@ -88,6 +88,20 @@ Archive Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsVault struct{…}` diff --git a/content/en/api/go/beta/vaults/create.md b/content/en/api/go/beta/vaults/create.md index 9fcface00..a21d41b7e 100644 --- a/content/en/api/go/beta/vaults/create.md +++ b/content/en/api/go/beta/vaults/create.md @@ -96,6 +96,20 @@ Create Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsVault struct{…}` diff --git a/content/en/api/go/beta/vaults/credentials.md b/content/en/api/go/beta/vaults/credentials.md index df29ad9af..8c45f0ecf 100644 --- a/content/en/api/go/beta/vaults/credentials.md +++ b/content/en/api/go/beta/vaults/credentials.md @@ -264,6 +264,20 @@ Create Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -582,6 +596,20 @@ List Credentials - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -887,6 +915,20 @@ Get Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -1321,6 +1363,20 @@ Update Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -1623,6 +1679,20 @@ Delete Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsDeletedCredential struct{…}` @@ -1769,6 +1839,20 @@ Archive Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsCredential struct{…}` @@ -2071,6 +2155,20 @@ Validate Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type BetaManagedAgentsCredentialValidation struct{…}` diff --git a/content/en/api/go/beta/vaults/credentials/archive.md b/content/en/api/go/beta/vaults/credentials/archive.md index dbf0cfe74..866ea53a5 100644 --- a/content/en/api/go/beta/vaults/credentials/archive.md +++ b/content/en/api/go/beta/vaults/credentials/archive.md @@ -92,6 +92,20 @@ Archive Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsCredential struct{…}` diff --git a/content/en/api/go/beta/vaults/credentials/create.md b/content/en/api/go/beta/vaults/credentials/create.md index 432a9ee7e..f7f05efc4 100644 --- a/content/en/api/go/beta/vaults/credentials/create.md +++ b/content/en/api/go/beta/vaults/credentials/create.md @@ -262,6 +262,20 @@ Create Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsCredential struct{…}` diff --git a/content/en/api/go/beta/vaults/credentials/delete.md b/content/en/api/go/beta/vaults/credentials/delete.md index 94a45ddba..82768eb08 100644 --- a/content/en/api/go/beta/vaults/credentials/delete.md +++ b/content/en/api/go/beta/vaults/credentials/delete.md @@ -92,6 +92,20 @@ Delete Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeletedCredential struct{…}` diff --git a/content/en/api/go/beta/vaults/credentials/list.md b/content/en/api/go/beta/vaults/credentials/list.md index 867a00719..ad531a75e 100644 --- a/content/en/api/go/beta/vaults/credentials/list.md +++ b/content/en/api/go/beta/vaults/credentials/list.md @@ -102,6 +102,20 @@ List Credentials - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsCredential struct{…}` diff --git a/content/en/api/go/beta/vaults/credentials/mcp_oauth_validate.md b/content/en/api/go/beta/vaults/credentials/mcp_oauth_validate.md index ee1c340ae..0522aa650 100644 --- a/content/en/api/go/beta/vaults/credentials/mcp_oauth_validate.md +++ b/content/en/api/go/beta/vaults/credentials/mcp_oauth_validate.md @@ -92,6 +92,20 @@ Validate Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsCredentialValidation struct{…}` diff --git a/content/en/api/go/beta/vaults/credentials/retrieve.md b/content/en/api/go/beta/vaults/credentials/retrieve.md index 682f78239..aad5f104a 100644 --- a/content/en/api/go/beta/vaults/credentials/retrieve.md +++ b/content/en/api/go/beta/vaults/credentials/retrieve.md @@ -92,6 +92,20 @@ Get Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsCredential struct{…}` diff --git a/content/en/api/go/beta/vaults/credentials/update.md b/content/en/api/go/beta/vaults/credentials/update.md index 5d804b893..63c8d7928 100644 --- a/content/en/api/go/beta/vaults/credentials/update.md +++ b/content/en/api/go/beta/vaults/credentials/update.md @@ -224,6 +224,20 @@ Update Credential - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsCredential struct{…}` diff --git a/content/en/api/go/beta/vaults/delete.md b/content/en/api/go/beta/vaults/delete.md index 35ddbc2bb..c429e1f66 100644 --- a/content/en/api/go/beta/vaults/delete.md +++ b/content/en/api/go/beta/vaults/delete.md @@ -88,6 +88,20 @@ Delete Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsDeletedVault struct{…}` diff --git a/content/en/api/go/beta/vaults/list.md b/content/en/api/go/beta/vaults/list.md index 3982a5f7d..03e7f8eca 100644 --- a/content/en/api/go/beta/vaults/list.md +++ b/content/en/api/go/beta/vaults/list.md @@ -100,6 +100,20 @@ List Vaults - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsVault struct{…}` diff --git a/content/en/api/go/beta/vaults/retrieve.md b/content/en/api/go/beta/vaults/retrieve.md index ee85eff19..8662b7440 100644 --- a/content/en/api/go/beta/vaults/retrieve.md +++ b/content/en/api/go/beta/vaults/retrieve.md @@ -88,6 +88,20 @@ Get Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsVault struct{…}` diff --git a/content/en/api/go/beta/vaults/update.md b/content/en/api/go/beta/vaults/update.md index 94a440638..7f78addbc 100644 --- a/content/en/api/go/beta/vaults/update.md +++ b/content/en/api/go/beta/vaults/update.md @@ -98,6 +98,20 @@ Update Vault - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type BetaManagedAgentsVault struct{…}` diff --git a/content/en/api/go/completions.md b/content/en/api/go/completions.md index 67428925e..162d4720d 100644 --- a/content/en/api/go/completions.md +++ b/content/en/api/go/completions.md @@ -140,6 +140,20 @@ Future models and features will not be compatible with Text Completions. See our - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `Temperature param.Field[float64] Optional` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error. diff --git a/content/en/api/go/completions/create.md b/content/en/api/go/completions/create.md index 91ffc6098..6a7849025 100644 --- a/content/en/api/go/completions/create.md +++ b/content/en/api/go/completions/create.md @@ -138,6 +138,20 @@ Future models and features will not be compatible with Text Completions. See our - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + - `Temperature param.Field[float64] Optional` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error. diff --git a/content/en/api/go/models.md b/content/en/api/go/models.md index 22a5fe4c9..0eec8fa09 100644 --- a/content/en/api/go/models.md +++ b/content/en/api/go/models.md @@ -106,6 +106,20 @@ The Models API response can be used to determine which models are available for - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type ModelInfo struct{…}` @@ -440,6 +454,20 @@ The Models API response can be used to determine information about a specific mo - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ### Returns - `type ModelInfo struct{…}` diff --git a/content/en/api/go/models/list.md b/content/en/api/go/models/list.md index df596d593..95eec33d0 100644 --- a/content/en/api/go/models/list.md +++ b/content/en/api/go/models/list.md @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type ModelInfo struct{…}` diff --git a/content/en/api/go/models/retrieve.md b/content/en/api/go/models/retrieve.md index 8a137e9e6..7046e7f79 100644 --- a/content/en/api/go/models/retrieve.md +++ b/content/en/api/go/models/retrieve.md @@ -92,6 +92,20 @@ The Models API response can be used to determine information about a specific mo - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` + - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` + + - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` + + - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` + + - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` + + - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` + + - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` + + - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` + ## Returns - `type ModelInfo struct{…}` diff --git a/content/en/api/java/beta.md b/content/en/api/java/beta.md index 0063954e0..0c389c078 100644 --- a/content/en/api/java/beta.md +++ b/content/en/api/java/beta.md @@ -74,6 +74,20 @@ - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Beta API Error - `class BetaApiError:` @@ -392,6 +406,20 @@ The Models API response can be used to determine which models are available for - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaModelInfo:` @@ -723,6 +751,20 @@ The Models API response can be used to determine information about a specific mo - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaModelInfo:` @@ -1047,6 +1089,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5839,12 +5895,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -6142,12 +6200,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -6544,6 +6604,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -10022,6 +10096,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -11720,6 +11808,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `OMITTED("omitted")` + - `UPDATES("updates")` + - `class BetaThinkingConfigDisabled:` - `JsonValue type constant` @@ -11736,6 +11826,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `OMITTED("omitted")` + - `UPDATES("updates")` + - `JsonValue` - `Optional inferenceGeo` @@ -14072,6 +14164,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaMessageBatch:` @@ -14316,6 +14422,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaMessageBatch:` @@ -14557,6 +14677,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaMessageBatch:` @@ -14791,6 +14925,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaDeletedMessageBatch:` @@ -14927,6 +15075,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaMessageBatchIndividualResponse:` @@ -16230,12 +16392,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -16649,6 +16813,20 @@ Create Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Model model` Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control @@ -17984,6 +18162,20 @@ List Agents - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsAgent:` @@ -18701,6 +18893,20 @@ Get Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsAgent:` @@ -19407,6 +19613,20 @@ Update Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional description` Description. Omit to preserve; send empty string or null to clear. @@ -20719,6 +20939,20 @@ Archive Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsAgent:` @@ -21437,6 +21671,20 @@ List Agent Versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsAgent:` @@ -22148,6 +22396,20 @@ Create a new environment with the specified configuration. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String name` Human-readable name for the environment @@ -22198,7 +22460,7 @@ Create a new environment with the specified configuration. - `Optional allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `Optional> allowedHosts` @@ -22210,6 +22472,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Optional> apt` Ubuntu/Debian packages to install @@ -22565,6 +22829,20 @@ List environments with pagination support. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaEnvironment:` @@ -22856,6 +23134,20 @@ Retrieve a specific environment by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaEnvironment:` @@ -23142,6 +23434,20 @@ Update an existing environment's configuration. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional config` Updated environment configuration @@ -23186,7 +23492,7 @@ Update an existing environment's configuration. - `Optional allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `Optional> allowedHosts` @@ -23198,6 +23504,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Optional> apt` Ubuntu/Debian packages to install @@ -23544,6 +23852,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaEnvironmentDeleteResponse:` @@ -23674,6 +23996,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaEnvironment:` @@ -23966,6 +24302,20 @@ Retrieve detailed information about a specific work item. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWork:` @@ -24196,6 +24546,20 @@ Long poll for work items in the queue. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional anthropicWorkerId` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -24417,6 +24781,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWork:` @@ -24645,6 +25023,20 @@ Record a heartbeat for a work item to maintain the lease. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWorkHeartbeatResponse:` @@ -24808,6 +25200,20 @@ Stop a work item, initiating graceful or forced shutdown. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaSelfHostedWorkStopRequest betaSelfHostedWorkStopRequest` Request to stop a work item. @@ -25042,6 +25448,20 @@ List work items in an environment. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWork:` @@ -25263,6 +25683,20 @@ Update work item metadata with merge semantics. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaSelfHostedWorkUpdateRequest betaSelfHostedWorkUpdateRequest` Request to update work item metadata. @@ -25490,6 +25924,20 @@ Get statistics about the work queue for an environment. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWorkQueueStats:` @@ -25637,6 +26085,20 @@ Create Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Agent agent` Agent identifier. Accepts the `agent` ID string, which pins the latest version for the session, or an `agent` object with both id and version specified. @@ -27784,6 +28246,20 @@ List Sessions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSession:` @@ -28917,6 +29393,20 @@ Get Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSession:` @@ -30044,6 +30534,20 @@ Update Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional agent` Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back. @@ -31193,6 +31697,20 @@ Delete Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeletedSession:` @@ -31319,6 +31837,20 @@ Archive Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSession:` @@ -32494,6 +33026,20 @@ List Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionEvent: union` @@ -34753,6 +35299,20 @@ Send Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List events` Events to send to the `session`. @@ -35706,6 +36266,20 @@ Stream Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsStreamSessionEvents: union` @@ -38008,6 +38582,20 @@ Add Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaManagedAgentsFileResourceParams betaManagedAgentsFileResourceParams` Mount a file uploaded via the Files API into the session. @@ -38174,6 +38762,20 @@ List Session Resources - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionResource: union` @@ -38421,6 +39023,20 @@ Get Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class ResourceRetrieveResponse: union` @@ -38659,6 +39275,20 @@ Update Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String authorizationToken` New authorization token for the resource. Currently only `github_repository` resources support token rotation. @@ -38904,6 +39534,20 @@ Delete Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeleteSessionResource:` @@ -39046,6 +39690,20 @@ List Session Threads - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -39058,7 +39716,7 @@ List Session Threads - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -39873,6 +40531,20 @@ Get Session Thread - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -39885,7 +40557,7 @@ Get Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -40699,6 +41371,20 @@ Archive Session Thread - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -40711,7 +41397,7 @@ Archive Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -41537,6 +42223,20 @@ List Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionEvent: union` @@ -43799,6 +44499,20 @@ Stream Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` @@ -46103,6 +46817,20 @@ Create Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Agent agent` Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived. @@ -47209,6 +47937,20 @@ List Deployments - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -47904,6 +48646,20 @@ Get Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -48594,6 +49350,20 @@ Update Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional agent` Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared. @@ -49656,6 +50426,20 @@ Archive Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -50346,6 +51130,20 @@ Run Deployment Now - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeploymentRun:` @@ -50702,6 +51500,20 @@ Pause Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -51392,6 +52204,20 @@ Unpause Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeployment:` @@ -52128,6 +52954,20 @@ List Deployment Runs - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeploymentRun:` @@ -52489,6 +53329,20 @@ Get Deployment Run - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeploymentRun:` @@ -52845,6 +53699,20 @@ Create Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String displayName` Human-readable name for the vault. 1-255 characters. @@ -53031,6 +53899,20 @@ List Vaults - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsVault:` @@ -53197,6 +54079,20 @@ Get Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsVault:` @@ -53358,6 +54254,20 @@ Update Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional displayName` Updated human-readable name for the vault. 1-255 characters. @@ -53529,6 +54439,20 @@ Delete Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeletedVault:` @@ -53657,6 +54581,20 @@ Archive Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsVault:` @@ -53820,6 +54758,20 @@ Create Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Auth auth` Authentication details for creating a credential. @@ -54301,6 +55253,20 @@ List Credentials - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsCredential:` @@ -54592,6 +55558,20 @@ Get Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsCredential:` @@ -54882,6 +55862,20 @@ Update Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional auth` Updated authentication details for a credential. @@ -55304,6 +56298,20 @@ Delete Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeletedCredential:` @@ -55438,6 +56446,20 @@ Archive Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsCredential:` @@ -55728,6 +56750,20 @@ Validate Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsCredentialValidation:` @@ -55956,6 +56992,20 @@ Create a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String name` Human-readable name for the store. Required; 1–255 characters; no control characters. The mount-path slug under `/mnt/memory/` is derived from this name (lowercased, non-alphanumeric runs collapsed to a hyphen). Names need not be unique within a workspace. @@ -56165,6 +57215,20 @@ List memory stores - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryStore:` @@ -56336,6 +57400,20 @@ Retrieve a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryStore:` @@ -56502,6 +57580,20 @@ Update a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional description` New description for the store, up to 1024 characters. Pass an empty string to clear it. @@ -56684,6 +57776,20 @@ Delete a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeletedMemoryStore:` @@ -56812,6 +57918,20 @@ Archive a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryStore:` @@ -56984,6 +58104,20 @@ Create a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional content` UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `""` explicitly to create an empty memory. @@ -57026,7 +58160,7 @@ Create a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -57197,6 +58331,20 @@ List memories - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryListItem: union` @@ -57233,7 +58381,7 @@ List memories - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -57396,6 +58544,20 @@ Retrieve a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemory:` @@ -57428,7 +58590,7 @@ Retrieve a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -57580,6 +58742,20 @@ Update a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional content` New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). @@ -57626,7 +58802,7 @@ Update a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -57778,11 +58954,25 @@ Delete a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `String id` @@ -57958,11 +59148,25 @@ List memory versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -57976,7 +59180,7 @@ List memory versions - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` @@ -58218,11 +59422,25 @@ Retrieve a memory version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -58236,7 +59454,7 @@ Retrieve a memory version - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` @@ -58473,11 +59691,25 @@ Redact a memory version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -58491,7 +59723,7 @@ Redact a memory version - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` @@ -58726,6 +59958,20 @@ Upload File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String file` The file to upload @@ -58935,6 +60181,20 @@ List Files - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaFileMetadata:` @@ -59125,6 +60385,20 @@ Download File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Example ```java @@ -59234,6 +60508,20 @@ Get File Metadata - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaFileMetadata:` @@ -59417,6 +60705,20 @@ Delete File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaDeletedFile:` @@ -59547,6 +60849,20 @@ Create Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List files` Files to upload for the skill. @@ -59748,6 +61064,20 @@ List Skills - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class SkillListResponse:` @@ -59924,6 +61254,20 @@ Get Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class SkillRetrieveResponse:` @@ -60094,6 +61438,20 @@ Delete Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class SkillDeleteResponse:` @@ -60232,6 +61590,20 @@ Create Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List files` Files to upload for the skill. @@ -60427,6 +61799,20 @@ List Skill Versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class VersionListResponse:` @@ -60613,6 +61999,20 @@ Download a skill version's content as a zip archive. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Example ```java @@ -60734,6 +62134,20 @@ Get Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class VersionRetrieveResponse:` @@ -60918,6 +62332,20 @@ Delete Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class VersionDeleteResponse:` @@ -61054,6 +62482,20 @@ Create User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional accessType` How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. @@ -61300,6 +62742,20 @@ List User Profiles - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaUserProfile:` @@ -61501,6 +62957,20 @@ Get User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaUserProfile:` @@ -61697,6 +63167,20 @@ Update User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional accessType` How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. @@ -61927,6 +63411,20 @@ Create Enrollment URL - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaUserProfileEnrollmentUrl:` @@ -62062,6 +63560,20 @@ Create a Dream - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List inputs` - `class BetaDreamMemoryStoreInput:` @@ -62453,6 +63965,20 @@ List Dreams - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaDream:` @@ -62755,6 +64281,20 @@ Get a Dream - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaDream:` @@ -63052,6 +64592,20 @@ Cancel a Dream - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaDream:` @@ -63349,6 +64903,20 @@ Archive a Dream - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaDream:` @@ -63648,6 +65216,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional displayName` Optional human-readable name for the tunnel (1-255 characters). @@ -63808,6 +65390,20 @@ Fetches a tunnel by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaTunnel:` @@ -63974,6 +65570,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaTunnel:` @@ -64133,6 +65743,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaTunnel:` @@ -64287,6 +65911,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaTunnelToken:` @@ -64422,6 +66060,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional reason` Optional free-text reason for the rotation, recorded for audit. @@ -64565,49 +66217,10492 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - - `String caCertificatePem` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `String caCertificatePem` + + PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. + + maxLength: 8192 + +#### Returns + +- `class BetaTunnelCertificate:` + + A CA certificate attached to a tunnel. + + - `String id` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `Optional archivedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `LocalDateTime createdAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `Optional expiresAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `String fingerprint` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `String tunnelId` + + ID of the tunnel the certificate is registered against. + + - `JsonValue type constant` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.tunnels.certificates.BetaTunnelCertificate; +import com.anthropic.models.beta.tunnels.certificates.CertificateCreateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + CertificateCreateParams params = CertificateCreateParams.builder() + .tunnelId("tunnel_id") + .caCertificatePem("ca_certificate_pem") + .build(); + BetaTunnelCertificate betaTunnelCertificate = client.beta().tunnels().certificates().create(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### Get Tunnel Certificate + +`BetaTunnelCertificate beta().tunnels().certificates().retrieve(params, requestOptions = RequestOptions.none())` + +**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Fetches a tunnel certificate by ID. + +#### Parameters + +- `CertificateRetrieveParams params` + + - `String tunnelId` + + - `Optional certificateId` + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaTunnelCertificate:` + + A CA certificate attached to a tunnel. + + - `String id` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `Optional archivedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `LocalDateTime createdAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `Optional expiresAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `String fingerprint` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `String tunnelId` + + ID of the tunnel the certificate is registered against. + + - `JsonValue type constant` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.tunnels.certificates.BetaTunnelCertificate; +import com.anthropic.models.beta.tunnels.certificates.CertificateRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + CertificateRetrieveParams params = CertificateRetrieveParams.builder() + .tunnelId("tunnel_id") + .certificateId("certificate_id") + .build(); + BetaTunnelCertificate betaTunnelCertificate = client.beta().tunnels().certificates().retrieve(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### List Tunnel Certificates + +`CertificateListPage beta().tunnels().certificates().list(params = CertificateListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/tunnels/{tunnel_id}/certificates` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. + +#### Parameters + +- `CertificateListParams params` + + - `Optional tunnelId` + + - `Optional includeArchived` + + Whether to include archived certificates in the results. Defaults to false. + + - `Optional limit` + + Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + + format: int32 + + - `Optional page` + + Opaque pagination cursor from a previous `list_tunnel_certificates` response. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaTunnelCertificate:` + + A CA certificate attached to a tunnel. + + - `String id` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `Optional archivedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `LocalDateTime createdAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `Optional expiresAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `String fingerprint` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `String tunnelId` + + ID of the tunnel the certificate is registered against. + + - `JsonValue type constant` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.tunnels.certificates.CertificateListPage; +import com.anthropic.models.beta.tunnels.certificates.CertificateListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + CertificateListPage page = client.beta().tunnels().certificates().list("tunnel_id"); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" + } + ], + "next_page": "next_page" +} +``` + +### Archive Tunnel Certificate + +`BetaTunnelCertificate beta().tunnels().certificates().archive(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. + +#### Parameters + +- `CertificateArchiveParams params` + + - `String tunnelId` + + - `Optional certificateId` + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaTunnelCertificate:` + + A CA certificate attached to a tunnel. + + - `String id` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `Optional archivedAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `LocalDateTime createdAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `Optional expiresAt` + + A timestamp in RFC 3339 format + + format: date-time + + - `String fingerprint` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `String tunnelId` + + ID of the tunnel the certificate is registered against. + + - `JsonValue type constant` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.tunnels.certificates.BetaTunnelCertificate; +import com.anthropic.models.beta.tunnels.certificates.CertificateArchiveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + CertificateArchiveParams params = CertificateArchiveParams.builder() + .tunnelId("tunnel_id") + .certificateId("certificate_id") + .build(); + BetaTunnelCertificate betaTunnelCertificate = client.beta().tunnels().certificates().archive(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +## Beta › Organization + +### Get Current Organization + +`BetaOrganization beta().organization().retrieve(params = OrganizationRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Parameters + +- `OrganizationRetrieveParams params` + +#### Returns + +- `class BetaOrganization:` + + - `String id` + + ID of the Organization. + + format: uuid + + - `String name` + + Name of the Organization. + + - `JsonValue type constant` + + Object type. + + For Organizations, this is always `"organization"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.BetaOrganization; +import com.anthropic.models.beta.organization.OrganizationRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaOrganization betaOrganization = client.beta().organization().retrieve(); + } +} +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +`ApiKeyListPage beta().organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Parameters + +- `ApiKeyListParams params` + + - `Optional afterId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `Optional beforeId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `Optional createdByUserId` + + Filter by the ID of the User who created the object. + + - `Optional limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `Optional status` + + Filter by API key status. + + - `ACTIVE("active")` + + - `ARCHIVED("archived")` + + - `EXPIRED("expired")` + + - `INACTIVE("inactive")` + + - `Optional workspaceId` + + Filter by Workspace ID. + +#### Returns + +- `class BetaApiKey:` + + - `String id` + + ID of the API key. + + - `LocalDateTime createdAt` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `Optional createdBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `String id` + + ID of the actor that created the object. + + - `Type type` + + Type of the actor that created the object. + + - `SERVICE_ACCOUNT("service_account")` + + - `USER("user")` + + - `Optional expiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `String name` + + Name of the API key. + + - `Optional partialKeyHint` + + Partially redacted hint for the API key. + + - `Optional principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaApiKeyUserActor:` + + - `JsonValue type constant` + + Principal type. Always `"user_actor"` for a User. + + - `String userId` + + ID of the User the API key acts as. + + - `class BetaApiKeyServiceAccountActor:` + + - `String serviceAccountId` + + ID of the Service Account the API key acts as. + + - `JsonValue type constant` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `Scope scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaApiKeyOrganizationScope:` + + - `JsonValue type constant` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaApiKeyWorkspaceScope:` + + - `JsonValue type constant` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `String workspaceId` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `Status status` + + Status of the API key. + + - `ACTIVE("active")` + + - `ARCHIVED("archived")` + + - `EXPIRED("expired")` + + - `INACTIVE("inactive")` + + - `JsonValue type constant` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `Optional workspaceId` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.apikeys.ApiKeyListPage; +import com.anthropic.models.beta.organization.apikeys.ApiKeyListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ApiKeyListPage page = client.beta().organization().apiKeys().list(); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +`BetaApiKey beta().organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Parameters + +- `ApiKeyRetrieveParams params` + + - `Optional apiKeyId` + + ID of the API key. + +#### Returns + +- `class BetaApiKey:` + + - `String id` + + ID of the API key. + + - `LocalDateTime createdAt` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `Optional createdBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `String id` + + ID of the actor that created the object. + + - `Type type` + + Type of the actor that created the object. + + - `SERVICE_ACCOUNT("service_account")` + + - `USER("user")` + + - `Optional expiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `String name` + + Name of the API key. + + - `Optional partialKeyHint` + + Partially redacted hint for the API key. + + - `Optional principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaApiKeyUserActor:` + + - `JsonValue type constant` + + Principal type. Always `"user_actor"` for a User. + + - `String userId` + + ID of the User the API key acts as. + + - `class BetaApiKeyServiceAccountActor:` + + - `String serviceAccountId` + + ID of the Service Account the API key acts as. + + - `JsonValue type constant` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `Scope scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaApiKeyOrganizationScope:` + + - `JsonValue type constant` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaApiKeyWorkspaceScope:` + + - `JsonValue type constant` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `String workspaceId` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `Status status` + + Status of the API key. + + - `ACTIVE("active")` + + - `ARCHIVED("archived")` + + - `EXPIRED("expired")` + + - `INACTIVE("inactive")` + + - `JsonValue type constant` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `Optional workspaceId` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.apikeys.ApiKeyRetrieveParams; +import com.anthropic.models.beta.organization.apikeys.BetaApiKey; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaApiKey betaApiKey = client.beta().organization().apiKeys().retrieve("api_key_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +`BetaApiKey beta().organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Parameters + +- `ApiKeyUpdateParams params` + + - `Optional apiKeyId` + + ID of the API key. + + - `Optional name` + + Name of the API key. + + maxLength: 500, minLength: 1 + + - `Optional status` + + Status of the API key. + + - `ACTIVE("active")` + + - `ARCHIVED("archived")` + + - `INACTIVE("inactive")` + +#### Returns + +- `class BetaApiKey:` + + - `String id` + + ID of the API key. + + - `LocalDateTime createdAt` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `Optional createdBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `String id` + + ID of the actor that created the object. + + - `Type type` + + Type of the actor that created the object. + + - `SERVICE_ACCOUNT("service_account")` + + - `USER("user")` + + - `Optional expiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `String name` + + Name of the API key. + + - `Optional partialKeyHint` + + Partially redacted hint for the API key. + + - `Optional principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaApiKeyUserActor:` + + - `JsonValue type constant` + + Principal type. Always `"user_actor"` for a User. + + - `String userId` + + ID of the User the API key acts as. + + - `class BetaApiKeyServiceAccountActor:` + + - `String serviceAccountId` + + ID of the Service Account the API key acts as. + + - `JsonValue type constant` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `Scope scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaApiKeyOrganizationScope:` + + - `JsonValue type constant` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaApiKeyWorkspaceScope:` + + - `JsonValue type constant` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `String workspaceId` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `Status status` + + Status of the API key. + + - `ACTIVE("active")` + + - `ARCHIVED("archived")` + + - `EXPIRED("expired")` + + - `INACTIVE("inactive")` + + - `JsonValue type constant` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `Optional workspaceId` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.apikeys.ApiKeyUpdateParams; +import com.anthropic.models.beta.organization.apikeys.BetaApiKey; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaApiKey betaApiKey = client.beta().organization().apiKeys().update("api_key_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +`BetaExternalKey beta().organization().externalKeys().create(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Parameters + +- `ExternalKeyCreateParams params` + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `String kmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonValue type constant` + + - `Optional region` + + AWS region. Derived from `kms_arn` if omitted. + + - `Optional roleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `String keyName` + + Full resource name of the Cloud KMS key. + + - `JsonValue type constant` + + - `class BetaAzureExternalKeyConfigParam:` + + Azure Key Vault provider configuration. + + - `String keyName` + + Name of the key within the vault. + + - `String tenantId` + + Azure AD tenant ID. + + - `JsonValue type constant` + + - `String vaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `Optional clientId` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `Optional displayName` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + + - `Optional geo` + + Data residency geo. Only `us` is supported. + + - `US("us")` + +#### Returns + +- `class BetaExternalKey:` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `String id` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment:` + + - `JsonValue type constant` + + - `class BetaExternalKeyUnattachedAttachment:` + + - `JsonValue type constant` + + - `LocalDateTime createdAt` + + format: date-time + + - `Optional displayName` + + Human-friendly display name. Null if none was set. + + - `String geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `String kmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonValue type constant` + + - `Optional region` + + AWS region. Derived from `kms_arn` if omitted. + + - `Optional roleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `String keyName` + + Full resource name of the Cloud KMS key. + + - `JsonValue type constant` + + - `class BetaAzureExternalKeyConfig:` + + - `String keyName` + + Name of the key within the vault. + + - `String tenantId` + + Azure AD tenant ID. + + - `JsonValue type constant` + + - `String vaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `Optional clientId` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + format: date-time + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.externalkeys.BetaExternalKey; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyCreateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ExternalKeyCreateParams params = ExternalKeyCreateParams.builder() + .awsProviderConfig("arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222") + .build(); + BetaExternalKey betaExternalKey = client.beta().organization().externalKeys().create(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +`ExternalKeyListPage beta().organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Parameters + +- `ExternalKeyListParams params` + + - `Optional limit` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaExternalKey:` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `String id` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment:` + + - `JsonValue type constant` + + - `class BetaExternalKeyUnattachedAttachment:` + + - `JsonValue type constant` + + - `LocalDateTime createdAt` + + format: date-time + + - `Optional displayName` + + Human-friendly display name. Null if none was set. + + - `String geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `String kmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonValue type constant` + + - `Optional region` + + AWS region. Derived from `kms_arn` if omitted. + + - `Optional roleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `String keyName` + + Full resource name of the Cloud KMS key. + + - `JsonValue type constant` + + - `class BetaAzureExternalKeyConfig:` + + - `String keyName` + + Name of the key within the vault. + + - `String tenantId` + + Azure AD tenant ID. + + - `JsonValue type constant` + + - `String vaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `Optional clientId` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + format: date-time + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyListPage; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ExternalKeyListPage page = client.beta().organization().externalKeys().list(); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +`BetaExternalKey beta().organization().externalKeys().retrieve(params = ExternalKeyRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Parameters + +- `ExternalKeyRetrieveParams params` + + - `Optional externalKeyId` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class BetaExternalKey:` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `String id` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment:` + + - `JsonValue type constant` + + - `class BetaExternalKeyUnattachedAttachment:` + + - `JsonValue type constant` + + - `LocalDateTime createdAt` + + format: date-time + + - `Optional displayName` + + Human-friendly display name. Null if none was set. + + - `String geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `String kmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonValue type constant` + + - `Optional region` + + AWS region. Derived from `kms_arn` if omitted. + + - `Optional roleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `String keyName` + + Full resource name of the Cloud KMS key. + + - `JsonValue type constant` + + - `class BetaAzureExternalKeyConfig:` + + - `String keyName` + + Name of the key within the vault. + + - `String tenantId` + + Azure AD tenant ID. + + - `JsonValue type constant` + + - `String vaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `Optional clientId` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + format: date-time + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.externalkeys.BetaExternalKey; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaExternalKey betaExternalKey = client.beta().organization().externalKeys().retrieve("external_key_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +`BetaExternalKey beta().organization().externalKeys().update(params = ExternalKeyUpdateParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Parameters + +- `ExternalKeyUpdateParams params` + + - `Optional externalKeyId` + + ID of the External Key. + + maxLength: 2048 + + - `Optional displayName` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + + - `Optional geo` + + Data residency geo. Only `us` is supported. + + - `US("us")` + + - `Optional providerConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `String kmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonValue type constant` + + - `Optional region` + + AWS region. Derived from `kms_arn` if omitted. + + - `Optional roleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `String keyName` + + Full resource name of the Cloud KMS key. + + - `JsonValue type constant` + + - `class BetaAzureExternalKeyConfigParam:` + + Azure Key Vault provider configuration. + + - `String keyName` + + Name of the key within the vault. + + - `String tenantId` + + Azure AD tenant ID. + + - `JsonValue type constant` + + - `String vaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `Optional clientId` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +#### Returns + +- `class BetaExternalKey:` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `String id` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment:` + + - `JsonValue type constant` + + - `class BetaExternalKeyUnattachedAttachment:` + + - `JsonValue type constant` + + - `LocalDateTime createdAt` + + format: date-time + + - `Optional displayName` + + Human-friendly display name. Null if none was set. + + - `String geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAwsExternalKeyConfig:` + + - `String kmsArn` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `JsonValue type constant` + + - `Optional region` + + AWS region. Derived from `kms_arn` if omitted. + + - `Optional roleArn` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGcpExternalKeyConfig:` + + - `String keyName` + + Full resource name of the Cloud KMS key. + + - `JsonValue type constant` + + - `class BetaAzureExternalKeyConfig:` + + - `String keyName` + + Name of the key within the vault. + + - `String tenantId` + + Azure AD tenant ID. + + - `JsonValue type constant` + + - `String vaultUri` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `Optional clientId` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + format: date-time + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.externalkeys.BetaExternalKey; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyUpdateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaExternalKey betaExternalKey = client.beta().organization().externalKeys().update("external_key_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +`ExternalKeyDeleteResponse beta().organization().externalKeys().delete(params = ExternalKeyDeleteParams.none(), requestOptions = RequestOptions.none())` + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Parameters + +- `ExternalKeyDeleteParams params` + + - `Optional externalKeyId` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class ExternalKeyDeleteResponse:` + + - `String id` + + ID of the deleted External Key. + + - `JsonValue type constant` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyDeleteParams; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyDeleteResponse; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ExternalKeyDeleteResponse externalKey = client.beta().organization().externalKeys().delete("external_key_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +`ExternalKeyValidateResponse beta().organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Parameters + +- `ExternalKeyValidateParams params` + + - `Optional externalKeyId` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class ExternalKeyValidateResponse:` + + Result of a validation roundtrip against the customer's KMS. + + HTTP 200 for both outcomes — the operation completed; `status` says + whether the key works. + + - `Optional error` + + Error message when status is `failure`. Null otherwise. + + - `Status status` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `FAILURE("failure")` + + - `SUCCESS("success")` + + - `JsonValue type constant` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyValidateParams; +import com.anthropic.models.beta.organization.externalkeys.ExternalKeyValidateResponse; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ExternalKeyValidateResponse response = client.beta().organization().externalKeys().validate("external_key_id"); + } +} +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +`BetaFederationIssuer beta().organization().federation().issuers().create(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Parameters + +- `IssuerCreateParams params` + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `String issuerUrl` + + The `iss` claim value to match against. + + minLength: 1 + + - `String name` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `Optional checkJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `Optional jwks` + + How signing keys are obtained. Defaults to OIDC discovery. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonValue type constant` + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `Optional discoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonValue type constant` + + - `String url` + + JWKS endpoint. + + minLength: 1 + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `List keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonValue type constant` + + - `Optional maxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `String id` + + Tagged ID of the federation issuer. + + - `Optional archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `boolean checkJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `LocalDateTime createdAt` + + When this issuer was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `String issuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `Jwks jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonValue type constant` + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `Optional discoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonValue type constant` + + - `String url` + + JWKS endpoint. + + minLength: 1 + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `List keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonValue type constant` + + - `Optional jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `long maxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `String name` + + Admin-chosen slug identifier. + + - `Optional pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `long consecutiveFailures` + + Consecutive fetch failures since the last success. + + - `Optional lastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `Optional nextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this issuer was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.issuers.BetaFederationIssuer; +import com.anthropic.models.beta.organization.federation.issuers.IssuerCreateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + IssuerCreateParams params = IssuerCreateParams.builder() + .issuerUrl("x") + .name("x") + .build(); + BetaFederationIssuer betaFederationIssuer = client.beta().organization().federation().issuers().create(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +`IssuerListPage beta().organization().federation().issuers().list(params = IssuerListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Parameters + +- `IssuerListParams params` + + - `Optional includeArchived` + + Include archived resources. Defaults to false. + + - `Optional limit` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `String id` + + Tagged ID of the federation issuer. + + - `Optional archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `boolean checkJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `LocalDateTime createdAt` + + When this issuer was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `String issuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `Jwks jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonValue type constant` + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `Optional discoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonValue type constant` + + - `String url` + + JWKS endpoint. + + minLength: 1 + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `List keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonValue type constant` + + - `Optional jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `long maxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `String name` + + Admin-chosen slug identifier. + + - `Optional pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `long consecutiveFailures` + + Consecutive fetch failures since the last success. + + - `Optional lastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `Optional nextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this issuer was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.issuers.IssuerListPage; +import com.anthropic.models.beta.organization.federation.issuers.IssuerListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + IssuerListPage page = client.beta().organization().federation().issuers().list(); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +`BetaFederationIssuer beta().organization().federation().issuers().retrieve(params = IssuerRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Parameters + +- `IssuerRetrieveParams params` + + - `Optional federationIssuerId` + + ID of the federation issuer. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `String id` + + Tagged ID of the federation issuer. + + - `Optional archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `boolean checkJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `LocalDateTime createdAt` + + When this issuer was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `String issuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `Jwks jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonValue type constant` + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `Optional discoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonValue type constant` + + - `String url` + + JWKS endpoint. + + minLength: 1 + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `List keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonValue type constant` + + - `Optional jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `long maxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `String name` + + Admin-chosen slug identifier. + + - `Optional pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `long consecutiveFailures` + + Consecutive fetch failures since the last success. + + - `Optional lastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `Optional nextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this issuer was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.issuers.BetaFederationIssuer; +import com.anthropic.models.beta.organization.federation.issuers.IssuerRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaFederationIssuer betaFederationIssuer = client.beta().organization().federation().issuers().retrieve("federation_issuer_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +`BetaFederationIssuer beta().organization().federation().issuers().update(params = IssuerUpdateParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Parameters + +- `IssuerUpdateParams params` + + - `Optional federationIssuerId` + + ID of the federation issuer to update. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `Optional checkJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `Optional issuerUrl` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + + - `Optional jwks` + + Replaces the entire JWKS configuration. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonValue type constant` + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `Optional discoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonValue type constant` + + - `String url` + + JWKS endpoint. + + minLength: 1 + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `List keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonValue type constant` + + - `Optional jwksPollingDisabled` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + + - `Optional maxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + + - `Optional name` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `String id` + + Tagged ID of the federation issuer. + + - `Optional archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `boolean checkJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `LocalDateTime createdAt` + + When this issuer was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `String issuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `Jwks jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonValue type constant` + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `Optional discoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonValue type constant` + + - `String url` + + JWKS endpoint. + + minLength: 1 + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `List keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonValue type constant` + + - `Optional jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `long maxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `String name` + + Admin-chosen slug identifier. + + - `Optional pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `long consecutiveFailures` + + Consecutive fetch failures since the last success. + + - `Optional lastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `Optional nextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this issuer was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.issuers.BetaFederationIssuer; +import com.anthropic.models.beta.organization.federation.issuers.IssuerUpdateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaFederationIssuer betaFederationIssuer = client.beta().organization().federation().issuers().update("federation_issuer_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +`BetaFederationIssuer beta().organization().federation().issuers().archive(params = IssuerArchiveParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Parameters + +- `IssuerArchiveParams params` + + - `Optional federationIssuerId` + + ID of the federation issuer to archive. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaFederationIssuer:` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `String id` + + Tagged ID of the federation issuer. + + - `Optional archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `boolean checkJti` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `LocalDateTime createdAt` + + When this issuer was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `String issuerUrl` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `Jwks jwks` + + How signing keys are obtained for signature verification. + + - `class BetaJwksDiscovery:` + + JWKS via the issuer's OIDC discovery document. + + - `JsonValue type constant` + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `Optional discoveryBase` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJwksExplicitUrl:` + + JWKS fetched from a fixed endpoint. + + - `JsonValue type constant` + + - `String url` + + JWKS endpoint. + + minLength: 1 + + - `Optional caCertPem` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJwksInline:` + + JWKS supplied directly; no network fetch. + + - `List keys` + + Inline JWK objects. + + minItems: 1 + + - `JsonValue type constant` + + - `Optional jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `long maxJwtLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `String name` + + Admin-chosen slug identifier. + + - `Optional pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `long consecutiveFailures` + + Consecutive fetch failures since the last success. + + - `Optional lastFetchedAt` + + When the last successful fetch completed. + + format: date-time + + - `Optional nextPollAt` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this issuer was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.issuers.BetaFederationIssuer; +import com.anthropic.models.beta.organization.federation.issuers.IssuerArchiveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaFederationIssuer betaFederationIssuer = client.beta().organization().federation().issuers().archive("federation_issuer_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +`BetaFederationRule beta().organization().federation().rules().create(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Parameters + +- `RuleCreateParams params` + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `String issuerId` + + Tagged ID of the federation issuer. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `String name` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `String oauthScope` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `Optional appliesToAllWorkspaces` + + When true, enable this rule for every workspace in the org (including workspaces created later). + + - `Optional attributes` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + + - `Optional description` + + Optional free-text description. + + maxLength: 2000 + + - `Optional tokenLifetimeSeconds` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + + - `Optional workspaceId` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `String id` + + Tagged ID of the federation rule. + + - `boolean appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `Optional archivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Optional attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `LocalDateTime createdAt` + + When this rule was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Optional description` + + Optional free-text description. + + - `String issuerId` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `Optional issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Optional audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Optional claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Optional condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `Optional subjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `String name` + + Admin-chosen slug identifier. + + - `String oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `String serviceAccountId` + + Tagged ID of the service account to mint tokens for. + + - `JsonValue type constant` + + - `Optional serviceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `long tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this rule was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `Optional workspaceId` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `List workspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.rules.BetaFederationRule; +import com.anthropic.models.beta.organization.federation.rules.BetaFederationRuleMatch; +import com.anthropic.models.beta.organization.federation.rules.BetaServiceAccountTarget; +import com.anthropic.models.beta.organization.federation.rules.RuleCreateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + RuleCreateParams params = RuleCreateParams.builder() + .issuerId("issuer_id") + .match(BetaFederationRuleMatch.builder().build()) + .name("x") + .oauthScope("x") + .target(BetaServiceAccountTarget.builder() + .serviceAccountId("svac_01SDCCSbTxrXDpWc1phhtcfK") + .build()) + .build(); + BetaFederationRule betaFederationRule = client.beta().organization().federation().rules().create(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +`RuleListPage beta().organization().federation().rules().list(params = RuleListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Parameters + +- `RuleListParams params` + + - `Optional includeArchived` + + Include archived resources. Defaults to false. + + - `Optional issuerId` + + Filter to rules referencing this federation issuer. + + - `Optional limit` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `String id` + + Tagged ID of the federation rule. + + - `boolean appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `Optional archivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Optional attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `LocalDateTime createdAt` + + When this rule was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Optional description` + + Optional free-text description. + + - `String issuerId` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `Optional issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Optional audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Optional claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Optional condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `Optional subjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `String name` + + Admin-chosen slug identifier. + + - `String oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `String serviceAccountId` + + Tagged ID of the service account to mint tokens for. + + - `JsonValue type constant` + + - `Optional serviceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `long tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this rule was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `Optional workspaceId` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `List workspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.rules.RuleListPage; +import com.anthropic.models.beta.organization.federation.rules.RuleListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + RuleListPage page = client.beta().organization().federation().rules().list(); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +`BetaFederationRule beta().organization().federation().rules().retrieve(params = RuleRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Parameters + +- `RuleRetrieveParams params` + + - `Optional federationRuleId` + + ID of the federation rule. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `String id` + + Tagged ID of the federation rule. + + - `boolean appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `Optional archivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Optional attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `LocalDateTime createdAt` + + When this rule was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Optional description` + + Optional free-text description. + + - `String issuerId` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `Optional issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Optional audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Optional claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Optional condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `Optional subjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `String name` + + Admin-chosen slug identifier. + + - `String oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `String serviceAccountId` + + Tagged ID of the service account to mint tokens for. + + - `JsonValue type constant` + + - `Optional serviceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `long tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this rule was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `Optional workspaceId` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `List workspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.rules.BetaFederationRule; +import com.anthropic.models.beta.organization.federation.rules.RuleRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaFederationRule betaFederationRule = client.beta().organization().federation().rules().retrieve("federation_rule_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +`BetaFederationRule beta().organization().federation().rules().update(params = RuleUpdateParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `RuleUpdateParams params` + + - `Optional federationRuleId` + + ID of the federation rule to update. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `Optional appliesToAllWorkspaces` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + + - `Optional attributes` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + + - `Optional description` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + + - `Optional match` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `Optional name` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `Optional oauthScope` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + + - `Optional target` + + Bind to a fixed service account by ID. + + - `Optional tokenLifetimeSeconds` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + + - `Optional workspaceId` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `String id` + + Tagged ID of the federation rule. + + - `boolean appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `Optional archivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Optional attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `LocalDateTime createdAt` + + When this rule was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Optional description` + + Optional free-text description. + + - `String issuerId` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `Optional issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Optional audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Optional claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Optional condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `Optional subjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `String name` + + Admin-chosen slug identifier. + + - `String oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `String serviceAccountId` + + Tagged ID of the service account to mint tokens for. + + - `JsonValue type constant` + + - `Optional serviceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `long tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this rule was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `Optional workspaceId` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `List workspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.rules.BetaFederationRule; +import com.anthropic.models.beta.organization.federation.rules.RuleUpdateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaFederationRule betaFederationRule = client.beta().organization().federation().rules().update("federation_rule_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +`BetaFederationRule beta().organization().federation().rules().archive(params = RuleArchiveParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `RuleArchiveParams params` + + - `Optional federationRuleId` + + ID of the federation rule to archive. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaFederationRule:` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `String id` + + Tagged ID of the federation rule. + + - `boolean appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `Optional archivedAt` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `Optional attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `LocalDateTime createdAt` + + When this rule was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `Optional description` + + Optional free-text description. + + - `String issuerId` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `Optional issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `Optional audience` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `Optional claims` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `Optional condition` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `Optional subjectPrefix` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `String name` + + Admin-chosen slug identifier. + + - `String oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `String serviceAccountId` + + Tagged ID of the service account to mint tokens for. + + - `JsonValue type constant` + + - `Optional serviceAccountName` + + Service account's display name at read time. Ignored on writes. + + - `long tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this rule was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `Optional workspaceId` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `List workspaceIds` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.rules.BetaFederationRule; +import com.anthropic.models.beta.organization.federation.rules.RuleArchiveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaFederationRule betaFederationRule = client.beta().organization().federation().rules().archive("federation_rule_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +`BetaFederationRuleWorkspace beta().organization().federation().rules().workspaces().add(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `WorkspaceAddParams params` + + - `Optional federationRuleId` + + ID of the federation rule. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `String workspaceId` + + Tagged ID of the workspace to enable this rule for. + +#### Returns + +- `class BetaFederationRuleWorkspace:` + + - `LocalDateTime createdAt` + + When this workspace was enabled for the rule. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `String federationRuleId` + + Tagged ID of the federation rule. + + - `JsonValue type constant` + + - `String workspaceId` + + Tagged ID of the workspace this rule is enabled for. + + - `Optional workspaceName` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.rules.BetaFederationRuleWorkspace; +import com.anthropic.models.beta.organization.federation.rules.workspaces.WorkspaceAddParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + WorkspaceAddParams params = WorkspaceAddParams.builder() + .federationRuleId("federation_rule_id") + .workspaceId("workspace_id") + .build(); + BetaFederationRuleWorkspace betaFederationRuleWorkspace = client.beta().organization().federation().rules().workspaces().add(params); + } +} +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +`WorkspaceListPage beta().organization().federation().rules().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Parameters + +- `WorkspaceListParams params` + + - `Optional federationRuleId` + + ID of the federation rule. + + - `Optional limit` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaFederationRuleWorkspace:` + + - `LocalDateTime createdAt` + + When this workspace was enabled for the rule. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `String federationRuleId` + + Tagged ID of the federation rule. + + - `JsonValue type constant` + + - `String workspaceId` + + Tagged ID of the workspace this rule is enabled for. + + - `Optional workspaceName` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.rules.workspaces.WorkspaceListPage; +import com.anthropic.models.beta.organization.federation.rules.workspaces.WorkspaceListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + WorkspaceListPage page = client.beta().organization().federation().rules().workspaces().list("federation_rule_id"); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +`WorkspaceRemoveResponse beta().organization().federation().rules().workspaces().remove(params, requestOptions = RequestOptions.none())` + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `WorkspaceRemoveParams params` + + - `String federationRuleId` + + ID of the federation rule. + + - `Optional workspaceId` + + ID of the workspace to disable for. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class WorkspaceRemoveResponse:` + + - `String federationRuleId` + + Tagged ID of the federation rule. + + - `JsonValue type constant` + + - `String workspaceId` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.federation.rules.workspaces.WorkspaceRemoveParams; +import com.anthropic.models.beta.organization.federation.rules.workspaces.WorkspaceRemoveResponse; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + WorkspaceRemoveParams params = WorkspaceRemoveParams.builder() + .federationRuleId("federation_rule_id") + .workspaceId("workspace_id") + .build(); + WorkspaceRemoveResponse workspace = client.beta().organization().federation().rules().workspaces().remove(params); + } +} +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +`BetaOrganizationInvite beta().organization().invites().create(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Parameters + +- `InviteCreateParams params` + + - `String email` + + Email of the User. + + format: email + + - `Role role` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `BILLING("billing")` + + - `CLAUDE_CODE_USER("claude_code_user")` + + - `DEVELOPER("developer")` + + - `MANAGED("managed")` + + - `USER("user")` + + - `Optional> rbacGroupIds` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `class BetaOrganizationInvite:` + + - `String id` + + ID of the Invite. + + - `Optional acceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `String email` + + Email of the User being invited. + + - `LocalDateTime expiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `LocalDateTime invitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `List rbacGroupIds` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `ADMIN("admin")` + + - `BILLING("billing")` + + - `CLAUDE_CODE_USER("claude_code_user")` + + - `DEVELOPER("developer")` + + - `MANAGED("managed")` + + - `MEMBERSHIP_ADMIN("membership_admin")` + + - `OWNER("owner")` + + - `PRIMARY_OWNER("primary_owner")` + + - `USER("user")` + + - `Status status` + + Status of the Invite. + + - `ACCEPTED("accepted")` + + - `DELETED("deleted")` + + - `EXPIRED("expired")` + + - `PENDING("pending")` + + - `JsonValue type constant` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.invites.BetaOrganizationInvite; +import com.anthropic.models.beta.organization.invites.InviteCreateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + InviteCreateParams params = InviteCreateParams.builder() + .email("user@emaildomain.com") + .role(InviteCreateParams.Role.USER) + .build(); + BetaOrganizationInvite betaOrganizationInvite = client.beta().organization().invites().create(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +`InviteListPage beta().organization().invites().list(params = InviteListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Parameters + +- `InviteListParams params` + + - `Optional afterId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `Optional beforeId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `Optional email` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + + - `Optional limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `Optional> roles` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + + - `Optional> statuses` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `ACCEPTED("accepted")` + + - `EXPIRED("expired")` + + - `PENDING("pending")` + +#### Returns + +- `class BetaOrganizationInvite:` + + - `String id` + + ID of the Invite. + + - `Optional acceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `String email` + + Email of the User being invited. + + - `LocalDateTime expiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `LocalDateTime invitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `List rbacGroupIds` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `ADMIN("admin")` + + - `BILLING("billing")` + + - `CLAUDE_CODE_USER("claude_code_user")` + + - `DEVELOPER("developer")` + + - `MANAGED("managed")` + + - `MEMBERSHIP_ADMIN("membership_admin")` + + - `OWNER("owner")` + + - `PRIMARY_OWNER("primary_owner")` + + - `USER("user")` + + - `Status status` + + Status of the Invite. + + - `ACCEPTED("accepted")` + + - `DELETED("deleted")` + + - `EXPIRED("expired")` + + - `PENDING("pending")` + + - `JsonValue type constant` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.invites.InviteListPage; +import com.anthropic.models.beta.organization.invites.InviteListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + InviteListPage page = client.beta().organization().invites().list(); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +`BetaOrganizationInvite beta().organization().invites().retrieve(params = InviteRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Parameters + +- `InviteRetrieveParams params` + + - `Optional inviteId` + + ID of the Invite. + +#### Returns + +- `class BetaOrganizationInvite:` + + - `String id` + + ID of the Invite. + + - `Optional acceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `String email` + + Email of the User being invited. + + - `LocalDateTime expiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `LocalDateTime invitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `List rbacGroupIds` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `ADMIN("admin")` + + - `BILLING("billing")` + + - `CLAUDE_CODE_USER("claude_code_user")` + + - `DEVELOPER("developer")` + + - `MANAGED("managed")` + + - `MEMBERSHIP_ADMIN("membership_admin")` + + - `OWNER("owner")` + + - `PRIMARY_OWNER("primary_owner")` + + - `USER("user")` + + - `Status status` + + Status of the Invite. + + - `ACCEPTED("accepted")` + + - `DELETED("deleted")` + + - `EXPIRED("expired")` + + - `PENDING("pending")` + + - `JsonValue type constant` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.invites.BetaOrganizationInvite; +import com.anthropic.models.beta.organization.invites.InviteRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaOrganizationInvite betaOrganizationInvite = client.beta().organization().invites().retrieve("invite_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +`InviteDeleteResponse beta().organization().invites().delete(params = InviteDeleteParams.none(), requestOptions = RequestOptions.none())` + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Parameters + +- `InviteDeleteParams params` + + - `Optional inviteId` + + ID of the Invite. + +#### Returns + +- `class InviteDeleteResponse:` + + - `String id` + + ID of the Invite. + + - `JsonValue type constant` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.invites.InviteDeleteParams; +import com.anthropic.models.beta.organization.invites.InviteDeleteResponse; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + InviteDeleteResponse invite = client.beta().organization().invites().delete("invite_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +`BetaServiceAccount beta().organization().serviceAccounts().create(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Parameters + +- `ServiceAccountCreateParams params` + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `String name` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `Optional description` + + Optional free-text description. + + maxLength: 2000 + + - `Optional organizationRole` + + Org-level role. Defaults to `developer`. + + - `ADMIN("admin")` + + - `DEVELOPER("developer")` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `String id` + + Tagged ID of the service account. + + - `Optional archivedAt` + + If set, this service account is archived. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `LocalDateTime createdAt` + + When this service account was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Optional description` + + Optional free-text description. + + - `String name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `ADMIN("admin")` + + - `DEVELOPER("developer")` + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this service account was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccount; +import com.anthropic.models.beta.organization.serviceaccounts.ServiceAccountCreateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ServiceAccountCreateParams params = ServiceAccountCreateParams.builder() + .name("ci-deploy-bot") + .build(); + BetaServiceAccount betaServiceAccount = client.beta().organization().serviceAccounts().create(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +`ServiceAccountListPage beta().organization().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Parameters + +- `ServiceAccountListParams params` + + - `Optional includeArchived` + + Include archived resources. Defaults to false. + + - `Optional limit` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `String id` + + Tagged ID of the service account. + + - `Optional archivedAt` + + If set, this service account is archived. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `LocalDateTime createdAt` + + When this service account was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Optional description` + + Optional free-text description. + + - `String name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `ADMIN("admin")` + + - `DEVELOPER("developer")` + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this service account was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.serviceaccounts.ServiceAccountListPage; +import com.anthropic.models.beta.organization.serviceaccounts.ServiceAccountListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ServiceAccountListPage page = client.beta().organization().serviceAccounts().list(); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +`BetaServiceAccount beta().organization().serviceAccounts().retrieve(params = ServiceAccountRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Parameters + +- `ServiceAccountRetrieveParams params` + + - `Optional serviceAccountId` + + ID of the service account. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `String id` + + Tagged ID of the service account. + + - `Optional archivedAt` + + If set, this service account is archived. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `LocalDateTime createdAt` + + When this service account was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Optional description` + + Optional free-text description. + + - `String name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `ADMIN("admin")` + + - `DEVELOPER("developer")` + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this service account was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccount; +import com.anthropic.models.beta.organization.serviceaccounts.ServiceAccountRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaServiceAccount betaServiceAccount = client.beta().organization().serviceAccounts().retrieve("service_account_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +`BetaServiceAccount beta().organization().serviceAccounts().update(params = ServiceAccountUpdateParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Parameters + +- `ServiceAccountUpdateParams params` + + - `Optional serviceAccountId` + + ID of the service account to update. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `Optional description` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + + - `Optional organizationRole` + + Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `ADMIN("admin")` + + - `DEVELOPER("developer")` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `String id` + + Tagged ID of the service account. + + - `Optional archivedAt` + + If set, this service account is archived. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `LocalDateTime createdAt` + + When this service account was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Optional description` + + Optional free-text description. + + - `String name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `ADMIN("admin")` + + - `DEVELOPER("developer")` + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this service account was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccount; +import com.anthropic.models.beta.organization.serviceaccounts.ServiceAccountUpdateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaServiceAccount betaServiceAccount = client.beta().organization().serviceAccounts().update("service_account_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +`BetaServiceAccount beta().organization().serviceAccounts().archive(params = ServiceAccountArchiveParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Parameters + +- `ServiceAccountArchiveParams params` + + - `Optional serviceAccountId` + + ID of the service account to archive. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaServiceAccount:` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `String id` + + Tagged ID of the service account. + + - `Optional archivedAt` + + If set, this service account is archived. + + format: date-time + + - `Optional archivedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `LocalDateTime createdAt` + + When this service account was created. + + format: date-time + + - `Optional createdByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `Optional description` + + Optional free-text description. + + - `String name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `ADMIN("admin")` + + - `DEVELOPER("developer")` + + - `JsonValue type constant` + + - `LocalDateTime updatedAt` + + When this service account was last updated. + + format: date-time + + - `Optional updatedByActorId` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccount; +import com.anthropic.models.beta.organization.serviceaccounts.ServiceAccountArchiveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaServiceAccount betaServiceAccount = client.beta().organization().serviceAccounts().archive("service_account_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +`BetaServiceAccountWorkspaceMember beta().organization().serviceAccounts().workspaces().add(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Parameters + +- `WorkspaceAddParams params` + + - `Optional serviceAccountId` + + ID of the service account. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `String workspaceId` + + Tagged workspace ID to add the service account to. + + - `BetaNoBillingWorkspaceRole workspaceRole` + + Role to assign to the service account in this workspace. + +#### Returns + +- `class BetaServiceAccountWorkspaceMember:` + + - `Optional createdByActorId` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `Optional implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `String serviceAccountId` + + Tagged service account ID (`svac_...`). + + - `JsonValue type constant` + + - `String workspaceId` + + Tagged workspace ID (`wrkspc_...`). + + - `BetaWorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccountWorkspaceMember; +import com.anthropic.models.beta.organization.serviceaccounts.workspaces.WorkspaceAddParams; +import com.anthropic.models.beta.organization.workspaces.BetaNoBillingWorkspaceRole; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + WorkspaceAddParams params = WorkspaceAddParams.builder() + .serviceAccountId("service_account_id") + .workspaceId("workspace_id") + .workspaceRole(BetaNoBillingWorkspaceRole.WORKSPACE_ADMIN) + .build(); + BetaServiceAccountWorkspaceMember betaServiceAccountWorkspaceMember = client.beta().organization().serviceAccounts().workspaces().add(params); + } +} +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +`WorkspaceListPage beta().organization().serviceAccounts().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Parameters + +- `WorkspaceListParams params` + + - `Optional serviceAccountId` + + ID of the service account. + + - `Optional limit` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaServiceAccountWorkspaceMember:` + + - `Optional createdByActorId` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `Optional implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `String serviceAccountId` + + Tagged service account ID (`svac_...`). + + - `JsonValue type constant` + + - `String workspaceId` + + Tagged workspace ID (`wrkspc_...`). + + - `BetaWorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.serviceaccounts.workspaces.WorkspaceListPage; +import com.anthropic.models.beta.organization.serviceaccounts.workspaces.WorkspaceListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + WorkspaceListPage page = client.beta().organization().serviceAccounts().workspaces().list("service_account_id"); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +`WorkspaceRemoveResponse beta().organization().serviceAccounts().workspaces().remove(params, requestOptions = RequestOptions.none())` + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Parameters + +- `WorkspaceRemoveParams params` + + - `String serviceAccountId` + + ID of the service account. + + - `Optional workspaceId` + + ID of the workspace. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class WorkspaceRemoveResponse:` + + - `String serviceAccountId` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `JsonValue type constant` + + - `String workspaceId` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.serviceaccounts.workspaces.WorkspaceRemoveParams; +import com.anthropic.models.beta.organization.serviceaccounts.workspaces.WorkspaceRemoveResponse; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + WorkspaceRemoveParams params = WorkspaceRemoveParams.builder() + .serviceAccountId("service_account_id") + .workspaceId("workspace_id") + .build(); + WorkspaceRemoveResponse workspace = client.beta().organization().serviceAccounts().workspaces().remove(params); + } +} +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +`UserListPage beta().organization().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Parameters + +- `UserListParams params` + + - `Optional afterId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `Optional beforeId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `Optional email` + + Filter by user email. + + format: email + + - `Optional limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `Optional> roles` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `class BetaOrganizationUser:` + + - `String id` + + ID of the User. + + - `LocalDateTime addedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `String email` + + Email of the User. + + - `String name` + + Name of the User. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `ADMIN("admin")` + + - `BILLING("billing")` + + - `CLAUDE_CODE_USER("claude_code_user")` + + - `DEVELOPER("developer")` + + - `MANAGED("managed")` + + - `MEMBERSHIP_ADMIN("membership_admin")` + + - `OWNER("owner")` + + - `PRIMARY_OWNER("primary_owner")` + + - `USER("user")` + + - `JsonValue type constant` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.users.UserListPage; +import com.anthropic.models.beta.organization.users.UserListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + UserListPage page = client.beta().organization().users().list(); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +`BetaOrganizationUser beta().organization().users().retrieve(params = UserRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Parameters + +- `UserRetrieveParams params` + + - `Optional userId` + + ID of the User. + +#### Returns + +- `class BetaOrganizationUser:` + + - `String id` + + ID of the User. + + - `LocalDateTime addedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `String email` + + Email of the User. + + - `String name` + + Name of the User. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `ADMIN("admin")` + + - `BILLING("billing")` + + - `CLAUDE_CODE_USER("claude_code_user")` + + - `DEVELOPER("developer")` + + - `MANAGED("managed")` + + - `MEMBERSHIP_ADMIN("membership_admin")` + + - `OWNER("owner")` + + - `PRIMARY_OWNER("primary_owner")` + + - `USER("user")` + + - `JsonValue type constant` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.users.BetaOrganizationUser; +import com.anthropic.models.beta.organization.users.UserRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaOrganizationUser betaOrganizationUser = client.beta().organization().users().retrieve("user_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +`BetaOrganizationUser beta().organization().users().update(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Parameters + +- `UserUpdateParams params` + + - `Optional userId` + + ID of the User. + + - `Role role` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `BILLING("billing")` + + - `CLAUDE_CODE_USER("claude_code_user")` + + - `DEVELOPER("developer")` + + - `MANAGED("managed")` + + - `USER("user")` + +#### Returns + +- `class BetaOrganizationUser:` + + - `String id` + + ID of the User. + + - `LocalDateTime addedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `String email` + + Email of the User. + + - `String name` + + Name of the User. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `ADMIN("admin")` + + - `BILLING("billing")` + + - `CLAUDE_CODE_USER("claude_code_user")` + + - `DEVELOPER("developer")` + + - `MANAGED("managed")` + + - `MEMBERSHIP_ADMIN("membership_admin")` + + - `OWNER("owner")` + + - `PRIMARY_OWNER("primary_owner")` + + - `USER("user")` + + - `JsonValue type constant` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.users.BetaOrganizationUser; +import com.anthropic.models.beta.organization.users.UserUpdateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + UserUpdateParams params = UserUpdateParams.builder() + .userId("user_id") + .role(UserUpdateParams.Role.USER) + .build(); + BetaOrganizationUser betaOrganizationUser = client.beta().organization().users().update(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +`UserRemoveResponse beta().organization().users().remove(params = UserRemoveParams.none(), requestOptions = RequestOptions.none())` + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Parameters + +- `UserRemoveParams params` + + - `Optional userId` + + ID of the User. + +#### Returns + +- `class UserRemoveResponse:` + + - `String id` + + ID of the User. + + - `JsonValue type constant` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.users.UserRemoveParams; +import com.anthropic.models.beta.organization.users.UserRemoveResponse; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + UserRemoveResponse user = client.beta().organization().users().remove("user_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +`WorkspaceListPage beta().organization().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Parameters + +- `WorkspaceListParams params` + + - `Optional afterId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `Optional beforeId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `Optional includeArchived` + + Whether to include Workspaces that have been archived in the response + + - `Optional limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `class BetaWorkspace:` + + - `String id` + + ID of the Workspace. + + - `Optional archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `String compartmentId` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `LocalDateTime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `BetaDataResidency dataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos allowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List` + + - `JsonValue` + + - `String defaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `String workspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `String displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `Optional externalKeyId` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `String name` + + Name of the Workspace. + + - `Tags tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonValue type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.WorkspaceListPage; +import com.anthropic.models.beta.organization.workspaces.WorkspaceListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + WorkspaceListPage page = client.beta().organization().workspaces().list(); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +`BetaWorkspace beta().organization().workspaces().create(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Parameters + +- `WorkspaceCreateParams params` + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + + - `String name` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + + - `Optional dataResidency` + + Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `Optional displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + + - `Optional externalKeyId` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Optional tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `class BetaWorkspace:` + + - `String id` + + ID of the Workspace. + + - `Optional archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `String compartmentId` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `LocalDateTime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `BetaDataResidency dataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos allowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List` + + - `JsonValue` + + - `String defaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `String workspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `String displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `Optional externalKeyId` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `String name` + + Name of the Workspace. + + - `Tags tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonValue type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.BetaWorkspace; +import com.anthropic.models.beta.organization.workspaces.WorkspaceCreateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + WorkspaceCreateParams params = WorkspaceCreateParams.builder() + .name("x") + .build(); + BetaWorkspace betaWorkspace = client.beta().organization().workspaces().create(params); + } +} +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +`BetaWorkspace beta().organization().workspaces().retrieve(params = WorkspaceRetrieveParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Parameters + +- `WorkspaceRetrieveParams params` + + - `Optional workspaceId` + + ID of the Workspace. + +#### Returns + +- `class BetaWorkspace:` + + - `String id` + + ID of the Workspace. + + - `Optional archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `String compartmentId` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `LocalDateTime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `BetaDataResidency dataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos allowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List` + + - `JsonValue` + + - `String defaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `String workspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `String displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `Optional externalKeyId` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `String name` + + Name of the Workspace. + + - `Tags tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonValue type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.BetaWorkspace; +import com.anthropic.models.beta.organization.workspaces.WorkspaceRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaWorkspace betaWorkspace = client.beta().organization().workspaces().retrieve("workspace_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +`BetaWorkspace beta().organization().workspaces().update(params = WorkspaceUpdateParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Parameters + +- `WorkspaceUpdateParams params` + + - `Optional workspaceId` + + - `Optional dataResidency` + + Data residency configuration for the workspace. + + - `Optional displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + + - `Optional externalKeyId` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `Optional name` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + + - `Optional tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `class BetaWorkspace:` + + - `String id` + + ID of the Workspace. + + - `Optional archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `String compartmentId` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `LocalDateTime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `BetaDataResidency dataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos allowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List` + + - `JsonValue` + + - `String defaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `String workspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `String displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `Optional externalKeyId` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `String name` + + Name of the Workspace. + + - `Tags tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonValue type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.BetaWorkspace; +import com.anthropic.models.beta.organization.workspaces.WorkspaceUpdateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaWorkspace betaWorkspace = client.beta().organization().workspaces().update("workspace_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +`BetaWorkspace beta().organization().workspaces().archive(params = WorkspaceArchiveParams.none(), requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Parameters + +- `WorkspaceArchiveParams params` + + - `Optional workspaceId` + +#### Returns + +- `class BetaWorkspace:` + + - `String id` + + ID of the Workspace. + + - `Optional archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `String compartmentId` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `LocalDateTime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `BetaDataResidency dataResidency` + + Data residency configuration. + + - `AllowedInferenceGeos allowedInferenceGeos` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List` + + - `JsonValue` + + - `String defaultInferenceGeo` + + Default inference geo applied when requests omit the parameter. + + - `String workspaceGeo` + + Geographic region for workspace data storage. Immutable after creation. + + - `String displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `Optional externalKeyId` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `String name` + + Name of the Workspace. + + - `Tags tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `JsonValue type constant` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.BetaWorkspace; +import com.anthropic.models.beta.organization.workspaces.WorkspaceArchiveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + BetaWorkspace betaWorkspace = client.beta().organization().workspaces().archive("workspace_id"); + } +} +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +`RateLimitListPage beta().organization().workspaces().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `RateLimitListParams params` + + - `Optional workspaceId` + + The ID of the workspace. + + - `Optional groupType` + + Filter by group type. + + - `BATCH("batch")` + + - `FILES("files")` + + - `MODEL_GROUP("model_group")` + + - `SKILLS("skills")` + + - `TOKEN_COUNT("token_count")` + + - `WEB_SEARCH("web_search")` + + - `Optional limit` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaWorkspaceRateLimit:` + + - `GroupType groupType` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `BATCH("batch")` + + - `FILES("files")` + + - `MODEL_GROUP("model_group")` + + - `SKILLS("skills")` + + - `TOKEN_COUNT("token_count")` + + - `WEB_SEARCH("web_search")` + + - `List limits` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `Optional orgLimit` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `String type` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `long value` + + The workspace-level override value for this limiter type. + + - `Optional> models` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `String rateLimitId` + + The `id` of the RateLimit group this override applies to. + + - `JsonValue type constant` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + - `String workspaceId` + + ID of the Workspace this override applies to. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.ratelimits.RateLimitListPage; +import com.anthropic.models.beta.organization.workspaces.ratelimits.RateLimitListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + RateLimitListPage page = client.beta().organization().workspaces().rateLimits().list("workspace_id"); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +`MemberListPage beta().organization().workspaces().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Parameters + +- `MemberListParams params` + + - `Optional workspaceId` + + ID of the Workspace. + + - `Optional afterId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `Optional beforeId` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `Optional limit` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `class BetaWorkspaceMember:` + + - `JsonValue type constant` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `String userId` + + ID of the User. + + - `String workspaceId` + + ID of the Workspace. + + - `BetaWorkspaceRole workspaceRole` + + Role of the Workspace Member. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.members.MemberListPage; +import com.anthropic.models.beta.organization.workspaces.members.MemberListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + MemberListPage page = client.beta().organization().workspaces().members().list("workspace_id"); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +`BetaWorkspaceMember beta().organization().workspaces().members().add(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Parameters + +- `MemberAddParams params` + + - `Optional workspaceId` + + ID of the Workspace. + + - `String userId` + + ID of the User. + + - `BetaNoBillingWorkspaceRole workspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + +#### Returns + +- `class BetaWorkspaceMember:` + + - `JsonValue type constant` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `String userId` + + ID of the User. + + - `String workspaceId` + + ID of the Workspace. + + - `BetaWorkspaceRole workspaceRole` + + Role of the Workspace Member. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.BetaNoBillingWorkspaceRole; +import com.anthropic.models.beta.organization.workspaces.BetaWorkspaceMember; +import com.anthropic.models.beta.organization.workspaces.members.MemberAddParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + MemberAddParams params = MemberAddParams.builder() + .workspaceId("workspace_id") + .userId("user_01WCz1FkmYMm4gnmykNKUu3Q") + .workspaceRole(BetaNoBillingWorkspaceRole.WORKSPACE_ADMIN) + .build(); + BetaWorkspaceMember betaWorkspaceMember = client.beta().organization().workspaces().members().add(params); + } +} +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +`BetaWorkspaceMember beta().organization().workspaces().members().retrieve(params, requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Parameters + +- `MemberRetrieveParams params` + + - `String workspaceId` + + ID of the Workspace. + + - `Optional userId` + + ID of the User. + +#### Returns + +- `class BetaWorkspaceMember:` + + - `JsonValue type constant` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `String userId` + + ID of the User. + + - `String workspaceId` + + ID of the Workspace. + + - `BetaWorkspaceRole workspaceRole` + + Role of the Workspace Member. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.BetaWorkspaceMember; +import com.anthropic.models.beta.organization.workspaces.members.MemberRetrieveParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + MemberRetrieveParams params = MemberRetrieveParams.builder() + .workspaceId("workspace_id") + .userId("user_id") + .build(); + BetaWorkspaceMember betaWorkspaceMember = client.beta().organization().workspaces().members().retrieve(params); + } +} +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +`BetaWorkspaceMember beta().organization().workspaces().members().update(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Parameters + +- `MemberUpdateParams params` + + - `String workspaceId` + + ID of the Workspace. + + - `Optional userId` + + ID of the User. + + - `BetaWorkspaceRole workspaceRole` + + New workspace role for the User. + +#### Returns + +- `class BetaWorkspaceMember:` + + - `JsonValue type constant` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `String userId` + + ID of the User. + + - `String workspaceId` + + ID of the Workspace. + + - `BetaWorkspaceRole workspaceRole` + + Role of the Workspace Member. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.BetaWorkspaceMember; +import com.anthropic.models.beta.organization.workspaces.BetaWorkspaceRole; +import com.anthropic.models.beta.organization.workspaces.members.MemberUpdateParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + MemberUpdateParams params = MemberUpdateParams.builder() + .workspaceId("workspace_id") + .userId("user_id") + .workspaceRole(BetaWorkspaceRole.WORKSPACE_ADMIN) + .build(); + BetaWorkspaceMember betaWorkspaceMember = client.beta().organization().workspaces().members().update(params); + } +} +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +`MemberRemoveResponse beta().organization().workspaces().members().remove(params, requestOptions = RequestOptions.none())` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Parameters + +- `MemberRemoveParams params` + + - `String workspaceId` + + ID of the Workspace. + + - `Optional userId` + + ID of the User. + +#### Returns + +- `class MemberRemoveResponse:` + + - `JsonValue type constant` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + - `String userId` + + ID of the User. + + - `String workspaceId` + + ID of the Workspace. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.members.MemberRemoveParams; +import com.anthropic.models.beta.organization.workspaces.members.MemberRemoveResponse; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + MemberRemoveParams params = MemberRemoveParams.builder() + .workspaceId("workspace_id") + .userId("user_id") + .build(); + MemberRemoveResponse member = client.beta().organization().workspaces().members().remove(params); + } +} +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +`ServiceAccountListPage beta().organization().workspaces().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Parameters + +- `ServiceAccountListParams params` + + - `Optional workspaceId` + + ID of the workspace. + + - `Optional limit` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + +#### Returns + +- `class BetaServiceAccountWorkspaceMember:` + + - `Optional createdByActorId` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `Optional implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `String serviceAccountId` + + Tagged service account ID (`svac_...`). + + - `JsonValue type constant` + + - `String workspaceId` + + Tagged workspace ID (`wrkspc_...`). + + - `BetaWorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.serviceaccounts.ServiceAccountListPage; +import com.anthropic.models.beta.organization.workspaces.serviceaccounts.ServiceAccountListParams; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ServiceAccountListPage page = client.beta().organization().workspaces().serviceAccounts().list("workspace_id"); + } +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +`BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().add(params, requestOptions = RequestOptions.none())` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Parameters + +- `ServiceAccountAddParams params` + + - `Optional workspaceId` + + ID of the workspace. + + - `Optional> betas` + + Optional header to specify the beta version(s) you want to use. + + - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` + + - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` + + - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` + + - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` + + - `PDFS_2024_09_25("pdfs-2024-09-25")` + + - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` + + - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` + + - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` + + - `FILES_API_2025_04_14("files-api-2025-04-14")` + + - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` + + - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` + + - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` + + - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` + + - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` + + - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` + + - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` + + - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` + + - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` + + - `SKILLS_2025_10_02("skills-2025-10-02")` + + - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` + + - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` + + - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` + + - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` + + - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` + + - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` + + - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` + + - `DREAMING_2026_04_21("dreaming-2026-04-21")` + + - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` + + - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` + + - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` + + - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` + + - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` + + - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` + + - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + + - `COMPACT_2026_01_12("compact-2026-01-12")` - PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - maxLength: 8192 + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` -#### Returns + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` -- `class BetaTunnelCertificate:` + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - A CA certificate attached to a tunnel. + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - - `String id` + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `String serviceAccountId` - - `Optional archivedAt` + Tagged service account ID to add. - A timestamp in RFC 3339 format + - `BetaNoBillingWorkspaceRole workspaceRole` - format: date-time + Role to assign to the service account in this workspace. - - `LocalDateTime createdAt` +#### Returns - A timestamp in RFC 3339 format +- `class BetaServiceAccountWorkspaceMember:` - format: date-time + - `Optional createdByActorId` - - `Optional expiresAt` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - A timestamp in RFC 3339 format + - `Optional implicit` - format: date-time + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - - `String fingerprint` + - `String serviceAccountId` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + Tagged service account ID (`svac_...`). - - `String tunnelId` + - `JsonValue type constant` - ID of the tunnel the certificate is registered against. + - `String workspaceId` - - `JsonValue type constant` + Tagged workspace ID (`wrkspc_...`). + + - `BetaWorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` #### Example @@ -64616,8 +76711,9 @@ package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; -import com.anthropic.models.beta.tunnels.certificates.BetaTunnelCertificate; -import com.anthropic.models.beta.tunnels.certificates.CertificateCreateParams; +import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccountWorkspaceMember; +import com.anthropic.models.beta.organization.workspaces.BetaNoBillingWorkspaceRole; +import com.anthropic.models.beta.organization.workspaces.serviceaccounts.ServiceAccountAddParams; public final class Main { private Main() {} @@ -64625,11 +76721,12 @@ public final class Main { public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); - CertificateCreateParams params = CertificateCreateParams.builder() - .tunnelId("tunnel_id") - .caCertificatePem("ca_certificate_pem") + ServiceAccountAddParams params = ServiceAccountAddParams.builder() + .workspaceId("workspace_id") + .serviceAccountId("service_account_id") + .workspaceRole(BetaNoBillingWorkspaceRole.WORKSPACE_ADMIN) .build(); - BetaTunnelCertificate betaTunnelCertificate = client.beta().tunnels().certificates().create(params); + BetaServiceAccountWorkspaceMember betaServiceAccountWorkspaceMember = client.beta().organization().workspaces().serviceAccounts().add(params); } } ``` @@ -64638,33 +76735,43 @@ public final class Main { ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Get Tunnel Certificate +### Get Service Account Workspace Member -`BetaTunnelCertificate beta().tunnels().certificates().retrieve(params, requestOptions = RequestOptions.none())` +`BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().retrieve(params, requestOptions = RequestOptions.none())` -**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Fetches a tunnel certificate by ID. +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. #### Parameters -- `CertificateRetrieveParams params` +- `ServiceAccountRetrieveParams params` - - `String tunnelId` + - `String workspaceId` - - `Optional certificateId` + ID of the workspace. + + - `Optional serviceAccountId` + + ID of the service account. - `Optional> betas` @@ -64738,43 +76845,55 @@ Fetches a tunnel certificate by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` -#### Returns + - `COMPACT_2026_01_12("compact-2026-01-12")` -- `class BetaTunnelCertificate:` + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - A CA certificate attached to a tunnel. + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - - `String id` + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - - `Optional archivedAt` + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - A timestamp in RFC 3339 format + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - format: date-time +#### Returns - - `LocalDateTime createdAt` +- `class BetaServiceAccountWorkspaceMember:` - A timestamp in RFC 3339 format + - `Optional createdByActorId` - format: date-time + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - - `Optional expiresAt` + - `Optional implicit` - A timestamp in RFC 3339 format + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - format: date-time + - `String serviceAccountId` - - `String fingerprint` + Tagged service account ID (`svac_...`). - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `JsonValue type constant` - - `String tunnelId` + - `String workspaceId` - ID of the tunnel the certificate is registered against. + Tagged workspace ID (`wrkspc_...`). - - `JsonValue type constant` + - `BetaWorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` #### Example @@ -64783,8 +76902,8 @@ package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; -import com.anthropic.models.beta.tunnels.certificates.BetaTunnelCertificate; -import com.anthropic.models.beta.tunnels.certificates.CertificateRetrieveParams; +import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccountWorkspaceMember; +import com.anthropic.models.beta.organization.workspaces.serviceaccounts.ServiceAccountRetrieveParams; public final class Main { private Main() {} @@ -64792,11 +76911,11 @@ public final class Main { public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); - CertificateRetrieveParams params = CertificateRetrieveParams.builder() - .tunnelId("tunnel_id") - .certificateId("certificate_id") + ServiceAccountRetrieveParams params = ServiceAccountRetrieveParams.builder() + .workspaceId("workspace_id") + .serviceAccountId("service_account_id") .build(); - BetaTunnelCertificate betaTunnelCertificate = client.beta().tunnels().certificates().retrieve(params); + BetaServiceAccountWorkspaceMember betaServiceAccountWorkspaceMember = client.beta().organization().workspaces().serviceAccounts().retrieve(params); } } ``` @@ -64805,45 +76924,43 @@ public final class Main { ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### List Tunnel Certificates - -`CertificateListPage beta().tunnels().certificates().list(params = CertificateListParams.none(), requestOptions = RequestOptions.none())` - -**GET** `/v1/tunnels/{tunnel_id}/certificates` +### Update Service Account Workspace Member -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +`BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().update(params, requestOptions = RequestOptions.none())` -Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -#### Parameters +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -- `CertificateListParams params` +Change a service account's role in a workspace. - - `Optional tunnelId` - - - `Optional includeArchived` +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. - Whether to include archived certificates in the results. Defaults to false. +#### Parameters - - `Optional limit` +- `ServiceAccountUpdateParams params` - Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + - `String workspaceId` - format: int32 + ID of the workspace. - - `Optional page` + - `Optional serviceAccountId` - Opaque pagination cursor from a previous `list_tunnel_certificates` response. + ID of the service account. - `Optional> betas` @@ -64917,44 +77034,60 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` -#### Returns - -- `class BetaTunnelCertificate:` + - `COMPACT_2026_01_12("compact-2026-01-12")` - A CA certificate attached to a tunnel. + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - - `String id` + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - - `Optional archivedAt` + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - A timestamp in RFC 3339 format + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - format: date-time + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - - `LocalDateTime createdAt` + - `BetaNoBillingWorkspaceRole workspaceRole` - A timestamp in RFC 3339 format + New role for the service account in this workspace. - format: date-time +#### Returns - - `Optional expiresAt` +- `class BetaServiceAccountWorkspaceMember:` - A timestamp in RFC 3339 format + - `Optional createdByActorId` - format: date-time + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - - `String fingerprint` + - `Optional implicit` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - - `String tunnelId` + - `String serviceAccountId` - ID of the tunnel the certificate is registered against. + Tagged service account ID (`svac_...`). - `JsonValue type constant` + - `String workspaceId` + + Tagged workspace ID (`wrkspc_...`). + + - `BetaWorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `WORKSPACE_ADMIN("workspace_admin")` + + - `WORKSPACE_BILLING("workspace_billing")` + + - `WORKSPACE_DEVELOPER("workspace_developer")` + + - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` + + - `WORKSPACE_USER("workspace_user")` + #### Example ```java @@ -64962,8 +77095,9 @@ package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; -import com.anthropic.models.beta.tunnels.certificates.CertificateListPage; -import com.anthropic.models.beta.tunnels.certificates.CertificateListParams; +import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccountWorkspaceMember; +import com.anthropic.models.beta.organization.workspaces.BetaNoBillingWorkspaceRole; +import com.anthropic.models.beta.organization.workspaces.serviceaccounts.ServiceAccountUpdateParams; public final class Main { private Main() {} @@ -64971,7 +77105,12 @@ public final class Main { public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); - CertificateListPage page = client.beta().tunnels().certificates().list("tunnel_id"); + ServiceAccountUpdateParams params = ServiceAccountUpdateParams.builder() + .workspaceId("workspace_id") + .serviceAccountId("service_account_id") + .workspaceRole(BetaNoBillingWorkspaceRole.WORKSPACE_ADMIN) + .build(); + BetaServiceAccountWorkspaceMember betaServiceAccountWorkspaceMember = client.beta().organization().workspaces().serviceAccounts().update(params); } } ``` @@ -64980,38 +77119,42 @@ public final class Main { ```json { - "data": [ - { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" - } - ], - "next_page": "next_page" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Archive Tunnel Certificate +### Delete Service Account Workspace Member -`BetaTunnelCertificate beta().tunnels().certificates().archive(params, requestOptions = RequestOptions.none())` +`ServiceAccountRemoveResponse beta().organization().workspaces().serviceAccounts().remove(params, requestOptions = RequestOptions.none())` -**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. #### Parameters -- `CertificateArchiveParams params` +- `ServiceAccountRemoveParams params` - - `String tunnelId` + - `String workspaceId` - - `Optional certificateId` + ID of the workspace. + + - `Optional serviceAccountId` + + ID of the service account. - `Optional> betas` @@ -65085,44 +77228,167 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns -- `class BetaTunnelCertificate:` +- `class ServiceAccountRemoveResponse:` - A CA certificate attached to a tunnel. + - `String serviceAccountId` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `JsonValue type constant` + + - `String workspaceId` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```java +package com.anthropic.example; + +import com.anthropic.client.AnthropicClient; +import com.anthropic.client.okhttp.AnthropicOkHttpClient; +import com.anthropic.models.beta.organization.workspaces.serviceaccounts.ServiceAccountRemoveParams; +import com.anthropic.models.beta.organization.workspaces.serviceaccounts.ServiceAccountRemoveResponse; + +public final class Main { + private Main() {} + + public static void main(String[] args) { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + ServiceAccountRemoveParams params = ServiceAccountRemoveParams.builder() + .workspaceId("workspace_id") + .serviceAccountId("service_account_id") + .build(); + ServiceAccountRemoveResponse serviceAccount = client.beta().organization().workspaces().serviceAccounts().remove(params); + } +} +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Rate Limits + +### List Organization Rate Limits + +`RateLimitListPage beta().organization().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())` + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `RateLimitListParams params` + + - `Optional groupType` + + Filter by group type. + + - `BATCH("batch")` + + - `FILES("files")` + + - `MODEL_GROUP("model_group")` + + - `SKILLS("skills")` + + - `TOKEN_COUNT("token_count")` + + - `WEB_SEARCH("web_search")` + + - `Optional limit` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + + - `Optional model` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + + - `Optional page` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaOrganizationRateLimit:` - `String id` - Unique identifier for the certificate, prefixed with `tcrt_`. + Stable identifier for this rate-limit group within the organization. - - `Optional archivedAt` + - `GroupType groupType` - A timestamp in RFC 3339 format + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. - format: date-time + - `BATCH("batch")` - - `LocalDateTime createdAt` + - `FILES("files")` - A timestamp in RFC 3339 format + - `MODEL_GROUP("model_group")` - format: date-time + - `SKILLS("skills")` - - `Optional expiresAt` + - `TOKEN_COUNT("token_count")` - A timestamp in RFC 3339 format + - `WEB_SEARCH("web_search")` - format: date-time + - `List limits` - - `String fingerprint` + The limiter values that apply to this group. - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `String type` - - `String tunnelId` + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - ID of the tunnel the certificate is registered against. + - `long value` + + The configured limit value for this limiter type. + + - `Optional> models` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. - `JsonValue type constant` + Object type. Always `rate_limit` for organization rate-limit entries. + #### Example ```java @@ -65130,8 +77396,8 @@ package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; -import com.anthropic.models.beta.tunnels.certificates.BetaTunnelCertificate; -import com.anthropic.models.beta.tunnels.certificates.CertificateArchiveParams; +import com.anthropic.models.beta.organization.ratelimits.RateLimitListPage; +import com.anthropic.models.beta.organization.ratelimits.RateLimitListParams; public final class Main { private Main() {} @@ -65139,11 +77405,7 @@ public final class Main { public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); - CertificateArchiveParams params = CertificateArchiveParams.builder() - .tunnelId("tunnel_id") - .certificateId("certificate_id") - .build(); - BetaTunnelCertificate betaTunnelCertificate = client.beta().tunnels().certificates().archive(params); + RateLimitListPage page = client.beta().organization().rateLimits().list(); } } ``` @@ -65152,12 +77414,22 @@ public final class Main { ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" } ``` diff --git a/content/en/api/java/beta/agents.md b/content/en/api/java/beta/agents.md index 1d0009549..96ae5703a 100644 --- a/content/en/api/java/beta/agents.md +++ b/content/en/api/java/beta/agents.md @@ -84,6 +84,20 @@ Create Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Model model` Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control @@ -1419,6 +1433,20 @@ List Agents - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsAgent:` @@ -2136,6 +2164,20 @@ Get Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsAgent:` @@ -2842,6 +2884,20 @@ Update Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional description` Description. Omit to preserve; send empty string or null to clear. @@ -4154,6 +4210,20 @@ Archive Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsAgent:` @@ -8572,6 +8642,20 @@ List Agent Versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/java/beta/agents/archive.md b/content/en/api/java/beta/agents/archive.md index 7ba524ec6..17f6a8f38 100644 --- a/content/en/api/java/beta/agents/archive.md +++ b/content/en/api/java/beta/agents/archive.md @@ -84,6 +84,20 @@ Archive Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/java/beta/agents/create.md b/content/en/api/java/beta/agents/create.md index 9196ba5d3..8dd2a20e3 100644 --- a/content/en/api/java/beta/agents/create.md +++ b/content/en/api/java/beta/agents/create.md @@ -82,6 +82,20 @@ Create Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Model model` Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control diff --git a/content/en/api/java/beta/agents/list.md b/content/en/api/java/beta/agents/list.md index ab9e51097..e3ec9417e 100644 --- a/content/en/api/java/beta/agents/list.md +++ b/content/en/api/java/beta/agents/list.md @@ -108,6 +108,20 @@ List Agents - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/java/beta/agents/retrieve.md b/content/en/api/java/beta/agents/retrieve.md index 9b27e0e6b..9057b936b 100644 --- a/content/en/api/java/beta/agents/retrieve.md +++ b/content/en/api/java/beta/agents/retrieve.md @@ -90,6 +90,20 @@ Get Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/java/beta/agents/update.md b/content/en/api/java/beta/agents/update.md index 2d59f161d..97707bb3e 100644 --- a/content/en/api/java/beta/agents/update.md +++ b/content/en/api/java/beta/agents/update.md @@ -84,6 +84,20 @@ Update Agent - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional description` Description. Omit to preserve; send empty string or null to clear. diff --git a/content/en/api/java/beta/agents/versions.md b/content/en/api/java/beta/agents/versions.md index 0861a55d2..968ce2bf3 100644 --- a/content/en/api/java/beta/agents/versions.md +++ b/content/en/api/java/beta/agents/versions.md @@ -96,6 +96,20 @@ List Agent Versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/java/beta/agents/versions/list.md b/content/en/api/java/beta/agents/versions/list.md index 55fc007fd..54bf422c3 100644 --- a/content/en/api/java/beta/agents/versions/list.md +++ b/content/en/api/java/beta/agents/versions/list.md @@ -94,6 +94,20 @@ List Agent Versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsAgent:` diff --git a/content/en/api/java/beta/deployment_runs.md b/content/en/api/java/beta/deployment_runs.md index 7f9de2b15..666ba0c48 100644 --- a/content/en/api/java/beta/deployment_runs.md +++ b/content/en/api/java/beta/deployment_runs.md @@ -130,6 +130,20 @@ List Deployment Runs - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeploymentRun:` @@ -491,6 +505,20 @@ Get Deployment Run - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeploymentRun:` diff --git a/content/en/api/java/beta/deployment_runs/list.md b/content/en/api/java/beta/deployment_runs/list.md index 685c3887a..dbec8dcc4 100644 --- a/content/en/api/java/beta/deployment_runs/list.md +++ b/content/en/api/java/beta/deployment_runs/list.md @@ -128,6 +128,20 @@ List Deployment Runs - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeploymentRun:` diff --git a/content/en/api/java/beta/deployment_runs/retrieve.md b/content/en/api/java/beta/deployment_runs/retrieve.md index a36cd28de..6f056686d 100644 --- a/content/en/api/java/beta/deployment_runs/retrieve.md +++ b/content/en/api/java/beta/deployment_runs/retrieve.md @@ -84,6 +84,20 @@ Get Deployment Run - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeploymentRun:` diff --git a/content/en/api/java/beta/deployments.md b/content/en/api/java/beta/deployments.md index 263792949..e7cec697f 100644 --- a/content/en/api/java/beta/deployments.md +++ b/content/en/api/java/beta/deployments.md @@ -84,6 +84,20 @@ Create Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Agent agent` Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived. @@ -1190,6 +1204,20 @@ List Deployments - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -1885,6 +1913,20 @@ Get Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -2575,6 +2617,20 @@ Update Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional agent` Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared. @@ -3637,6 +3693,20 @@ Archive Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -4327,6 +4397,20 @@ Run Deployment Now - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeploymentRun:` @@ -4683,6 +4767,20 @@ Pause Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeployment:` @@ -5373,6 +5471,20 @@ Unpause Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/java/beta/deployments/archive.md b/content/en/api/java/beta/deployments/archive.md index 13feba5e9..b410e7302 100644 --- a/content/en/api/java/beta/deployments/archive.md +++ b/content/en/api/java/beta/deployments/archive.md @@ -84,6 +84,20 @@ Archive Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/java/beta/deployments/create.md b/content/en/api/java/beta/deployments/create.md index fc902d407..132e01f11 100644 --- a/content/en/api/java/beta/deployments/create.md +++ b/content/en/api/java/beta/deployments/create.md @@ -82,6 +82,20 @@ Create Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Agent agent` Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived. diff --git a/content/en/api/java/beta/deployments/list.md b/content/en/api/java/beta/deployments/list.md index 721bba511..3a5982c54 100644 --- a/content/en/api/java/beta/deployments/list.md +++ b/content/en/api/java/beta/deployments/list.md @@ -116,6 +116,20 @@ List Deployments - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/java/beta/deployments/pause.md b/content/en/api/java/beta/deployments/pause.md index db4ce5235..2bf0fbd26 100644 --- a/content/en/api/java/beta/deployments/pause.md +++ b/content/en/api/java/beta/deployments/pause.md @@ -84,6 +84,20 @@ Pause Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/java/beta/deployments/retrieve.md b/content/en/api/java/beta/deployments/retrieve.md index 8d48b3825..b21440632 100644 --- a/content/en/api/java/beta/deployments/retrieve.md +++ b/content/en/api/java/beta/deployments/retrieve.md @@ -84,6 +84,20 @@ Get Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/java/beta/deployments/run.md b/content/en/api/java/beta/deployments/run.md index 2ad6627f4..4dbea2cfc 100644 --- a/content/en/api/java/beta/deployments/run.md +++ b/content/en/api/java/beta/deployments/run.md @@ -84,6 +84,20 @@ Run Deployment Now - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeploymentRun:` diff --git a/content/en/api/java/beta/deployments/unpause.md b/content/en/api/java/beta/deployments/unpause.md index 2d9491bed..1c927d1dc 100644 --- a/content/en/api/java/beta/deployments/unpause.md +++ b/content/en/api/java/beta/deployments/unpause.md @@ -84,6 +84,20 @@ Unpause Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeployment:` diff --git a/content/en/api/java/beta/deployments/update.md b/content/en/api/java/beta/deployments/update.md index e7e8f8c49..37fac0d53 100644 --- a/content/en/api/java/beta/deployments/update.md +++ b/content/en/api/java/beta/deployments/update.md @@ -84,6 +84,20 @@ Update Deployment - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional agent` Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared. diff --git a/content/en/api/java/beta/environments.md b/content/en/api/java/beta/environments.md index ebdec25f4..ea8a1eaa0 100644 --- a/content/en/api/java/beta/environments.md +++ b/content/en/api/java/beta/environments.md @@ -84,6 +84,20 @@ Create a new environment with the specified configuration. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String name` Human-readable name for the environment @@ -134,7 +148,7 @@ Create a new environment with the specified configuration. - `Optional allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `Optional> allowedHosts` @@ -146,6 +160,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Optional> apt` Ubuntu/Debian packages to install @@ -501,6 +517,20 @@ List environments with pagination support. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaEnvironment:` @@ -792,6 +822,20 @@ Retrieve a specific environment by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaEnvironment:` @@ -1078,6 +1122,20 @@ Update an existing environment's configuration. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional config` Updated environment configuration @@ -1122,7 +1180,7 @@ Update an existing environment's configuration. - `Optional allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `Optional> allowedHosts` @@ -1134,6 +1192,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Optional> apt` Ubuntu/Debian packages to install @@ -1480,6 +1540,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaEnvironmentDeleteResponse:` @@ -1610,6 +1684,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaEnvironment:` @@ -1928,7 +2016,7 @@ public final class Main { - `Optional allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `Optional> allowedHosts` @@ -1940,6 +2028,8 @@ public final class Main { When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Optional> apt` Ubuntu/Debian packages to install @@ -2153,7 +2243,7 @@ public final class Main { - `Optional allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `Optional> allowedHosts` @@ -2201,6 +2291,8 @@ public final class Main { When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Optional> apt` Ubuntu/Debian packages to install @@ -2351,6 +2443,20 @@ Retrieve detailed information about a specific work item. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWork:` @@ -2581,6 +2687,20 @@ Long poll for work items in the queue. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional anthropicWorkerId` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -2802,6 +2922,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWork:` @@ -3030,6 +3164,20 @@ Record a heartbeat for a work item to maintain the lease. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWorkHeartbeatResponse:` @@ -3193,6 +3341,20 @@ Stop a work item, initiating graceful or forced shutdown. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaSelfHostedWorkStopRequest betaSelfHostedWorkStopRequest` Request to stop a work item. @@ -3427,6 +3589,20 @@ List work items in an environment. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWork:` @@ -3648,6 +3824,20 @@ Update work item metadata with merge semantics. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaSelfHostedWorkUpdateRequest betaSelfHostedWorkUpdateRequest` Request to update work item metadata. @@ -3875,6 +4065,20 @@ Get statistics about the work queue for an environment. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaSelfHostedWorkQueueStats:` diff --git a/content/en/api/java/beta/environments/archive.md b/content/en/api/java/beta/environments/archive.md index 5bafac7ba..c7bebeec5 100644 --- a/content/en/api/java/beta/environments/archive.md +++ b/content/en/api/java/beta/environments/archive.md @@ -84,6 +84,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaEnvironment:` diff --git a/content/en/api/java/beta/environments/create.md b/content/en/api/java/beta/environments/create.md index c87643bc2..e504f5770 100644 --- a/content/en/api/java/beta/environments/create.md +++ b/content/en/api/java/beta/environments/create.md @@ -82,6 +82,20 @@ Create a new environment with the specified configuration. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String name` Human-readable name for the environment @@ -132,7 +146,7 @@ Create a new environment with the specified configuration. - `Optional allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `Optional> allowedHosts` @@ -144,6 +158,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Optional> apt` Ubuntu/Debian packages to install diff --git a/content/en/api/java/beta/environments/delete.md b/content/en/api/java/beta/environments/delete.md index 0fee56738..d0cb8cf36 100644 --- a/content/en/api/java/beta/environments/delete.md +++ b/content/en/api/java/beta/environments/delete.md @@ -84,6 +84,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaEnvironmentDeleteResponse:` diff --git a/content/en/api/java/beta/environments/list.md b/content/en/api/java/beta/environments/list.md index 9f12b5345..70ddcd03d 100644 --- a/content/en/api/java/beta/environments/list.md +++ b/content/en/api/java/beta/environments/list.md @@ -96,6 +96,20 @@ List environments with pagination support. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaEnvironment:` diff --git a/content/en/api/java/beta/environments/retrieve.md b/content/en/api/java/beta/environments/retrieve.md index e975417d7..5b5def50b 100644 --- a/content/en/api/java/beta/environments/retrieve.md +++ b/content/en/api/java/beta/environments/retrieve.md @@ -84,6 +84,20 @@ Retrieve a specific environment by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaEnvironment:` diff --git a/content/en/api/java/beta/environments/update.md b/content/en/api/java/beta/environments/update.md index 1a190eb9e..71cac5f77 100644 --- a/content/en/api/java/beta/environments/update.md +++ b/content/en/api/java/beta/environments/update.md @@ -84,6 +84,20 @@ Update an existing environment's configuration. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional config` Updated environment configuration @@ -128,7 +142,7 @@ Update an existing environment's configuration. - `Optional allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `Optional> allowedHosts` @@ -140,6 +154,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `Optional> apt` Ubuntu/Debian packages to install diff --git a/content/en/api/java/beta/environments/work.md b/content/en/api/java/beta/environments/work.md index 851c78e05..654018cf5 100644 --- a/content/en/api/java/beta/environments/work.md +++ b/content/en/api/java/beta/environments/work.md @@ -90,6 +90,20 @@ Retrieve detailed information about a specific work item. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaSelfHostedWork:` @@ -320,6 +334,20 @@ Long poll for work items in the queue. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional anthropicWorkerId` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -541,6 +569,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaSelfHostedWork:` @@ -769,6 +811,20 @@ Record a heartbeat for a work item to maintain the lease. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaSelfHostedWorkHeartbeatResponse:` @@ -932,6 +988,20 @@ Stop a work item, initiating graceful or forced shutdown. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaSelfHostedWorkStopRequest betaSelfHostedWorkStopRequest` Request to stop a work item. @@ -1166,6 +1236,20 @@ List work items in an environment. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaSelfHostedWork:` @@ -1387,6 +1471,20 @@ Update work item metadata with merge semantics. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaSelfHostedWorkUpdateRequest betaSelfHostedWorkUpdateRequest` Request to update work item metadata. @@ -1614,6 +1712,20 @@ Get statistics about the work queue for an environment. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaSelfHostedWorkQueueStats:` diff --git a/content/en/api/java/beta/environments/work/ack.md b/content/en/api/java/beta/environments/work/ack.md index 3a7a1a1b4..db573a608 100644 --- a/content/en/api/java/beta/environments/work/ack.md +++ b/content/en/api/java/beta/environments/work/ack.md @@ -88,6 +88,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaSelfHostedWork:` diff --git a/content/en/api/java/beta/environments/work/heartbeat.md b/content/en/api/java/beta/environments/work/heartbeat.md index 8a904cb97..d4e49b38f 100644 --- a/content/en/api/java/beta/environments/work/heartbeat.md +++ b/content/en/api/java/beta/environments/work/heartbeat.md @@ -96,6 +96,20 @@ Record a heartbeat for a work item to maintain the lease. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaSelfHostedWorkHeartbeatResponse:` diff --git a/content/en/api/java/beta/environments/work/list.md b/content/en/api/java/beta/environments/work/list.md index fa785d668..6b0ca428a 100644 --- a/content/en/api/java/beta/environments/work/list.md +++ b/content/en/api/java/beta/environments/work/list.md @@ -96,6 +96,20 @@ List work items in an environment. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaSelfHostedWork:` diff --git a/content/en/api/java/beta/environments/work/poll.md b/content/en/api/java/beta/environments/work/poll.md index 5a4fecd40..868d6441f 100644 --- a/content/en/api/java/beta/environments/work/poll.md +++ b/content/en/api/java/beta/environments/work/poll.md @@ -98,6 +98,20 @@ Long poll for work items in the queue. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional anthropicWorkerId` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console diff --git a/content/en/api/java/beta/environments/work/retrieve.md b/content/en/api/java/beta/environments/work/retrieve.md index ce1e99904..4ff6bcaab 100644 --- a/content/en/api/java/beta/environments/work/retrieve.md +++ b/content/en/api/java/beta/environments/work/retrieve.md @@ -88,6 +88,20 @@ Retrieve detailed information about a specific work item. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaSelfHostedWork:` diff --git a/content/en/api/java/beta/environments/work/stats.md b/content/en/api/java/beta/environments/work/stats.md index 645e03a33..5b4345bc3 100644 --- a/content/en/api/java/beta/environments/work/stats.md +++ b/content/en/api/java/beta/environments/work/stats.md @@ -84,6 +84,20 @@ Get statistics about the work queue for an environment. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaSelfHostedWorkQueueStats:` diff --git a/content/en/api/java/beta/environments/work/stop.md b/content/en/api/java/beta/environments/work/stop.md index b44e6d3a4..5eb22a9d2 100644 --- a/content/en/api/java/beta/environments/work/stop.md +++ b/content/en/api/java/beta/environments/work/stop.md @@ -88,6 +88,20 @@ Stop a work item, initiating graceful or forced shutdown. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaSelfHostedWorkStopRequest betaSelfHostedWorkStopRequest` Request to stop a work item. diff --git a/content/en/api/java/beta/environments/work/update.md b/content/en/api/java/beta/environments/work/update.md index 492b1e87e..507d6da7e 100644 --- a/content/en/api/java/beta/environments/work/update.md +++ b/content/en/api/java/beta/environments/work/update.md @@ -88,6 +88,20 @@ Update work item metadata with merge semantics. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaSelfHostedWorkUpdateRequest betaSelfHostedWorkUpdateRequest` Request to update work item metadata. diff --git a/content/en/api/java/beta/files.md b/content/en/api/java/beta/files.md index 43eac6409..ef9b9e248 100644 --- a/content/en/api/java/beta/files.md +++ b/content/en/api/java/beta/files.md @@ -84,6 +84,20 @@ Upload File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String file` The file to upload @@ -293,6 +307,20 @@ List Files - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaFileMetadata:` @@ -483,6 +511,20 @@ Download File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Example ```java @@ -592,6 +634,20 @@ Get File Metadata - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaFileMetadata:` @@ -775,6 +831,20 @@ Delete File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaDeletedFile:` diff --git a/content/en/api/java/beta/files/delete.md b/content/en/api/java/beta/files/delete.md index 439d11251..97f447b4b 100644 --- a/content/en/api/java/beta/files/delete.md +++ b/content/en/api/java/beta/files/delete.md @@ -86,6 +86,20 @@ Delete File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaDeletedFile:` diff --git a/content/en/api/java/beta/files/download.md b/content/en/api/java/beta/files/download.md index 8b70a408f..1a2002bb5 100644 --- a/content/en/api/java/beta/files/download.md +++ b/content/en/api/java/beta/files/download.md @@ -86,6 +86,20 @@ Download File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Example ```java diff --git a/content/en/api/java/beta/files/list.md b/content/en/api/java/beta/files/list.md index d4b058b77..990645e5a 100644 --- a/content/en/api/java/beta/files/list.md +++ b/content/en/api/java/beta/files/list.md @@ -102,6 +102,20 @@ List Files - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaFileMetadata:` diff --git a/content/en/api/java/beta/files/retrieve_metadata.md b/content/en/api/java/beta/files/retrieve_metadata.md index 977b9fee6..1e9ccb4e7 100644 --- a/content/en/api/java/beta/files/retrieve_metadata.md +++ b/content/en/api/java/beta/files/retrieve_metadata.md @@ -86,6 +86,20 @@ Get File Metadata - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaFileMetadata:` diff --git a/content/en/api/java/beta/files/upload.md b/content/en/api/java/beta/files/upload.md index 8806e8233..53d94d7d5 100644 --- a/content/en/api/java/beta/files/upload.md +++ b/content/en/api/java/beta/files/upload.md @@ -82,6 +82,20 @@ Upload File - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String file` The file to upload diff --git a/content/en/api/java/beta/memory_stores.md b/content/en/api/java/beta/memory_stores.md index 03da4bbcc..294194841 100644 --- a/content/en/api/java/beta/memory_stores.md +++ b/content/en/api/java/beta/memory_stores.md @@ -84,6 +84,20 @@ Create a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String name` Human-readable name for the store. Required; 1–255 characters; no control characters. The mount-path slug under `/mnt/memory/` is derived from this name (lowercased, non-alphanumeric runs collapsed to a hyphen). Names need not be unique within a workspace. @@ -293,6 +307,20 @@ List memory stores - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsMemoryStore:` @@ -464,6 +492,20 @@ Retrieve a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsMemoryStore:` @@ -630,6 +672,20 @@ Update a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional description` New description for the store, up to 1024 characters. Pass an empty string to clear it. @@ -812,6 +868,20 @@ Delete a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeletedMemoryStore:` @@ -940,6 +1010,20 @@ Archive a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsMemoryStore:` @@ -1168,6 +1252,20 @@ Create a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional content` UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `""` explicitly to create an empty memory. @@ -1210,7 +1308,7 @@ Create a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -1381,6 +1479,20 @@ List memories - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryListItem: union` @@ -1417,7 +1529,7 @@ List memories - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -1580,6 +1692,20 @@ Retrieve a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemory:` @@ -1612,7 +1738,7 @@ Retrieve a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -1764,6 +1890,20 @@ Update a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional content` New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). @@ -1810,7 +1950,7 @@ Update a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -1962,11 +2102,25 @@ Delete a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `String id` @@ -2142,11 +2296,25 @@ List memory versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -2160,7 +2328,7 @@ List memory versions - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` @@ -2402,11 +2570,25 @@ Retrieve a memory version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -2420,7 +2602,7 @@ Retrieve a memory version - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` @@ -2657,11 +2839,25 @@ Redact a memory version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -2675,7 +2871,7 @@ Redact a memory version - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` diff --git a/content/en/api/java/beta/memory_stores/archive.md b/content/en/api/java/beta/memory_stores/archive.md index bd86e7f0a..a2cf8ca4a 100644 --- a/content/en/api/java/beta/memory_stores/archive.md +++ b/content/en/api/java/beta/memory_stores/archive.md @@ -84,6 +84,20 @@ Archive a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsMemoryStore:` diff --git a/content/en/api/java/beta/memory_stores/create.md b/content/en/api/java/beta/memory_stores/create.md index 259eb77ad..cba859d79 100644 --- a/content/en/api/java/beta/memory_stores/create.md +++ b/content/en/api/java/beta/memory_stores/create.md @@ -82,6 +82,20 @@ Create a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String name` Human-readable name for the store. Required; 1–255 characters; no control characters. The mount-path slug under `/mnt/memory/` is derived from this name (lowercased, non-alphanumeric runs collapsed to a hyphen). Names need not be unique within a workspace. diff --git a/content/en/api/java/beta/memory_stores/delete.md b/content/en/api/java/beta/memory_stores/delete.md index 171e8baeb..23695de20 100644 --- a/content/en/api/java/beta/memory_stores/delete.md +++ b/content/en/api/java/beta/memory_stores/delete.md @@ -84,6 +84,20 @@ Delete a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeletedMemoryStore:` diff --git a/content/en/api/java/beta/memory_stores/list.md b/content/en/api/java/beta/memory_stores/list.md index e79983b93..d3e76fdd3 100644 --- a/content/en/api/java/beta/memory_stores/list.md +++ b/content/en/api/java/beta/memory_stores/list.md @@ -108,6 +108,20 @@ List memory stores - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsMemoryStore:` diff --git a/content/en/api/java/beta/memory_stores/memories.md b/content/en/api/java/beta/memory_stores/memories.md index b78533f0c..2451e6f51 100644 --- a/content/en/api/java/beta/memory_stores/memories.md +++ b/content/en/api/java/beta/memory_stores/memories.md @@ -90,6 +90,20 @@ Create a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional content` UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `""` explicitly to create an empty memory. @@ -132,7 +146,7 @@ Create a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -303,6 +317,20 @@ List memories - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsMemoryListItem: union` @@ -339,7 +367,7 @@ List memories - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -502,6 +530,20 @@ Retrieve a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsMemory:` @@ -534,7 +576,7 @@ Retrieve a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -686,6 +728,20 @@ Update a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional content` New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). @@ -732,7 +788,7 @@ Update a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -884,11 +940,25 @@ Delete a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `String id` @@ -956,7 +1026,7 @@ public final class Main { - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `String id` @@ -1076,7 +1146,7 @@ public final class Main { - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` @@ -1130,7 +1200,7 @@ public final class Main { - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` diff --git a/content/en/api/java/beta/memory_stores/memories/create.md b/content/en/api/java/beta/memory_stores/memories/create.md index a47b8c226..de3f32c16 100644 --- a/content/en/api/java/beta/memory_stores/memories/create.md +++ b/content/en/api/java/beta/memory_stores/memories/create.md @@ -88,6 +88,20 @@ Create a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional content` UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `""` explicitly to create an empty memory. @@ -130,7 +144,7 @@ Create a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` diff --git a/content/en/api/java/beta/memory_stores/memories/delete.md b/content/en/api/java/beta/memory_stores/memories/delete.md index 6f409ab01..74cf86ebd 100644 --- a/content/en/api/java/beta/memory_stores/memories/delete.md +++ b/content/en/api/java/beta/memory_stores/memories/delete.md @@ -90,11 +90,25 @@ Delete a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeletedMemory:` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `String id` diff --git a/content/en/api/java/beta/memory_stores/memories/list.md b/content/en/api/java/beta/memory_stores/memories/list.md index 981fde615..41d5567b3 100644 --- a/content/en/api/java/beta/memory_stores/memories/list.md +++ b/content/en/api/java/beta/memory_stores/memories/list.md @@ -108,6 +108,20 @@ List memories - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsMemoryListItem: union` @@ -144,7 +158,7 @@ List memories - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` diff --git a/content/en/api/java/beta/memory_stores/memories/retrieve.md b/content/en/api/java/beta/memory_stores/memories/retrieve.md index 1f43040f4..f6f019765 100644 --- a/content/en/api/java/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/java/beta/memory_stores/memories/retrieve.md @@ -90,6 +90,20 @@ Retrieve a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsMemory:` @@ -122,7 +136,7 @@ Retrieve a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` diff --git a/content/en/api/java/beta/memory_stores/memories/update.md b/content/en/api/java/beta/memory_stores/memories/update.md index 092f664fa..a4ec4be71 100644 --- a/content/en/api/java/beta/memory_stores/memories/update.md +++ b/content/en/api/java/beta/memory_stores/memories/update.md @@ -90,6 +90,20 @@ Update a memory - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional content` New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). @@ -136,7 +150,7 @@ Update a memory - `String memoryVersionId` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `String path` diff --git a/content/en/api/java/beta/memory_stores/memory_versions.md b/content/en/api/java/beta/memory_stores/memory_versions.md index c2781ad2e..0872b0f98 100644 --- a/content/en/api/java/beta/memory_stores/memory_versions.md +++ b/content/en/api/java/beta/memory_stores/memory_versions.md @@ -132,11 +132,25 @@ List memory versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -150,7 +164,7 @@ List memory versions - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` @@ -392,11 +406,25 @@ Retrieve a memory version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -410,7 +438,7 @@ Retrieve a memory version - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` @@ -647,11 +675,25 @@ Redact a memory version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -665,7 +707,7 @@ Redact a memory version - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` @@ -888,7 +930,7 @@ public final class Main { - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -902,7 +944,7 @@ public final class Main { - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` diff --git a/content/en/api/java/beta/memory_stores/memory_versions/list.md b/content/en/api/java/beta/memory_stores/memory_versions/list.md index b82e913e1..9e0d4f203 100644 --- a/content/en/api/java/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/java/beta/memory_stores/memory_versions/list.md @@ -130,11 +130,25 @@ List memory versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -148,7 +162,7 @@ List memory versions - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` diff --git a/content/en/api/java/beta/memory_stores/memory_versions/redact.md b/content/en/api/java/beta/memory_stores/memory_versions/redact.md index 48aea10d0..cccce8496 100644 --- a/content/en/api/java/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/java/beta/memory_stores/memory_versions/redact.md @@ -86,11 +86,25 @@ Redact a memory version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -104,7 +118,7 @@ Redact a memory version - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` diff --git a/content/en/api/java/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/java/beta/memory_stores/memory_versions/retrieve.md index 65cc7c0e0..68d001bd6 100644 --- a/content/en/api/java/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/java/beta/memory_stores/memory_versions/retrieve.md @@ -90,11 +90,25 @@ Retrieve a memory version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsMemoryVersion:` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `String id` @@ -108,7 +122,7 @@ Retrieve a memory version - `String memoryId` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `String memoryStoreId` diff --git a/content/en/api/java/beta/memory_stores/retrieve.md b/content/en/api/java/beta/memory_stores/retrieve.md index 22d6f5eeb..a79591c4f 100644 --- a/content/en/api/java/beta/memory_stores/retrieve.md +++ b/content/en/api/java/beta/memory_stores/retrieve.md @@ -84,6 +84,20 @@ Retrieve a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsMemoryStore:` diff --git a/content/en/api/java/beta/memory_stores/update.md b/content/en/api/java/beta/memory_stores/update.md index 2fbed9350..aaa09b809 100644 --- a/content/en/api/java/beta/memory_stores/update.md +++ b/content/en/api/java/beta/memory_stores/update.md @@ -84,6 +84,20 @@ Update a memory store - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional description` New description for the store, up to 1024 characters. Pass an empty string to clear it. diff --git a/content/en/api/java/beta/messages.md b/content/en/api/java/beta/messages.md index 966c5f35c..7ce86e39e 100644 --- a/content/en/api/java/beta/messages.md +++ b/content/en/api/java/beta/messages.md @@ -88,6 +88,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -4880,12 +4894,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -5183,12 +5199,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -5585,6 +5603,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -17138,6 +17170,8 @@ public final class Main { - `OMITTED("omitted")` + - `UPDATES("updates")` + - `class BetaThinkingConfigDisabled:` - `JsonValue type constant` @@ -17154,6 +17188,8 @@ public final class Main { - `OMITTED("omitted")` + - `UPDATES("updates")` + ### Beta Fallback Refusal Trigger - `class BetaFallbackRefusalTrigger:` @@ -17340,6 +17376,8 @@ public final class Main { - `OMITTED("omitted")` + - `UPDATES("updates")` + - `class BetaThinkingConfigDisabled:` - `JsonValue type constant` @@ -17356,6 +17394,8 @@ public final class Main { - `OMITTED("omitted")` + - `UPDATES("updates")` + - `JsonValue` ### Beta File Document Source @@ -19316,12 +19356,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -19645,12 +19687,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -22969,12 +23013,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -24543,12 +24589,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -26075,12 +26123,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -26372,12 +26422,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -28583,6 +28635,8 @@ public final class Main { - `OMITTED("omitted")` + - `UPDATES("updates")` + ### Beta Thinking Config Disabled - `class BetaThinkingConfigDisabled:` @@ -28613,6 +28667,8 @@ public final class Main { - `OMITTED("omitted")` + - `UPDATES("updates")` + ### Beta Thinking Config Param - `class BetaThinkingConfigParam: union` @@ -28645,6 +28701,8 @@ public final class Main { - `OMITTED("omitted")` + - `UPDATES("updates")` + - `class BetaThinkingConfigDisabled:` - `JsonValue type constant` @@ -28661,6 +28719,8 @@ public final class Main { - `OMITTED("omitted")` + - `UPDATES("updates")` + ### Beta Thinking Delta - `class BetaThinkingDelta:` @@ -32475,12 +32535,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -34678,6 +34740,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -36376,6 +36452,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `OMITTED("omitted")` + - `UPDATES("updates")` + - `class BetaThinkingConfigDisabled:` - `JsonValue type constant` @@ -36392,6 +36470,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `OMITTED("omitted")` + - `UPDATES("updates")` + - `JsonValue` - `Optional inferenceGeo` @@ -38728,6 +38808,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaMessageBatch:` @@ -38972,6 +39066,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaMessageBatch:` @@ -39213,6 +39321,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaMessageBatch:` @@ -39447,6 +39569,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaDeletedMessageBatch:` @@ -39583,6 +39719,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaMessageBatchIndividualResponse:` @@ -40886,12 +41036,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. diff --git a/content/en/api/java/beta/messages/batches.md b/content/en/api/java/beta/messages/batches.md index 0c3fcd66e..009413068 100644 --- a/content/en/api/java/beta/messages/batches.md +++ b/content/en/api/java/beta/messages/batches.md @@ -88,6 +88,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -1786,6 +1800,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `OMITTED("omitted")` + - `UPDATES("updates")` + - `class BetaThinkingConfigDisabled:` - `JsonValue type constant` @@ -1802,6 +1818,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `OMITTED("omitted")` + - `UPDATES("updates")` + - `JsonValue` - `Optional inferenceGeo` @@ -4138,6 +4156,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaMessageBatch:` @@ -4382,6 +4414,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaMessageBatch:` @@ -4623,6 +4669,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaMessageBatch:` @@ -4857,6 +4917,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaDeletedMessageBatch:` @@ -4993,6 +5067,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaMessageBatchIndividualResponse:` @@ -6296,12 +6384,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -8126,12 +8216,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -9762,12 +9854,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -11360,12 +11454,14 @@ public final class Main { Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. diff --git a/content/en/api/java/beta/messages/batches/cancel.md b/content/en/api/java/beta/messages/batches/cancel.md index f656f8dee..cca0f6c75 100644 --- a/content/en/api/java/beta/messages/batches/cancel.md +++ b/content/en/api/java/beta/messages/batches/cancel.md @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaMessageBatch:` diff --git a/content/en/api/java/beta/messages/batches/create.md b/content/en/api/java/beta/messages/batches/create.md index 89d2275e1..1d589c4a8 100644 --- a/content/en/api/java/beta/messages/batches/create.md +++ b/content/en/api/java/beta/messages/batches/create.md @@ -86,6 +86,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -1784,6 +1798,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `OMITTED("omitted")` + - `UPDATES("updates")` + - `class BetaThinkingConfigDisabled:` - `JsonValue type constant` @@ -1800,6 +1816,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `OMITTED("omitted")` + - `UPDATES("updates")` + - `JsonValue` - `Optional inferenceGeo` diff --git a/content/en/api/java/beta/messages/batches/delete.md b/content/en/api/java/beta/messages/batches/delete.md index ef8b86aaf..8d7415fb2 100644 --- a/content/en/api/java/beta/messages/batches/delete.md +++ b/content/en/api/java/beta/messages/batches/delete.md @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaDeletedMessageBatch:` diff --git a/content/en/api/java/beta/messages/batches/list.md b/content/en/api/java/beta/messages/batches/list.md index dc3311eaf..a9fc5f831 100644 --- a/content/en/api/java/beta/messages/batches/list.md +++ b/content/en/api/java/beta/messages/batches/list.md @@ -100,6 +100,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaMessageBatch:` diff --git a/content/en/api/java/beta/messages/batches/results.md b/content/en/api/java/beta/messages/batches/results.md index 229979836..0418972e1 100644 --- a/content/en/api/java/beta/messages/batches/results.md +++ b/content/en/api/java/beta/messages/batches/results.md @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaMessageBatchIndividualResponse:` @@ -1393,12 +1407,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. diff --git a/content/en/api/java/beta/messages/batches/retrieve.md b/content/en/api/java/beta/messages/batches/retrieve.md index 9ad37cc80..3fcb4d7d7 100644 --- a/content/en/api/java/beta/messages/batches/retrieve.md +++ b/content/en/api/java/beta/messages/batches/retrieve.md @@ -88,6 +88,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaMessageBatch:` diff --git a/content/en/api/java/beta/messages/count_tokens.md b/content/en/api/java/beta/messages/count_tokens.md index 6ea3409db..f2986f815 100644 --- a/content/en/api/java/beta/messages/count_tokens.md +++ b/content/en/api/java/beta/messages/count_tokens.md @@ -86,6 +86,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. diff --git a/content/en/api/java/beta/messages/create.md b/content/en/api/java/beta/messages/create.md index ceac686f2..45d909c63 100644 --- a/content/en/api/java/beta/messages/create.md +++ b/content/en/api/java/beta/messages/create.md @@ -86,6 +86,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional userProfileId` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -4878,12 +4892,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. @@ -5181,12 +5197,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage:` Token usage for a sampling iteration. diff --git a/content/en/api/java/beta/models.md b/content/en/api/java/beta/models.md index f84605eb6..90fda67dd 100644 --- a/content/en/api/java/beta/models.md +++ b/content/en/api/java/beta/models.md @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaModelInfo:` @@ -433,6 +447,20 @@ The Models API response can be used to determine information about a specific mo - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaModelInfo:` diff --git a/content/en/api/java/beta/models/list.md b/content/en/api/java/beta/models/list.md index 15cfd90c5..e6d440518 100644 --- a/content/en/api/java/beta/models/list.md +++ b/content/en/api/java/beta/models/list.md @@ -100,6 +100,20 @@ The Models API response can be used to determine which models are available for - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaModelInfo:` diff --git a/content/en/api/java/beta/models/retrieve.md b/content/en/api/java/beta/models/retrieve.md index bbb1ee53b..64edc2b03 100644 --- a/content/en/api/java/beta/models/retrieve.md +++ b/content/en/api/java/beta/models/retrieve.md @@ -88,6 +88,20 @@ The Models API response can be used to determine information about a specific mo - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaModelInfo:` diff --git a/content/en/api/java/beta/sessions.md b/content/en/api/java/beta/sessions.md index 201c6d866..e0ac8e67a 100644 --- a/content/en/api/java/beta/sessions.md +++ b/content/en/api/java/beta/sessions.md @@ -84,6 +84,20 @@ Create Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Agent agent` Agent identifier. Accepts the `agent` ID string, which pins the latest version for the session, or an `agent` object with both id and version specified. @@ -2231,6 +2245,20 @@ List Sessions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSession:` @@ -3364,6 +3392,20 @@ Get Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSession:` @@ -4491,6 +4533,20 @@ Update Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional agent` Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back. @@ -5640,6 +5696,20 @@ Delete Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeletedSession:` @@ -5766,6 +5836,20 @@ Archive Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSession:` @@ -11353,6 +11437,20 @@ List Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionEvent: union` @@ -13612,6 +13710,20 @@ Send Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List events` Events to send to the `session`. @@ -14565,6 +14677,20 @@ Stream Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsStreamSessionEvents: union` @@ -16867,6 +16993,20 @@ Add Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaManagedAgentsFileResourceParams betaManagedAgentsFileResourceParams` Mount a file uploaded via the Files API into the session. @@ -17033,6 +17173,20 @@ List Session Resources - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionResource: union` @@ -17280,6 +17434,20 @@ Get Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class ResourceRetrieveResponse: union` @@ -17518,6 +17686,20 @@ Update Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String authorizationToken` New authorization token for the resource. Currently only `github_repository` resources support token rotation. @@ -17763,6 +17945,20 @@ Delete Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeleteSessionResource:` @@ -17905,6 +18101,20 @@ List Session Threads - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -17917,7 +18127,7 @@ List Session Threads - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -18732,6 +18942,20 @@ Get Session Thread - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -18744,7 +18968,7 @@ Get Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -19558,6 +19782,20 @@ Archive Session Thread - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionThread:` @@ -19570,7 +19808,7 @@ Archive Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -20396,6 +20634,20 @@ List Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionEvent: union` @@ -22658,6 +22910,20 @@ Stream Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` diff --git a/content/en/api/java/beta/sessions/archive.md b/content/en/api/java/beta/sessions/archive.md index 70939dbd2..ec4470103 100644 --- a/content/en/api/java/beta/sessions/archive.md +++ b/content/en/api/java/beta/sessions/archive.md @@ -84,6 +84,20 @@ Archive Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSession:` diff --git a/content/en/api/java/beta/sessions/create.md b/content/en/api/java/beta/sessions/create.md index 76bc17e80..df31c897c 100644 --- a/content/en/api/java/beta/sessions/create.md +++ b/content/en/api/java/beta/sessions/create.md @@ -82,6 +82,20 @@ Create Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Agent agent` Agent identifier. Accepts the `agent` ID string, which pins the latest version for the session, or an `agent` object with both id and version specified. diff --git a/content/en/api/java/beta/sessions/delete.md b/content/en/api/java/beta/sessions/delete.md index 288915e0f..339d0c553 100644 --- a/content/en/api/java/beta/sessions/delete.md +++ b/content/en/api/java/beta/sessions/delete.md @@ -84,6 +84,20 @@ Delete Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeletedSession:` diff --git a/content/en/api/java/beta/sessions/events.md b/content/en/api/java/beta/sessions/events.md index ddb111307..a6059ea00 100644 --- a/content/en/api/java/beta/sessions/events.md +++ b/content/en/api/java/beta/sessions/events.md @@ -132,6 +132,20 @@ List Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSessionEvent: union` @@ -2391,6 +2405,20 @@ Send Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List events` Events to send to the `session`. @@ -3344,6 +3372,20 @@ Stream Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsStreamSessionEvents: union` diff --git a/content/en/api/java/beta/sessions/events/list.md b/content/en/api/java/beta/sessions/events/list.md index 6daa30527..fc8ed612b 100644 --- a/content/en/api/java/beta/sessions/events/list.md +++ b/content/en/api/java/beta/sessions/events/list.md @@ -130,6 +130,20 @@ List Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSessionEvent: union` diff --git a/content/en/api/java/beta/sessions/events/send.md b/content/en/api/java/beta/sessions/events/send.md index f127a85ab..b715e60cc 100644 --- a/content/en/api/java/beta/sessions/events/send.md +++ b/content/en/api/java/beta/sessions/events/send.md @@ -84,6 +84,20 @@ Send Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List events` Events to send to the `session`. diff --git a/content/en/api/java/beta/sessions/events/stream.md b/content/en/api/java/beta/sessions/events/stream.md index 0e2527c14..fdcf089cb 100644 --- a/content/en/api/java/beta/sessions/events/stream.md +++ b/content/en/api/java/beta/sessions/events/stream.md @@ -92,6 +92,20 @@ Stream Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsStreamSessionEvents: union` diff --git a/content/en/api/java/beta/sessions/list.md b/content/en/api/java/beta/sessions/list.md index a72374995..d486791b4 100644 --- a/content/en/api/java/beta/sessions/list.md +++ b/content/en/api/java/beta/sessions/list.md @@ -158,6 +158,20 @@ List Sessions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSession:` diff --git a/content/en/api/java/beta/sessions/resources.md b/content/en/api/java/beta/sessions/resources.md index e9ddde677..b8fcd0dbb 100644 --- a/content/en/api/java/beta/sessions/resources.md +++ b/content/en/api/java/beta/sessions/resources.md @@ -86,6 +86,20 @@ Add Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaManagedAgentsFileResourceParams betaManagedAgentsFileResourceParams` Mount a file uploaded via the Files API into the session. @@ -252,6 +266,20 @@ List Session Resources - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSessionResource: union` @@ -499,6 +527,20 @@ Get Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class ResourceRetrieveResponse: union` @@ -737,6 +779,20 @@ Update Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String authorizationToken` New authorization token for the resource. Currently only `github_repository` resources support token rotation. @@ -982,6 +1038,20 @@ Delete Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeleteSessionResource:` diff --git a/content/en/api/java/beta/sessions/resources/add.md b/content/en/api/java/beta/sessions/resources/add.md index ef45f9711..2083496d2 100644 --- a/content/en/api/java/beta/sessions/resources/add.md +++ b/content/en/api/java/beta/sessions/resources/add.md @@ -84,6 +84,20 @@ Add Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `BetaManagedAgentsFileResourceParams betaManagedAgentsFileResourceParams` Mount a file uploaded via the Files API into the session. diff --git a/content/en/api/java/beta/sessions/resources/delete.md b/content/en/api/java/beta/sessions/resources/delete.md index 7e1284933..35ac83b2c 100644 --- a/content/en/api/java/beta/sessions/resources/delete.md +++ b/content/en/api/java/beta/sessions/resources/delete.md @@ -86,6 +86,20 @@ Delete Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeleteSessionResource:` diff --git a/content/en/api/java/beta/sessions/resources/list.md b/content/en/api/java/beta/sessions/resources/list.md index de465ffeb..92315f7b7 100644 --- a/content/en/api/java/beta/sessions/resources/list.md +++ b/content/en/api/java/beta/sessions/resources/list.md @@ -94,6 +94,20 @@ List Session Resources - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSessionResource: union` diff --git a/content/en/api/java/beta/sessions/resources/retrieve.md b/content/en/api/java/beta/sessions/resources/retrieve.md index d1a3138b9..47479885a 100644 --- a/content/en/api/java/beta/sessions/resources/retrieve.md +++ b/content/en/api/java/beta/sessions/resources/retrieve.md @@ -86,6 +86,20 @@ Get Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class ResourceRetrieveResponse: union` diff --git a/content/en/api/java/beta/sessions/resources/update.md b/content/en/api/java/beta/sessions/resources/update.md index e1c269ca3..4c4812666 100644 --- a/content/en/api/java/beta/sessions/resources/update.md +++ b/content/en/api/java/beta/sessions/resources/update.md @@ -86,6 +86,20 @@ Update Session Resource - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String authorizationToken` New authorization token for the resource. Currently only `github_repository` resources support token rotation. diff --git a/content/en/api/java/beta/sessions/retrieve.md b/content/en/api/java/beta/sessions/retrieve.md index 613fddf6e..ca9c29ed7 100644 --- a/content/en/api/java/beta/sessions/retrieve.md +++ b/content/en/api/java/beta/sessions/retrieve.md @@ -84,6 +84,20 @@ Get Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSession:` diff --git a/content/en/api/java/beta/sessions/threads.md b/content/en/api/java/beta/sessions/threads.md index c4e43cb49..b9a4447be 100644 --- a/content/en/api/java/beta/sessions/threads.md +++ b/content/en/api/java/beta/sessions/threads.md @@ -96,6 +96,20 @@ List Session Threads - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSessionThread:` @@ -108,7 +122,7 @@ List Session Threads - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -923,6 +937,20 @@ Get Session Thread - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSessionThread:` @@ -935,7 +963,7 @@ Get Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -1749,6 +1777,20 @@ Archive Session Thread - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSessionThread:` @@ -1761,7 +1803,7 @@ Archive Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -2501,7 +2543,7 @@ public final class Main { - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` @@ -5497,6 +5539,20 @@ List Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsSessionEvent: union` @@ -7759,6 +7815,20 @@ Stream Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` diff --git a/content/en/api/java/beta/sessions/threads/archive.md b/content/en/api/java/beta/sessions/threads/archive.md index 5ab263d13..b964696d1 100644 --- a/content/en/api/java/beta/sessions/threads/archive.md +++ b/content/en/api/java/beta/sessions/threads/archive.md @@ -86,6 +86,20 @@ Archive Session Thread - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSessionThread:` @@ -98,7 +112,7 @@ Archive Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` diff --git a/content/en/api/java/beta/sessions/threads/events.md b/content/en/api/java/beta/sessions/threads/events.md index e3c3d3af7..22e79dca1 100644 --- a/content/en/api/java/beta/sessions/threads/events.md +++ b/content/en/api/java/beta/sessions/threads/events.md @@ -98,6 +98,20 @@ List Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsSessionEvent: union` @@ -2360,6 +2374,20 @@ Stream Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` diff --git a/content/en/api/java/beta/sessions/threads/events/list.md b/content/en/api/java/beta/sessions/threads/events/list.md index d699d14fd..5a816ba62 100644 --- a/content/en/api/java/beta/sessions/threads/events/list.md +++ b/content/en/api/java/beta/sessions/threads/events/list.md @@ -96,6 +96,20 @@ List Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSessionEvent: union` diff --git a/content/en/api/java/beta/sessions/threads/events/stream.md b/content/en/api/java/beta/sessions/threads/events/stream.md index 6dbf9e2e0..8ed245868 100644 --- a/content/en/api/java/beta/sessions/threads/events/stream.md +++ b/content/en/api/java/beta/sessions/threads/events/stream.md @@ -94,6 +94,20 @@ Stream Session Thread Events - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsStreamSessionThreadEvents: union` diff --git a/content/en/api/java/beta/sessions/threads/list.md b/content/en/api/java/beta/sessions/threads/list.md index 66b8c4e0a..49b88fa02 100644 --- a/content/en/api/java/beta/sessions/threads/list.md +++ b/content/en/api/java/beta/sessions/threads/list.md @@ -94,6 +94,20 @@ List Session Threads - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSessionThread:` @@ -106,7 +120,7 @@ List Session Threads - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` diff --git a/content/en/api/java/beta/sessions/threads/retrieve.md b/content/en/api/java/beta/sessions/threads/retrieve.md index 764d67757..e96ff8d7c 100644 --- a/content/en/api/java/beta/sessions/threads/retrieve.md +++ b/content/en/api/java/beta/sessions/threads/retrieve.md @@ -86,6 +86,20 @@ Get Session Thread - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsSessionThread:` @@ -98,7 +112,7 @@ Get Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent:` diff --git a/content/en/api/java/beta/sessions/update.md b/content/en/api/java/beta/sessions/update.md index b609faa39..88aa39870 100644 --- a/content/en/api/java/beta/sessions/update.md +++ b/content/en/api/java/beta/sessions/update.md @@ -84,6 +84,20 @@ Update Session - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional agent` Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back. diff --git a/content/en/api/java/beta/skills.md b/content/en/api/java/beta/skills.md index 2c015cf41..dfa5a886c 100644 --- a/content/en/api/java/beta/skills.md +++ b/content/en/api/java/beta/skills.md @@ -84,6 +84,20 @@ Create Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List files` Files to upload for the skill. @@ -285,6 +299,20 @@ List Skills - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class SkillListResponse:` @@ -461,6 +489,20 @@ Get Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class SkillRetrieveResponse:` @@ -631,6 +673,20 @@ Delete Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class SkillDeleteResponse:` @@ -769,6 +825,20 @@ Create Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List files` Files to upload for the skill. @@ -964,6 +1034,20 @@ List Skill Versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class VersionListResponse:` @@ -1150,6 +1234,20 @@ Download a skill version's content as a zip archive. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Example ```java @@ -1271,6 +1369,20 @@ Get Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class VersionRetrieveResponse:` @@ -1455,6 +1567,20 @@ Delete Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class VersionDeleteResponse:` diff --git a/content/en/api/java/beta/skills/create.md b/content/en/api/java/beta/skills/create.md index f0a50e95c..eb3159692 100644 --- a/content/en/api/java/beta/skills/create.md +++ b/content/en/api/java/beta/skills/create.md @@ -82,6 +82,20 @@ Create Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List files` Files to upload for the skill. diff --git a/content/en/api/java/beta/skills/delete.md b/content/en/api/java/beta/skills/delete.md index 70c1a0f91..8c45b6a21 100644 --- a/content/en/api/java/beta/skills/delete.md +++ b/content/en/api/java/beta/skills/delete.md @@ -88,6 +88,20 @@ Delete Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class SkillDeleteResponse:` diff --git a/content/en/api/java/beta/skills/list.md b/content/en/api/java/beta/skills/list.md index d35a178a3..39fe377e1 100644 --- a/content/en/api/java/beta/skills/list.md +++ b/content/en/api/java/beta/skills/list.md @@ -103,6 +103,20 @@ List Skills - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class SkillListResponse:` diff --git a/content/en/api/java/beta/skills/retrieve.md b/content/en/api/java/beta/skills/retrieve.md index 1f144ff0e..23422386a 100644 --- a/content/en/api/java/beta/skills/retrieve.md +++ b/content/en/api/java/beta/skills/retrieve.md @@ -88,6 +88,20 @@ Get Skill - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class SkillRetrieveResponse:` diff --git a/content/en/api/java/beta/skills/versions.md b/content/en/api/java/beta/skills/versions.md index 0695f4a62..8e78574e3 100644 --- a/content/en/api/java/beta/skills/versions.md +++ b/content/en/api/java/beta/skills/versions.md @@ -90,6 +90,20 @@ Create Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List files` Files to upload for the skill. @@ -285,6 +299,20 @@ List Skill Versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class VersionListResponse:` @@ -471,6 +499,20 @@ Download a skill version's content as a zip archive. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Example ```java @@ -592,6 +634,20 @@ Get Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class VersionRetrieveResponse:` @@ -776,6 +832,20 @@ Delete Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class VersionDeleteResponse:` diff --git a/content/en/api/java/beta/skills/versions/create.md b/content/en/api/java/beta/skills/versions/create.md index 119a611c2..0dcf4b562 100644 --- a/content/en/api/java/beta/skills/versions/create.md +++ b/content/en/api/java/beta/skills/versions/create.md @@ -88,6 +88,20 @@ Create Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `List files` Files to upload for the skill. diff --git a/content/en/api/java/beta/skills/versions/delete.md b/content/en/api/java/beta/skills/versions/delete.md index 951d45ab0..710fb394b 100644 --- a/content/en/api/java/beta/skills/versions/delete.md +++ b/content/en/api/java/beta/skills/versions/delete.md @@ -94,6 +94,20 @@ Delete Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class VersionDeleteResponse:` diff --git a/content/en/api/java/beta/skills/versions/download.md b/content/en/api/java/beta/skills/versions/download.md index 2b149e8da..8074cf720 100644 --- a/content/en/api/java/beta/skills/versions/download.md +++ b/content/en/api/java/beta/skills/versions/download.md @@ -94,6 +94,20 @@ Download a skill version's content as a zip archive. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Example ```java diff --git a/content/en/api/java/beta/skills/versions/list.md b/content/en/api/java/beta/skills/versions/list.md index 7c2554749..7bb940c86 100644 --- a/content/en/api/java/beta/skills/versions/list.md +++ b/content/en/api/java/beta/skills/versions/list.md @@ -98,6 +98,20 @@ List Skill Versions - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class VersionListResponse:` diff --git a/content/en/api/java/beta/skills/versions/retrieve.md b/content/en/api/java/beta/skills/versions/retrieve.md index 100dc7fa0..6dd574768 100644 --- a/content/en/api/java/beta/skills/versions/retrieve.md +++ b/content/en/api/java/beta/skills/versions/retrieve.md @@ -94,6 +94,20 @@ Get Skill Version - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class VersionRetrieveResponse:` diff --git a/content/en/api/java/beta/tunnels.md b/content/en/api/java/beta/tunnels.md index bace4bdf3..5797373be 100644 --- a/content/en/api/java/beta/tunnels.md +++ b/content/en/api/java/beta/tunnels.md @@ -86,6 +86,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional displayName` Optional human-readable name for the tunnel (1-255 characters). @@ -246,6 +260,20 @@ Fetches a tunnel by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaTunnel:` @@ -412,6 +440,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaTunnel:` @@ -571,6 +613,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaTunnel:` @@ -725,6 +781,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaTunnelToken:` @@ -860,6 +930,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional reason` Optional free-text reason for the rotation, recorded for audit. @@ -1053,6 +1137,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String caCertificatePem` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -1226,6 +1324,20 @@ Fetches a tunnel certificate by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaTunnelCertificate:` @@ -1405,6 +1517,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaTunnelCertificate:` @@ -1573,6 +1699,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/java/beta/tunnels/archive.md b/content/en/api/java/beta/tunnels/archive.md index f53003573..f685c1f32 100644 --- a/content/en/api/java/beta/tunnels/archive.md +++ b/content/en/api/java/beta/tunnels/archive.md @@ -86,6 +86,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaTunnel:` diff --git a/content/en/api/java/beta/tunnels/certificates.md b/content/en/api/java/beta/tunnels/certificates.md index ccffa582e..94313455d 100644 --- a/content/en/api/java/beta/tunnels/certificates.md +++ b/content/en/api/java/beta/tunnels/certificates.md @@ -88,6 +88,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String caCertificatePem` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -261,6 +275,20 @@ Fetches a tunnel certificate by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaTunnelCertificate:` @@ -440,6 +468,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaTunnelCertificate:` @@ -608,6 +650,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/java/beta/tunnels/certificates/archive.md b/content/en/api/java/beta/tunnels/certificates/archive.md index b39893c43..4926ab915 100644 --- a/content/en/api/java/beta/tunnels/certificates/archive.md +++ b/content/en/api/java/beta/tunnels/certificates/archive.md @@ -88,6 +88,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/java/beta/tunnels/certificates/create.md b/content/en/api/java/beta/tunnels/certificates/create.md index aa1b532ee..084ceaa3a 100644 --- a/content/en/api/java/beta/tunnels/certificates/create.md +++ b/content/en/api/java/beta/tunnels/certificates/create.md @@ -86,6 +86,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String caCertificatePem` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. diff --git a/content/en/api/java/beta/tunnels/certificates/list.md b/content/en/api/java/beta/tunnels/certificates/list.md index 5a18461df..0db0498af 100644 --- a/content/en/api/java/beta/tunnels/certificates/list.md +++ b/content/en/api/java/beta/tunnels/certificates/list.md @@ -100,6 +100,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/java/beta/tunnels/certificates/retrieve.md b/content/en/api/java/beta/tunnels/certificates/retrieve.md index 59d21ef59..233e8af75 100644 --- a/content/en/api/java/beta/tunnels/certificates/retrieve.md +++ b/content/en/api/java/beta/tunnels/certificates/retrieve.md @@ -88,6 +88,20 @@ Fetches a tunnel certificate by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaTunnelCertificate:` diff --git a/content/en/api/java/beta/tunnels/create.md b/content/en/api/java/beta/tunnels/create.md index d9009ea98..791470cbd 100644 --- a/content/en/api/java/beta/tunnels/create.md +++ b/content/en/api/java/beta/tunnels/create.md @@ -84,6 +84,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional displayName` Optional human-readable name for the tunnel (1-255 characters). diff --git a/content/en/api/java/beta/tunnels/list.md b/content/en/api/java/beta/tunnels/list.md index 38f17321a..7ba34742b 100644 --- a/content/en/api/java/beta/tunnels/list.md +++ b/content/en/api/java/beta/tunnels/list.md @@ -98,6 +98,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaTunnel:` diff --git a/content/en/api/java/beta/tunnels/retrieve.md b/content/en/api/java/beta/tunnels/retrieve.md index 59d9ab98a..bd1eac401 100644 --- a/content/en/api/java/beta/tunnels/retrieve.md +++ b/content/en/api/java/beta/tunnels/retrieve.md @@ -86,6 +86,20 @@ Fetches a tunnel by ID. - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaTunnel:` diff --git a/content/en/api/java/beta/tunnels/reveal_token.md b/content/en/api/java/beta/tunnels/reveal_token.md index 034800d24..adbcd1382 100644 --- a/content/en/api/java/beta/tunnels/reveal_token.md +++ b/content/en/api/java/beta/tunnels/reveal_token.md @@ -86,6 +86,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaTunnelToken:` diff --git a/content/en/api/java/beta/tunnels/rotate_token.md b/content/en/api/java/beta/tunnels/rotate_token.md index 5f89196da..d07010943 100644 --- a/content/en/api/java/beta/tunnels/rotate_token.md +++ b/content/en/api/java/beta/tunnels/rotate_token.md @@ -86,6 +86,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional reason` Optional free-text reason for the rotation, recorded for audit. diff --git a/content/en/api/java/beta/user_profiles.md b/content/en/api/java/beta/user_profiles.md index 847b705eb..a9715e839 100644 --- a/content/en/api/java/beta/user_profiles.md +++ b/content/en/api/java/beta/user_profiles.md @@ -84,6 +84,20 @@ Create User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional accessType` How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. @@ -330,6 +344,20 @@ List User Profiles - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaUserProfile:` @@ -531,6 +559,20 @@ Get User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaUserProfile:` @@ -727,6 +769,20 @@ Update User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional accessType` How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. @@ -957,6 +1013,20 @@ Create Enrollment URL - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaUserProfileEnrollmentUrl:` diff --git a/content/en/api/java/beta/user_profiles/create.md b/content/en/api/java/beta/user_profiles/create.md index 2698bb877..83769d98e 100644 --- a/content/en/api/java/beta/user_profiles/create.md +++ b/content/en/api/java/beta/user_profiles/create.md @@ -82,6 +82,20 @@ Create User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional accessType` How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. diff --git a/content/en/api/java/beta/user_profiles/create_enrollment_url.md b/content/en/api/java/beta/user_profiles/create_enrollment_url.md index fbbddef92..c5b54e802 100644 --- a/content/en/api/java/beta/user_profiles/create_enrollment_url.md +++ b/content/en/api/java/beta/user_profiles/create_enrollment_url.md @@ -84,6 +84,20 @@ Create Enrollment URL - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaUserProfileEnrollmentUrl:` diff --git a/content/en/api/java/beta/user_profiles/list.md b/content/en/api/java/beta/user_profiles/list.md index f85534ee7..af01881e7 100644 --- a/content/en/api/java/beta/user_profiles/list.md +++ b/content/en/api/java/beta/user_profiles/list.md @@ -100,6 +100,20 @@ List User Profiles - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaUserProfile:` diff --git a/content/en/api/java/beta/user_profiles/retrieve.md b/content/en/api/java/beta/user_profiles/retrieve.md index 68f44f0da..5842c7e1e 100644 --- a/content/en/api/java/beta/user_profiles/retrieve.md +++ b/content/en/api/java/beta/user_profiles/retrieve.md @@ -84,6 +84,20 @@ Get User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaUserProfile:` diff --git a/content/en/api/java/beta/user_profiles/update.md b/content/en/api/java/beta/user_profiles/update.md index 3fe84d015..6469ce17c 100644 --- a/content/en/api/java/beta/user_profiles/update.md +++ b/content/en/api/java/beta/user_profiles/update.md @@ -84,6 +84,20 @@ Update User Profile - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional accessType` How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. diff --git a/content/en/api/java/beta/vaults.md b/content/en/api/java/beta/vaults.md index cf63fc993..fc7fb12fc 100644 --- a/content/en/api/java/beta/vaults.md +++ b/content/en/api/java/beta/vaults.md @@ -84,6 +84,20 @@ Create Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String displayName` Human-readable name for the vault. 1-255 characters. @@ -270,6 +284,20 @@ List Vaults - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsVault:` @@ -436,6 +464,20 @@ Get Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsVault:` @@ -597,6 +639,20 @@ Update Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional displayName` Updated human-readable name for the vault. 1-255 characters. @@ -768,6 +824,20 @@ Delete Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeletedVault:` @@ -896,6 +966,20 @@ Archive Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsVault:` @@ -1111,6 +1195,20 @@ Create Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Auth auth` Authentication details for creating a credential. @@ -1592,6 +1690,20 @@ List Credentials - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsCredential:` @@ -1883,6 +1995,20 @@ Get Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsCredential:` @@ -2173,6 +2299,20 @@ Update Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional auth` Updated authentication details for a credential. @@ -2595,6 +2735,20 @@ Delete Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsDeletedCredential:` @@ -2729,6 +2883,20 @@ Archive Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsCredential:` @@ -3019,6 +3187,20 @@ Validate Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + #### Returns - `class BetaManagedAgentsCredentialValidation:` diff --git a/content/en/api/java/beta/vaults/archive.md b/content/en/api/java/beta/vaults/archive.md index 34654d499..d15bf0ce5 100644 --- a/content/en/api/java/beta/vaults/archive.md +++ b/content/en/api/java/beta/vaults/archive.md @@ -84,6 +84,20 @@ Archive Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsVault:` diff --git a/content/en/api/java/beta/vaults/create.md b/content/en/api/java/beta/vaults/create.md index 199831c0f..9858f74ce 100644 --- a/content/en/api/java/beta/vaults/create.md +++ b/content/en/api/java/beta/vaults/create.md @@ -82,6 +82,20 @@ Create Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `String displayName` Human-readable name for the vault. 1-255 characters. diff --git a/content/en/api/java/beta/vaults/credentials.md b/content/en/api/java/beta/vaults/credentials.md index 08b26bdc4..bc2e76640 100644 --- a/content/en/api/java/beta/vaults/credentials.md +++ b/content/en/api/java/beta/vaults/credentials.md @@ -86,6 +86,20 @@ Create Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Auth auth` Authentication details for creating a credential. @@ -567,6 +581,20 @@ List Credentials - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsCredential:` @@ -858,6 +886,20 @@ Get Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsCredential:` @@ -1148,6 +1190,20 @@ Update Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional auth` Updated authentication details for a credential. @@ -1570,6 +1626,20 @@ Delete Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsDeletedCredential:` @@ -1704,6 +1774,20 @@ Archive Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsCredential:` @@ -1994,6 +2078,20 @@ Validate Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class BetaManagedAgentsCredentialValidation:` diff --git a/content/en/api/java/beta/vaults/credentials/archive.md b/content/en/api/java/beta/vaults/credentials/archive.md index c36b6322b..eb2c73da9 100644 --- a/content/en/api/java/beta/vaults/credentials/archive.md +++ b/content/en/api/java/beta/vaults/credentials/archive.md @@ -86,6 +86,20 @@ Archive Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsCredential:` diff --git a/content/en/api/java/beta/vaults/credentials/create.md b/content/en/api/java/beta/vaults/credentials/create.md index 9d85ccb6b..d04286a18 100644 --- a/content/en/api/java/beta/vaults/credentials/create.md +++ b/content/en/api/java/beta/vaults/credentials/create.md @@ -84,6 +84,20 @@ Create Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Auth auth` Authentication details for creating a credential. diff --git a/content/en/api/java/beta/vaults/credentials/delete.md b/content/en/api/java/beta/vaults/credentials/delete.md index e4356dd05..e9f507835 100644 --- a/content/en/api/java/beta/vaults/credentials/delete.md +++ b/content/en/api/java/beta/vaults/credentials/delete.md @@ -86,6 +86,20 @@ Delete Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeletedCredential:` diff --git a/content/en/api/java/beta/vaults/credentials/list.md b/content/en/api/java/beta/vaults/credentials/list.md index 348d76024..ca9c620d5 100644 --- a/content/en/api/java/beta/vaults/credentials/list.md +++ b/content/en/api/java/beta/vaults/credentials/list.md @@ -98,6 +98,20 @@ List Credentials - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsCredential:` diff --git a/content/en/api/java/beta/vaults/credentials/mcp_oauth_validate.md b/content/en/api/java/beta/vaults/credentials/mcp_oauth_validate.md index 65dc9b28d..91995043c 100644 --- a/content/en/api/java/beta/vaults/credentials/mcp_oauth_validate.md +++ b/content/en/api/java/beta/vaults/credentials/mcp_oauth_validate.md @@ -86,6 +86,20 @@ Validate Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsCredentialValidation:` diff --git a/content/en/api/java/beta/vaults/credentials/retrieve.md b/content/en/api/java/beta/vaults/credentials/retrieve.md index 277395b68..82ee83f79 100644 --- a/content/en/api/java/beta/vaults/credentials/retrieve.md +++ b/content/en/api/java/beta/vaults/credentials/retrieve.md @@ -86,6 +86,20 @@ Get Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsCredential:` diff --git a/content/en/api/java/beta/vaults/credentials/update.md b/content/en/api/java/beta/vaults/credentials/update.md index 192a604df..094e34762 100644 --- a/content/en/api/java/beta/vaults/credentials/update.md +++ b/content/en/api/java/beta/vaults/credentials/update.md @@ -86,6 +86,20 @@ Update Credential - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional auth` Updated authentication details for a credential. diff --git a/content/en/api/java/beta/vaults/delete.md b/content/en/api/java/beta/vaults/delete.md index d3559edb2..ee91b7dbd 100644 --- a/content/en/api/java/beta/vaults/delete.md +++ b/content/en/api/java/beta/vaults/delete.md @@ -84,6 +84,20 @@ Delete Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsDeletedVault:` diff --git a/content/en/api/java/beta/vaults/list.md b/content/en/api/java/beta/vaults/list.md index ac375459e..5022f2d25 100644 --- a/content/en/api/java/beta/vaults/list.md +++ b/content/en/api/java/beta/vaults/list.md @@ -96,6 +96,20 @@ List Vaults - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsVault:` diff --git a/content/en/api/java/beta/vaults/retrieve.md b/content/en/api/java/beta/vaults/retrieve.md index e31244bc8..d64101573 100644 --- a/content/en/api/java/beta/vaults/retrieve.md +++ b/content/en/api/java/beta/vaults/retrieve.md @@ -84,6 +84,20 @@ Get Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class BetaManagedAgentsVault:` diff --git a/content/en/api/java/beta/vaults/update.md b/content/en/api/java/beta/vaults/update.md index c1a65a7fd..941b06256 100644 --- a/content/en/api/java/beta/vaults/update.md +++ b/content/en/api/java/beta/vaults/update.md @@ -84,6 +84,20 @@ Update Vault - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `Optional displayName` Updated human-readable name for the vault. 1-255 characters. diff --git a/content/en/api/java/completions.md b/content/en/api/java/completions.md index 6be43d0e2..7ca870085 100644 --- a/content/en/api/java/completions.md +++ b/content/en/api/java/completions.md @@ -88,6 +88,20 @@ Future models and features will not be compatible with Text Completions. See our - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `long maxTokensToSample` The maximum number of tokens to generate before stopping. diff --git a/content/en/api/java/completions/create.md b/content/en/api/java/completions/create.md index 1e58583f3..510174b4b 100644 --- a/content/en/api/java/completions/create.md +++ b/content/en/api/java/completions/create.md @@ -86,6 +86,20 @@ Future models and features will not be compatible with Text Completions. See our - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + - `long maxTokensToSample` The maximum number of tokens to generate before stopping. diff --git a/content/en/api/java/models.md b/content/en/api/java/models.md index 0fb7da20f..13bafd536 100644 --- a/content/en/api/java/models.md +++ b/content/en/api/java/models.md @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class ModelInfo:` @@ -426,6 +440,20 @@ The Models API response can be used to determine information about a specific mo - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ### Returns - `class ModelInfo:` diff --git a/content/en/api/java/models/list.md b/content/en/api/java/models/list.md index 57481e76a..9987648e5 100644 --- a/content/en/api/java/models/list.md +++ b/content/en/api/java/models/list.md @@ -100,6 +100,20 @@ The Models API response can be used to determine which models are available for - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class ModelInfo:` diff --git a/content/en/api/java/models/retrieve.md b/content/en/api/java/models/retrieve.md index 3770baebe..0abbbc785 100644 --- a/content/en/api/java/models/retrieve.md +++ b/content/en/api/java/models/retrieve.md @@ -88,6 +88,20 @@ The Models API response can be used to determine information about a specific mo - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` + - `COMPACT_2026_01_12("compact-2026-01-12")` + + - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` + + - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` + + - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` + + - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` + + - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` + + - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` + ## Returns - `class ModelInfo:` diff --git a/content/en/api/models.md b/content/en/api/models.md index 635c689e8..d4346987e 100644 --- a/content/en/api/models.md +++ b/content/en/api/models.md @@ -34,7 +34,7 @@ The Models API response can be used to determine which models are available for - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: array of ModelInfo` @@ -361,7 +375,7 @@ The Models API response can be used to determine information about a specific mo - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -431,6 +445,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `ModelInfo object` diff --git a/content/en/api/models/list.md b/content/en/api/models/list.md index 58b46e2de..531091c0e 100644 --- a/content/en/api/models/list.md +++ b/content/en/api/models/list.md @@ -32,7 +32,7 @@ The Models API response can be used to determine which models are available for - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `data: array of ModelInfo` diff --git a/content/en/api/models/retrieve.md b/content/en/api/models/retrieve.md index df4106933..7c6283333 100644 --- a/content/en/api/models/retrieve.md +++ b/content/en/api/models/retrieve.md @@ -20,7 +20,7 @@ The Models API response can be used to determine information about a specific mo - `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `ModelInfo object` diff --git a/content/en/api/overview.md b/content/en/api/overview.md index d8e79b2ca..164d19a7a 100644 --- a/content/en/api/overview.md +++ b/content/en/api/overview.md @@ -55,7 +55,7 @@ When accessing Claude through a [cloud platform](https://platform.claude.com/doc ### Getting API keys -The API is made available through the web [Console](https://platform.claude.com/). You can use [Playground](https://platform.claude.com/playground) to try out the API in the browser and then generate API keys in [Account Settings](https://platform.claude.com/settings/keys). You choose each key's [expiration](https://platform.claude.com/docs/en/manage-claude/authentication#key-expiration) when you create it. Use [workspaces](https://platform.claude.com/settings/workspaces) to segment your API keys and [control spend](https://platform.claude.com/docs/en/api/rate-limits) by use case. +The API is made available through the web [Console](https://platform.claude.com/). You can use [playground](https://platform.claude.com/playground) to try out the API in the browser and then generate API keys in [Account Settings](https://platform.claude.com/settings/keys). You choose each key's [expiration](https://platform.claude.com/docs/en/manage-claude/authentication#key-expiration) when you create it. Use [workspaces](https://platform.claude.com/settings/workspaces) to segment your API keys and [control spend](https://platform.claude.com/docs/en/api/rate-limits) by use case. ## Client SDKs diff --git a/content/en/api/php/beta.md b/content/en/api/php/beta.md index e1401598a..7a650135f 100644 --- a/content/en/api/php/beta.md +++ b/content/en/api/php/beta.md @@ -74,6 +74,20 @@ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Beta API Error - `BetaAPIError` @@ -8999,7 +9013,7 @@ List Session Threads - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` @@ -9176,7 +9190,7 @@ Get Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` @@ -9347,7 +9361,7 @@ Archive Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` @@ -14549,7 +14563,7 @@ Create a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -14666,7 +14680,7 @@ List memories - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -14782,7 +14796,7 @@ Retrieve a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -14894,7 +14908,7 @@ Update a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -15083,7 +15097,7 @@ List memory versions - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` @@ -15217,7 +15231,7 @@ Retrieve a memory version - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` @@ -15338,7 +15352,7 @@ Redact a memory version - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` @@ -18313,7 +18327,7 @@ var_dump($betaTunnelToken); ### Create Tunnel Certificate -`$client->beta->tunnels->certificates->create(string tunnelID, string caCertificatePem, ?list betas): TunnelCertificate` +`$client->beta->tunnels->certificates->create(string tunnelID, string caCertificatePEM, ?list betas): TunnelCertificate` **POST** `/v1/tunnels/{tunnel_id}/certificates` @@ -18325,7 +18339,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `tunnelID: string` -- `caCertificatePem: string` +- `caCertificatePEM: string` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -18374,7 +18388,7 @@ $client = new Client(apiKey: 'my-anthropic-api-key'); $betaTunnelCertificate = $client->beta->tunnels->certificates->create( 'tunnel_id', - caCertificatePem: 'ca_certificate_pem', + caCertificatePEM: 'ca_certificate_pem', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], ); @@ -18657,3 +18671,6180 @@ var_dump($betaTunnelCertificate); "type": "tunnel_certificate" } ``` + +## Beta › Organization + +### Get Current Organization + +`$client->beta->organization->retrieve(): BetaOrganization` + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Returns + +- `BetaOrganization` + + - `string id` + + ID of the Organization. + + - `string name` + + Name of the Organization. + + - `"organization" type` + + Object type. + + For Organizations, this is always `"organization"`. + +#### Example + +```php +beta->organization->retrieve(); + +var_dump($betaOrganization); +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +`$client->beta->organization->apiKeys->list(?string afterID, ?string beforeID, ?string createdByUserID, ?int limit, ?Status status, ?string workspaceID): Page` + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Parameters + +- `afterID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `beforeID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `createdByUserID?:optional string` + + Filter by the ID of the User who created the object. + +- `limit?:optional int` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20 + +- `status?:optional Status` + + Filter by API key status. + +- `workspaceID?:optional string` + + Filter by Workspace ID. + +#### Returns + +- `APIKey` + + - `string id` + + ID of the API key. + + - `\Datetime createdAt` + + RFC 3339 datetime string indicating when the API Key was created. + + - `?APIKeyCreatedBy createdBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `?\Datetime expiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + - `string name` + + Name of the API key. + + - `?string partialKeyHint` + + Partially redacted hint for the API key. + + - `?Principal principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `Scope scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `Status status` + + Status of the API key. + + - `"api_key" type` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `?string workspaceID` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```php +beta->organization->apiKeys->list( + afterID: 'after_id', + beforeID: 'before_id', + createdByUserID: 'created_by_user_id', + limit: 1, + status: 'active', + workspaceID: 'workspace_id', +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +`$client->beta->organization->apiKeys->retrieve(string apiKeyID): APIKey` + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Parameters + +- `apiKeyID: string` + + ID of the API key. + +#### Returns + +- `APIKey` + + - `string id` + + ID of the API key. + + - `\Datetime createdAt` + + RFC 3339 datetime string indicating when the API Key was created. + + - `?APIKeyCreatedBy createdBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `?\Datetime expiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + - `string name` + + Name of the API key. + + - `?string partialKeyHint` + + Partially redacted hint for the API key. + + - `?Principal principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `Scope scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `Status status` + + Status of the API key. + + - `"api_key" type` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `?string workspaceID` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```php +beta->organization->apiKeys->retrieve('api_key_id'); + +var_dump($betaAPIKey); +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +`$client->beta->organization->apiKeys->update(string apiKeyID, ?string name, ?Status status): APIKey` + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Parameters + +- `apiKeyID: string` + + ID of the API key. + +- `name?:optional string` + + Name of the API key. + +- `status?:optional Status` + + Status of the API key. + +#### Returns + +- `APIKey` + + - `string id` + + ID of the API key. + + - `\Datetime createdAt` + + RFC 3339 datetime string indicating when the API Key was created. + + - `?APIKeyCreatedBy createdBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `?\Datetime expiresAt` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + - `string name` + + Name of the API key. + + - `?string partialKeyHint` + + Partially redacted hint for the API key. + + - `?Principal principal` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `Scope scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `Status status` + + Status of the API key. + + - `"api_key" type` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `?string workspaceID` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```php +beta->organization->apiKeys->update( + 'api_key_id', name: 'x', status: 'active' +); + +var_dump($betaAPIKey); +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +`$client->beta->organization->externalKeys->create(ProviderConfig providerConfig, ?string displayName, ?Geo geo): ExternalKey` + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Parameters + +- `providerConfig: ProviderConfig` + + KMS provider identity and auth coordinates. + +- `displayName?:optional string` + + Human-friendly display name. + +- `geo?:optional Geo` + + Data residency geo. Only `us` is supported. + +#### Returns + +- `ExternalKey` + + - `string id` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `\Datetime createdAt` + + - `?string displayName` + + Human-friendly display name. Null if none was set. + + - `string geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `"external_key" type` + + - `\Datetime updatedAt` + +#### Example + +```php +beta->organization->externalKeys->create( + providerConfig: [ + 'kmsARN' => 'arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222', + 'type' => 'aws', + 'region' => 'us-east-1', + 'roleARN' => 'arn:aws:iam::111122223333:role/anthropic-cmek', + ], + displayName: 'x', + geo: 'us', +); + +var_dump($betaExternalKey); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +`$client->beta->organization->externalKeys->list(?int limit, ?string page): PageCursor` + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Parameters + +- `limit?:optional int` + + Number of results per page. + + default: 20 + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `ExternalKey` + + - `string id` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `\Datetime createdAt` + + - `?string displayName` + + Human-friendly display name. Null if none was set. + + - `string geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `"external_key" type` + + - `\Datetime updatedAt` + +#### Example + +```php +beta->organization->externalKeys->list(limit: 1, page: 'page'); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +`$client->beta->organization->externalKeys->retrieve(string externalKeyID): ExternalKey` + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Parameters + +- `externalKeyID: string` + + ID of the External Key. + +#### Returns + +- `ExternalKey` + + - `string id` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `\Datetime createdAt` + + - `?string displayName` + + Human-friendly display name. Null if none was set. + + - `string geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `"external_key" type` + + - `\Datetime updatedAt` + +#### Example + +```php +beta->organization->externalKeys->retrieve( + 'external_key_id' +); + +var_dump($betaExternalKey); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +`$client->beta->organization->externalKeys->update(string externalKeyID, ?string displayName, ?Geo geo, ?ProviderConfig providerConfig): ExternalKey` + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Parameters + +- `externalKeyID: string` + + ID of the External Key. + +- `displayName?:optional string` + + Human-friendly display name. + +- `geo?:optional Geo` + + Data residency geo. Only `us` is supported. + +- `providerConfig?:optional ProviderConfig` + + KMS provider identity and auth coordinates. + +#### Returns + +- `ExternalKey` + + - `string id` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `Attachment attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `\Datetime createdAt` + + - `?string displayName` + + Human-friendly display name. Null if none was set. + + - `string geo` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `ProviderConfig providerConfig` + + KMS provider identity and auth coordinates. + + - `"external_key" type` + + - `\Datetime updatedAt` + +#### Example + +```php +beta->organization->externalKeys->update( + 'external_key_id', + displayName: 'x', + geo: 'us', + providerConfig: [ + 'kmsARN' => 'arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222', + 'type' => 'aws', + 'region' => 'us-east-1', + 'roleARN' => 'arn:aws:iam::111122223333:role/anthropic-cmek', + ], +); + +var_dump($betaExternalKey); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +`$client->beta->organization->externalKeys->delete(string externalKeyID): ExternalKeyDeleteResponse` + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Parameters + +- `externalKeyID: string` + + ID of the External Key. + +#### Returns + +- `ExternalKeyDeleteResponse` + + - `string id` + + ID of the deleted External Key. + + - `"external_key_deleted" type` + +#### Example + +```php +beta->organization->externalKeys->delete( + 'external_key_id' +); + +var_dump($externalKey); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +`$client->beta->organization->externalKeys->validate(string externalKeyID): ExternalKeyValidateResponse` + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Parameters + +- `externalKeyID: string` + + ID of the External Key. + +#### Returns + +- `ExternalKeyValidateResponse` + + - `?string error` + + Error message when status is `failure`. Null otherwise. + + - `Status status` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"external_key_validation" type` + +#### Example + +```php +beta->organization->externalKeys->validate( + 'external_key_id' +); + +var_dump($response); +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +`$client->beta->organization->federation->issuers->create(string issuerURL, string name, ?bool checkJTI, ?JWKS jwks, ?int maxJWTLifetimeSeconds, ?list betas): BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Parameters + +- `issuerURL: string` + + The `iss` claim value to match against. + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + +- `checkJTI?:optional bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `jwks?:optional JWKS` + + How signing keys are obtained. Defaults to OIDC discovery. + +- `maxJWTLifetimeSeconds?:optional int` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationIssuer` + + - `string id` + + Tagged ID of the federation issuer. + + - `?\Datetime archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `bool checkJTI` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `\Datetime createdAt` + + When this issuer was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `string issuerURL` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS jwks` + + How signing keys are obtained for signature verification. + + - `?\Datetime jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + - `int maxJWTLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `string name` + + Admin-chosen slug identifier. + + - `?BetaFederationIssuerPollStatus pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `"federation_issuer" type` + + - `\Datetime updatedAt` + + When this issuer was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```php +beta + ->organization + ->federation + ->issuers + ->create( + issuerURL: 'x', + name: 'x', + checkJTI: true, + jwks: [ + 'type' => 'discovery', + 'caCertPEM' => 'ca_cert_pem', + 'discoveryBase' => 'discovery_base', + ], + maxJWTLifetimeSeconds: 1, + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaFederationIssuer); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +`$client->beta->organization->federation->issuers->list(?bool includeArchived, ?int limit, ?string page, ?list betas): PageCursor` + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Parameters + +- `includeArchived?:optional bool` + + Include archived resources. Defaults to false. + + default: false + +- `limit?:optional int` + + Number of results per page. + + default: 20 + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationIssuer` + + - `string id` + + Tagged ID of the federation issuer. + + - `?\Datetime archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `bool checkJTI` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `\Datetime createdAt` + + When this issuer was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `string issuerURL` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS jwks` + + How signing keys are obtained for signature verification. + + - `?\Datetime jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + - `int maxJWTLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `string name` + + Admin-chosen slug identifier. + + - `?BetaFederationIssuerPollStatus pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `"federation_issuer" type` + + - `\Datetime updatedAt` + + When this issuer was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```php +beta->organization->federation->issuers->list( + includeArchived: true, + limit: 1, + page: 'page', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +`$client->beta->organization->federation->issuers->retrieve(string federationIssuerID, ?list betas): BetaFederationIssuer` + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Parameters + +- `federationIssuerID: string` + + ID of the federation issuer. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationIssuer` + + - `string id` + + Tagged ID of the federation issuer. + + - `?\Datetime archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `bool checkJTI` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `\Datetime createdAt` + + When this issuer was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `string issuerURL` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS jwks` + + How signing keys are obtained for signature verification. + + - `?\Datetime jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + - `int maxJWTLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `string name` + + Admin-chosen slug identifier. + + - `?BetaFederationIssuerPollStatus pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `"federation_issuer" type` + + - `\Datetime updatedAt` + + When this issuer was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```php +beta + ->organization + ->federation + ->issuers + ->retrieve( + 'federation_issuer_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24] +); + +var_dump($betaFederationIssuer); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +`$client->beta->organization->federation->issuers->update(string federationIssuerID, ?bool checkJTI, ?string issuerURL, ?JWKS jwks, ?bool jwksPollingDisabled, ?int maxJWTLifetimeSeconds, ?string name, ?list betas): BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Parameters + +- `federationIssuerID: string` + + ID of the federation issuer to update. + +- `checkJTI?:optional bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `issuerURL?:optional string` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + +- `jwks?:optional JWKS` + + Replaces the entire JWKS configuration. + +- `jwksPollingDisabled?:optional bool` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `maxJWTLifetimeSeconds?:optional int` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + +- `name?:optional string` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationIssuer` + + - `string id` + + Tagged ID of the federation issuer. + + - `?\Datetime archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `bool checkJTI` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `\Datetime createdAt` + + When this issuer was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `string issuerURL` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS jwks` + + How signing keys are obtained for signature verification. + + - `?\Datetime jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + - `int maxJWTLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `string name` + + Admin-chosen slug identifier. + + - `?BetaFederationIssuerPollStatus pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `"federation_issuer" type` + + - `\Datetime updatedAt` + + When this issuer was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```php +beta + ->organization + ->federation + ->issuers + ->update( + 'federation_issuer_id', + checkJTI: true, + issuerURL: 'x', + jwks: [ + 'type' => 'discovery', + 'caCertPEM' => 'ca_cert_pem', + 'discoveryBase' => 'discovery_base', + ], + jwksPollingDisabled: true, + maxJWTLifetimeSeconds: 1, + name: 'x', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaFederationIssuer); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +`$client->beta->organization->federation->issuers->archive(string federationIssuerID, ?list betas): BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Parameters + +- `federationIssuerID: string` + + ID of the federation issuer to archive. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationIssuer` + + - `string id` + + Tagged ID of the federation issuer. + + - `?\Datetime archivedAt` + + If set, all rules referencing this issuer reject token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `bool checkJTI` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `\Datetime createdAt` + + When this issuer was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `string issuerURL` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `JWKS jwks` + + How signing keys are obtained for signature verification. + + - `?\Datetime jwksPollingDisabledAt` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + - `int maxJWTLifetimeSeconds` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `string name` + + Admin-chosen slug identifier. + + - `?BetaFederationIssuerPollStatus pollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `"federation_issuer" type` + + - `\Datetime updatedAt` + + When this issuer was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```php +beta + ->organization + ->federation + ->issuers + ->archive( + 'federation_issuer_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24] +); + +var_dump($betaFederationIssuer); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +`$client->beta->organization->federation->rules->create(string issuerID, BetaFederationRuleMatch match, string name, string oauthScope, BetaServiceAccountTarget target, ?bool appliesToAllWorkspaces, ?array attributes, ?string description, ?int tokenLifetimeSeconds, ?string workspaceID, ?list betas): BetaFederationRule` + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Parameters + +- `issuerID: string` + + Tagged ID of the federation issuer. + +- `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + +- `oauthScope: string` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + +- `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + +- `appliesToAllWorkspaces?:optional bool` + + When true, enable this rule for every workspace in the org (including workspaces created later). + +- `attributes?:optional array` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `description?:optional string` + + Optional free-text description. + +- `tokenLifetimeSeconds?:optional int` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + +- `workspaceID?:optional string` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRule` + + - `string id` + + Tagged ID of the federation rule. + + - `bool appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `?\Datetime archivedAt` + + If set, this rule is archived and rejects token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `?array attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `\Datetime createdAt` + + When this rule was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `?string description` + + Optional free-text description. + + - `string issuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `?string issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string name` + + Admin-chosen slug identifier. + + - `string oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `int tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `"federation_rule" type` + + - `\Datetime updatedAt` + + When this rule was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `?string workspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `list workspaceIDs` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```php +beta->organization->federation->rules->create( + issuerID: 'issuer_id', + match: [ + 'audience' => 'audience', + 'claims' => ['foo' => 'string'], + 'condition' => 'condition', + 'subjectPrefix' => 'subject_prefix', + ], + name: 'x', + oauthScope: 'x', + target: [ + 'serviceAccountID' => 'svac_01SDCCSbTxrXDpWc1phhtcfK', + 'type' => 'service_account', + 'serviceAccountName' => 'service_account_name', + ], + appliesToAllWorkspaces: true, + attributes: ['foo' => 'string'], + description: 'description', + tokenLifetimeSeconds: 60, + workspaceID: 'workspace_id', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaFederationRule); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +`$client->beta->organization->federation->rules->list(?bool includeArchived, ?string issuerID, ?int limit, ?string page, ?list betas): PageCursor` + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Parameters + +- `includeArchived?:optional bool` + + Include archived resources. Defaults to false. + + default: false + +- `issuerID?:optional string` + + Filter to rules referencing this federation issuer. + +- `limit?:optional int` + + Number of results per page. + + default: 20 + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRule` + + - `string id` + + Tagged ID of the federation rule. + + - `bool appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `?\Datetime archivedAt` + + If set, this rule is archived and rejects token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `?array attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `\Datetime createdAt` + + When this rule was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `?string description` + + Optional free-text description. + + - `string issuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `?string issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string name` + + Admin-chosen slug identifier. + + - `string oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `int tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `"federation_rule" type` + + - `\Datetime updatedAt` + + When this rule was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `?string workspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `list workspaceIDs` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```php +beta->organization->federation->rules->list( + includeArchived: true, + issuerID: 'issuer_id', + limit: 1, + page: 'page', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +`$client->beta->organization->federation->rules->retrieve(string federationRuleID, ?list betas): BetaFederationRule` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRule` + + - `string id` + + Tagged ID of the federation rule. + + - `bool appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `?\Datetime archivedAt` + + If set, this rule is archived and rejects token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `?array attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `\Datetime createdAt` + + When this rule was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `?string description` + + Optional free-text description. + + - `string issuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `?string issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string name` + + Admin-chosen slug identifier. + + - `string oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `int tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `"federation_rule" type` + + - `\Datetime updatedAt` + + When this rule was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `?string workspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `list workspaceIDs` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```php +beta->organization->federation->rules->retrieve( + 'federation_rule_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24] +); + +var_dump($betaFederationRule); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +`$client->beta->organization->federation->rules->update(string federationRuleID, ?bool appliesToAllWorkspaces, ?array attributes, ?string description, ?BetaFederationRuleMatch match, ?string name, ?string oauthScope, ?BetaServiceAccountTarget target, ?int tokenLifetimeSeconds, ?string workspaceID, ?list betas): BetaFederationRule` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule to update. + +- `appliesToAllWorkspaces?:optional bool` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `attributes?:optional array` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `description?:optional string` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + +- `match?:optional BetaFederationRuleMatch` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + +- `name?:optional string` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + +- `oauthScope?:optional string` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + +- `target?:optional BetaServiceAccountTarget` + + Bind to a fixed service account by ID. + +- `tokenLifetimeSeconds?:optional int` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + +- `workspaceID?:optional string` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRule` + + - `string id` + + Tagged ID of the federation rule. + + - `bool appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `?\Datetime archivedAt` + + If set, this rule is archived and rejects token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `?array attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `\Datetime createdAt` + + When this rule was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `?string description` + + Optional free-text description. + + - `string issuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `?string issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string name` + + Admin-chosen slug identifier. + + - `string oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `int tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `"federation_rule" type` + + - `\Datetime updatedAt` + + When this rule was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `?string workspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `list workspaceIDs` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```php +beta->organization->federation->rules->update( + 'federation_rule_id', + appliesToAllWorkspaces: true, + attributes: ['foo' => 'string'], + description: 'description', + match: [ + 'audience' => 'audience', + 'claims' => ['foo' => 'string'], + 'condition' => 'condition', + 'subjectPrefix' => 'subject_prefix', + ], + name: 'x', + oauthScope: 'x', + target: [ + 'serviceAccountID' => 'svac_01SDCCSbTxrXDpWc1phhtcfK', + 'type' => 'service_account', + 'serviceAccountName' => 'service_account_name', + ], + tokenLifetimeSeconds: 60, + workspaceID: 'workspace_id', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaFederationRule); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +`$client->beta->organization->federation->rules->archive(string federationRuleID, ?list betas): BetaFederationRule` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule to archive. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRule` + + - `string id` + + Tagged ID of the federation rule. + + - `bool appliesToAllWorkspaces` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `?\Datetime archivedAt` + + If set, this rule is archived and rejects token exchange. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `?array attributes` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `\Datetime createdAt` + + When this rule was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `?string description` + + Optional free-text description. + + - `string issuerID` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `?string issuerName` + + Issuer's display name at read time. + + - `BetaFederationRuleMatch match` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `string name` + + Admin-chosen slug identifier. + + - `string oauthScope` + + Space-separated OAuth scopes granted on the minted token. + + - `BetaServiceAccountTarget target` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `int tokenLifetimeSeconds` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `"federation_rule" type` + + - `\Datetime updatedAt` + + When this rule was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `?string workspaceID` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `list workspaceIDs` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```php +beta->organization->federation->rules->archive( + 'federation_rule_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24] +); + +var_dump($betaFederationRule); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +`$client->beta->organization->federation->rules->workspaces->add(string federationRuleID, string workspaceID, ?list betas): BetaFederationRuleWorkspace` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule. + +- `workspaceID: string` + + Tagged ID of the workspace to enable this rule for. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRuleWorkspace` + + - `\Datetime createdAt` + + When this workspace was enabled for the rule. + + - `?string createdByActorID` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `string federationRuleID` + + Tagged ID of the federation rule. + + - `"federation_rule_workspace" type` + + - `string workspaceID` + + Tagged ID of the workspace this rule is enabled for. + + - `?string workspaceName` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```php +beta + ->organization + ->federation + ->rules + ->workspaces + ->add( + 'federation_rule_id', + workspaceID: 'workspace_id', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaFederationRuleWorkspace); +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +`$client->beta->organization->federation->rules->workspaces->list(string federationRuleID, ?int limit, ?string page, ?list betas): PageCursor` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule. + +- `limit?:optional int` + + Number of results per page. + + default: 20 + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `BetaFederationRuleWorkspace` + + - `\Datetime createdAt` + + When this workspace was enabled for the rule. + + - `?string createdByActorID` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `string federationRuleID` + + Tagged ID of the federation rule. + + - `"federation_rule_workspace" type` + + - `string workspaceID` + + Tagged ID of the workspace this rule is enabled for. + + - `?string workspaceName` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```php +beta->organization->federation->rules->workspaces->list( + 'federation_rule_id', + limit: 1, + page: 'page', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +`$client->beta->organization->federation->rules->workspaces->remove(string workspaceID, string federationRuleID, ?list betas): WorkspaceRemoveResponse` + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule. + +- `workspaceID: string` + + ID of the workspace to disable for. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `WorkspaceRemoveResponse` + + - `string federationRuleID` + + Tagged ID of the federation rule. + + - `"federation_rule_workspace_deleted" type` + + - `string workspaceID` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```php +beta->organization->federation->rules->workspaces->remove( + 'workspace_id', + federationRuleID: 'federation_rule_id', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($workspace); +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +`$client->beta->organization->invites->create(string email, Role role, ?list rbacGroupIDs): OrganizationInvite` + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Parameters + +- `email: string` + + Email of the User. + +- `role: Role` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + +- `rbacGroupIDs?:optional list` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + +#### Returns + +- `OrganizationInvite` + + - `string id` + + ID of the Invite. + + - `?\Datetime acceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + - `string email` + + Email of the User being invited. + + - `\Datetime expiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + - `\Datetime invitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + - `list rbacGroupIDs` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `Status status` + + Status of the Invite. + + - `"invite" type` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```php +beta->organization->invites->create( + email: 'user@emaildomain.com', role: 'user', rbacGroupIDs: ['string'] +); + +var_dump($betaOrganizationInvite); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +`$client->beta->organization->invites->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list roles, ?list statuses): Page` + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Parameters + +- `afterID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `beforeID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email?:optional string` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + +- `limit?:optional int` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20 + +- `roles?:optional list` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +- `statuses?:optional list` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + +#### Returns + +- `OrganizationInvite` + + - `string id` + + ID of the Invite. + + - `?\Datetime acceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + - `string email` + + Email of the User being invited. + + - `\Datetime expiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + - `\Datetime invitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + - `list rbacGroupIDs` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `Status status` + + Status of the Invite. + + - `"invite" type` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```php +beta->organization->invites->list( + afterID: 'after_id', + beforeID: 'before_id', + email: 'dev@stainless.com', + limit: 1, + roles: ['string'], + statuses: ['accepted'], +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +`$client->beta->organization->invites->retrieve(string inviteID): OrganizationInvite` + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Parameters + +- `inviteID: string` + + ID of the Invite. + +#### Returns + +- `OrganizationInvite` + + - `string id` + + ID of the Invite. + + - `?\Datetime acceptedAt` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + - `string email` + + Email of the User being invited. + + - `\Datetime expiresAt` + + RFC 3339 datetime string indicating when the Invite expires. + + - `\Datetime invitedAt` + + RFC 3339 datetime string indicating when the Invite was created. + + - `list rbacGroupIDs` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `Status status` + + Status of the Invite. + + - `"invite" type` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```php +beta->organization->invites->retrieve( + 'invite_id' +); + +var_dump($betaOrganizationInvite); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +`$client->beta->organization->invites->delete(string inviteID): InviteDeleteResponse` + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Parameters + +- `inviteID: string` + + ID of the Invite. + +#### Returns + +- `InviteDeleteResponse` + + - `string id` + + ID of the Invite. + + - `"invite_deleted" type` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + +#### Example + +```php +beta->organization->invites->delete('invite_id'); + +var_dump($invite); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +`$client->beta->organization->serviceAccounts->create(string name, ?string description, ?OrganizationRole organizationRole, ?list betas): ServiceAccount` + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Parameters + +- `name: string` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + +- `description?:optional string` + + Optional free-text description. + +- `organizationRole?:optional OrganizationRole` + + Org-level role. Defaults to `developer`. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccount` + + - `string id` + + Tagged ID of the service account. + + - `?\Datetime archivedAt` + + If set, this service account is archived. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `\Datetime createdAt` + + When this service account was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `?string description` + + Optional free-text description. + + - `string name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"service_account" type` + + - `\Datetime updatedAt` + + When this service account was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```php +beta->organization->serviceAccounts->create( + name: 'ci-deploy-bot', + description: 'description', + organizationRole: 'admin', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaServiceAccount); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +`$client->beta->organization->serviceAccounts->list(?bool includeArchived, ?int limit, ?string page, ?list betas): PageCursor` + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Parameters + +- `includeArchived?:optional bool` + + Include archived resources. Defaults to false. + + default: false + +- `limit?:optional int` + + Number of results per page. + + default: 20 + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccount` + + - `string id` + + Tagged ID of the service account. + + - `?\Datetime archivedAt` + + If set, this service account is archived. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `\Datetime createdAt` + + When this service account was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `?string description` + + Optional free-text description. + + - `string name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"service_account" type` + + - `\Datetime updatedAt` + + When this service account was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```php +beta->organization->serviceAccounts->list( + includeArchived: true, + limit: 1, + page: 'page', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +`$client->beta->organization->serviceAccounts->retrieve(string serviceAccountID, ?list betas): ServiceAccount` + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccount` + + - `string id` + + Tagged ID of the service account. + + - `?\Datetime archivedAt` + + If set, this service account is archived. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `\Datetime createdAt` + + When this service account was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `?string description` + + Optional free-text description. + + - `string name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"service_account" type` + + - `\Datetime updatedAt` + + When this service account was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```php +beta->organization->serviceAccounts->retrieve( + 'service_account_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24] +); + +var_dump($betaServiceAccount); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +`$client->beta->organization->serviceAccounts->update(string serviceAccountID, ?string description, ?OrganizationRole organizationRole, ?list betas): ServiceAccount` + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account to update. + +- `description?:optional string` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + +- `organizationRole?:optional OrganizationRole` + + Replaces the org-level role. Omit or send `null` to leave unchanged. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccount` + + - `string id` + + Tagged ID of the service account. + + - `?\Datetime archivedAt` + + If set, this service account is archived. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `\Datetime createdAt` + + When this service account was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `?string description` + + Optional free-text description. + + - `string name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"service_account" type` + + - `\Datetime updatedAt` + + When this service account was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```php +beta->organization->serviceAccounts->update( + 'service_account_id', + description: 'description', + organizationRole: 'admin', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaServiceAccount); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +`$client->beta->organization->serviceAccounts->archive(string serviceAccountID, ?list betas): ServiceAccount` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account to archive. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccount` + + - `string id` + + Tagged ID of the service account. + + - `?\Datetime archivedAt` + + If set, this service account is archived. + + - `?string archivedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `\Datetime createdAt` + + When this service account was created. + + - `?string createdByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `?string description` + + Optional free-text description. + + - `string name` + + Admin-chosen slug identifier. + + - `OrganizationRole organizationRole` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"service_account" type` + + - `\Datetime updatedAt` + + When this service account was last updated. + + - `?string updatedByActorID` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```php +beta->organization->serviceAccounts->archive( + 'service_account_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24] +); + +var_dump($betaServiceAccount); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +`$client->beta->organization->serviceAccounts->workspaces->add(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole, ?list betas): ServiceAccountWorkspaceMember` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account. + +- `workspaceID: string` + + Tagged workspace ID to add the service account to. + +- `workspaceRole: NoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccountWorkspaceMember` + + - `?string createdByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `?bool implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `string serviceAccountID` + + Tagged service account ID (`svac_...`). + + - `"service_account_workspace_member" type` + + - `string workspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + +#### Example + +```php +beta + ->organization + ->serviceAccounts + ->workspaces + ->add( + 'service_account_id', + workspaceID: 'workspace_id', + workspaceRole: NoBillingWorkspaceRole::WORKSPACE_ADMIN, + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaServiceAccountWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +`$client->beta->organization->serviceAccounts->workspaces->list(string serviceAccountID, ?int limit, ?string page, ?list betas): PageCursor` + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account. + +- `limit?:optional int` + + Number of results per page. + + default: 20 + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccountWorkspaceMember` + + - `?string createdByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `?bool implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `string serviceAccountID` + + Tagged service account ID (`svac_...`). + + - `"service_account_workspace_member" type` + + - `string workspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + +#### Example + +```php +beta->organization->serviceAccounts->workspaces->list( + 'service_account_id', + limit: 1, + page: 'page', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +`$client->beta->organization->serviceAccounts->workspaces->remove(string workspaceID, string serviceAccountID, ?list betas): WorkspaceRemoveResponse` + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account. + +- `workspaceID: string` + + ID of the workspace. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `WorkspaceRemoveResponse` + + - `string serviceAccountID` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `"service_account_workspace_member_deleted" type` + + - `string workspaceID` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```php +beta->organization->serviceAccounts->workspaces->remove( + 'workspace_id', + serviceAccountID: 'service_account_id', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($workspace); +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +`$client->beta->organization->users->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list roles): Page` + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Parameters + +- `afterID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `beforeID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email?:optional string` + + Filter by user email. + +- `limit?:optional int` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20 + +- `roles?:optional list` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `OrganizationUser` + + - `string id` + + ID of the User. + + - `\Datetime addedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + - `string email` + + Email of the User. + + - `string name` + + Name of the User. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `"user" type` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```php +beta->organization->users->list( + afterID: 'after_id', + beforeID: 'before_id', + email: 'dev@stainless.com', + limit: 1, + roles: ['string'], +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +`$client->beta->organization->users->retrieve(string userID): OrganizationUser` + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Parameters + +- `userID: string` + + ID of the User. + +#### Returns + +- `OrganizationUser` + + - `string id` + + ID of the User. + + - `\Datetime addedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + - `string email` + + Email of the User. + + - `string name` + + Name of the User. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `"user" type` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```php +beta->organization->users->retrieve('user_id'); + +var_dump($betaOrganizationUser); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +`$client->beta->organization->users->update(string userID, Role role): OrganizationUser` + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Parameters + +- `userID: string` + + ID of the User. + +- `role: Role` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + +#### Returns + +- `OrganizationUser` + + - `string id` + + ID of the User. + + - `\Datetime addedAt` + + RFC 3339 datetime string indicating when the User joined the Organization. + + - `string email` + + Email of the User. + + - `string name` + + Name of the User. + + - `BetaOrganizationRole role` + + Organization role of the User. + + - `"user" type` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```php +beta->organization->users->update( + 'user_id', role: 'user' +); + +var_dump($betaOrganizationUser); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +`$client->beta->organization->users->remove(string userID): UserRemoveResponse` + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Parameters + +- `userID: string` + + ID of the User. + +#### Returns + +- `UserRemoveResponse` + + - `string id` + + ID of the User. + + - `"user_deleted" type` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + +#### Example + +```php +beta->organization->users->remove('user_id'); + +var_dump($user); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +`$client->beta->organization->workspaces->list(?string afterID, ?string beforeID, ?bool includeArchived, ?int limit): Page` + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Parameters + +- `afterID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `beforeID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `includeArchived?:optional bool` + + Whether to include Workspaces that have been archived in the response + + default: false + +- `limit?:optional int` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20 + +#### Returns + +- `Workspace` + + - `string id` + + ID of the Workspace. + + - `?\Datetime archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + - `string compartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `\Datetime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + - `DataResidency dataResidency` + + Data residency configuration. + + - `string displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `?string externalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `string name` + + Name of the Workspace. + + - `array tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `"workspace" type` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```php +beta->organization->workspaces->list( + afterID: 'after_id', beforeID: 'before_id', includeArchived: true, limit: 1 +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +`$client->beta->organization->workspaces->create(string name, ?DataResidencyCreateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?array tags, ?list betas): Workspace` + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Parameters + +- `name: string` + + Name of the Workspace. + +- `dataResidency?:optional DataResidencyCreateConfig` + + Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + +- `displayColor?:optional string` + + Hex color code representing the Workspace in the Anthropic Console. + +- `externalKeyID?:optional string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `tags?:optional array` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `Workspace` + + - `string id` + + ID of the Workspace. + + - `?\Datetime archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + - `string compartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `\Datetime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + - `DataResidency dataResidency` + + Data residency configuration. + + - `string displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `?string externalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `string name` + + Name of the Workspace. + + - `array tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `"workspace" type` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```php +beta->organization->workspaces->create( + name: 'x', + dataResidency: [ + 'allowedInferenceGeos' => 'unrestricted', + 'defaultInferenceGeo' => 'global', + 'workspaceGeo' => 'us', + ], + displayColor: '#6C5BB9', + externalKeyID: 'ekey_01SDCCSbTxrXDpWc1phhtcfK', + tags: ['env' => 'prod', 'team' => 'platform'], + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaWorkspace); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +`$client->beta->organization->workspaces->retrieve(string workspaceID): Workspace` + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +#### Returns + +- `Workspace` + + - `string id` + + ID of the Workspace. + + - `?\Datetime archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + - `string compartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `\Datetime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + - `DataResidency dataResidency` + + Data residency configuration. + + - `string displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `?string externalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `string name` + + Name of the Workspace. + + - `array tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `"workspace" type` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```php +beta->organization->workspaces->retrieve( + 'workspace_id' +); + +var_dump($betaWorkspace); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +`$client->beta->organization->workspaces->update(string workspaceID, ?DataResidencyUpdateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?string name, ?array tags): Workspace` + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Parameters + +- `workspaceID: string` + +- `dataResidency?:optional DataResidencyUpdateConfig` + + Data residency configuration for the workspace. + +- `displayColor?:optional string` + + Hex color code representing the Workspace in the Anthropic Console. + +- `externalKeyID?:optional string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `name?:optional string` + + Name of the Workspace. + +- `tags?:optional array` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `Workspace` + + - `string id` + + ID of the Workspace. + + - `?\Datetime archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + - `string compartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `\Datetime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + - `DataResidency dataResidency` + + Data residency configuration. + + - `string displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `?string externalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `string name` + + Name of the Workspace. + + - `array tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `"workspace" type` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```php +beta->organization->workspaces->update( + 'workspace_id', + dataResidency: [ + 'allowedInferenceGeos' => 'unrestricted', 'defaultInferenceGeo' => 'global' + ], + displayColor: '#6C5BB9', + externalKeyID: 'ekey_01SDCCSbTxrXDpWc1phhtcfK', + name: 'x', + tags: ['env' => 'prod', 'team' => 'platform'], +); + +var_dump($betaWorkspace); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +`$client->beta->organization->workspaces->archive(string workspaceID): Workspace` + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Parameters + +- `workspaceID: string` + +#### Returns + +- `Workspace` + + - `string id` + + ID of the Workspace. + + - `?\Datetime archivedAt` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + - `string compartmentID` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `\Datetime createdAt` + + RFC 3339 datetime string indicating when the Workspace was created. + + - `DataResidency dataResidency` + + Data residency configuration. + + - `string displayColor` + + Hex color code representing the Workspace in the Anthropic Console. + + - `?string externalKeyID` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `string name` + + Name of the Workspace. + + - `array tags` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `"workspace" type` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```php +beta->organization->workspaces->archive( + 'workspace_id' +); + +var_dump($betaWorkspace); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +`$client->beta->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?int limit, ?string page): PageCursor` + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `workspaceID: string` + + The ID of the workspace. + +- `groupType?:optional GroupType` + + Filter by group type. + +- `limit?:optional int` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `BetaWorkspaceRateLimit` + + - `GroupType groupType` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `list limits` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `?list models` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `string rateLimitID` + + The `id` of the RateLimit group this override applies to. + + - `"workspace_rate_limit" type` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + - `string workspaceID` + + ID of the Workspace this override applies to. + +#### Example + +```php +beta->organization->workspaces->rateLimits->list( + 'workspace_id', groupType: 'batch', limit: 1, page: 'page' +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +`$client->beta->organization->workspaces->members->list(string workspaceID, ?string afterID, ?string beforeID, ?int limit): Page` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +- `afterID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `beforeID?:optional string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `limit?:optional int` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20 + +#### Returns + +- `WorkspaceMember` + + - `"workspace_member" type` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `string userID` + + ID of the User. + + - `string workspaceID` + + ID of the Workspace. + + - `WorkspaceRole workspaceRole` + + Role of the Workspace Member. + +#### Example + +```php +beta->organization->workspaces->members->list( + 'workspace_id', afterID: 'after_id', beforeID: 'before_id', limit: 1 +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +`$client->beta->organization->workspaces->members->add(string workspaceID, string userID, NoBillingWorkspaceRole workspaceRole): WorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +- `userID: string` + + ID of the User. + +- `workspaceRole: NoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + +#### Returns + +- `WorkspaceMember` + + - `"workspace_member" type` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `string userID` + + ID of the User. + + - `string workspaceID` + + ID of the Workspace. + + - `WorkspaceRole workspaceRole` + + Role of the Workspace Member. + +#### Example + +```php +beta->organization->workspaces->members->add( + 'workspace_id', + userID: 'user_01WCz1FkmYMm4gnmykNKUu3Q', + workspaceRole: NoBillingWorkspaceRole::WORKSPACE_ADMIN, +); + +var_dump($betaWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +`$client->beta->organization->workspaces->members->retrieve(string userID, string workspaceID): WorkspaceMember` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +- `userID: string` + + ID of the User. + +#### Returns + +- `WorkspaceMember` + + - `"workspace_member" type` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `string userID` + + ID of the User. + + - `string workspaceID` + + ID of the Workspace. + + - `WorkspaceRole workspaceRole` + + Role of the Workspace Member. + +#### Example + +```php +beta + ->organization + ->workspaces + ->members + ->retrieve('user_id', workspaceID: 'workspace_id'); + +var_dump($betaWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +`$client->beta->organization->workspaces->members->update(string userID, string workspaceID, WorkspaceRole workspaceRole): WorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +- `userID: string` + + ID of the User. + +- `workspaceRole: WorkspaceRole` + + New workspace role for the User. + +#### Returns + +- `WorkspaceMember` + + - `"workspace_member" type` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `string userID` + + ID of the User. + + - `string workspaceID` + + ID of the Workspace. + + - `WorkspaceRole workspaceRole` + + Role of the Workspace Member. + +#### Example + +```php +beta->organization->workspaces->members->update( + 'user_id', + workspaceID: 'workspace_id', + workspaceRole: WorkspaceRole::WORKSPACE_ADMIN, +); + +var_dump($betaWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +`$client->beta->organization->workspaces->members->remove(string userID, string workspaceID): MemberRemoveResponse` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +- `userID: string` + + ID of the User. + +#### Returns + +- `MemberRemoveResponse` + + - `"workspace_member_deleted" type` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + - `string userID` + + ID of the User. + + - `string workspaceID` + + ID of the Workspace. + +#### Example + +```php +beta->organization->workspaces->members->remove( + 'user_id', workspaceID: 'workspace_id' +); + +var_dump($member); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +`$client->beta->organization->workspaces->serviceAccounts->list(string workspaceID, ?int limit, ?string page, ?list betas): PageCursor` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace. + +- `limit?:optional int` + + Number of results per page. + + default: 20 + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccountWorkspaceMember` + + - `?string createdByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `?bool implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `string serviceAccountID` + + Tagged service account ID (`svac_...`). + + - `"service_account_workspace_member" type` + + - `string workspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + +#### Example + +```php +beta->organization->workspaces->serviceAccounts->list( + 'workspace_id', + limit: 1, + page: 'page', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +`$client->beta->organization->workspaces->serviceAccounts->add(string workspaceID, string serviceAccountID, NoBillingWorkspaceRole workspaceRole, ?list betas): ServiceAccountWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace. + +- `serviceAccountID: string` + + Tagged service account ID to add. + +- `workspaceRole: NoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccountWorkspaceMember` + + - `?string createdByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `?bool implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `string serviceAccountID` + + Tagged service account ID (`svac_...`). + + - `"service_account_workspace_member" type` + + - `string workspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + +#### Example + +```php +beta + ->organization + ->workspaces + ->serviceAccounts + ->add( + 'workspace_id', + serviceAccountID: 'service_account_id', + workspaceRole: NoBillingWorkspaceRole::WORKSPACE_ADMIN, + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaServiceAccountWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Get Service Account Workspace Member + +`$client->beta->organization->workspaces->serviceAccounts->retrieve(string serviceAccountID, string workspaceID, ?list betas): ServiceAccountWorkspaceMember` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace. + +- `serviceAccountID: string` + + ID of the service account. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccountWorkspaceMember` + + - `?string createdByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `?bool implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `string serviceAccountID` + + Tagged service account ID (`svac_...`). + + - `"service_account_workspace_member" type` + + - `string workspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + +#### Example + +```php +beta + ->organization + ->workspaces + ->serviceAccounts + ->retrieve( + 'service_account_id', + workspaceID: 'workspace_id', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaServiceAccountWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Update Service Account Workspace Member + +`$client->beta->organization->workspaces->serviceAccounts->update(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole, ?list betas): ServiceAccountWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace. + +- `serviceAccountID: string` + + ID of the service account. + +- `workspaceRole: NoBillingWorkspaceRole` + + New role for the service account in this workspace. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccountWorkspaceMember` + + - `?string createdByActorID` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `?bool implicit` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `string serviceAccountID` + + Tagged service account ID (`svac_...`). + + - `"service_account_workspace_member" type` + + - `string workspaceID` + + Tagged workspace ID (`wrkspc_...`). + + - `WorkspaceRole workspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + +#### Example + +```php +beta + ->organization + ->workspaces + ->serviceAccounts + ->update( + 'service_account_id', + workspaceID: 'workspace_id', + workspaceRole: NoBillingWorkspaceRole::WORKSPACE_ADMIN, + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($betaServiceAccountWorkspaceMember); +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### Delete Service Account Workspace Member + +`$client->beta->organization->workspaces->serviceAccounts->remove(string serviceAccountID, string workspaceID, ?list betas): ServiceAccountRemoveResponse` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace. + +- `serviceAccountID: string` + + ID of the service account. + +- `betas?:optional list` + + Optional header to specify the beta version(s) you want to use. + +#### Returns + +- `ServiceAccountRemoveResponse` + + - `string serviceAccountID` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `"service_account_workspace_member_deleted" type` + + - `string workspaceID` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```php +beta + ->organization + ->workspaces + ->serviceAccounts + ->remove( + 'service_account_id', + workspaceID: 'workspace_id', + betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], +); + +var_dump($serviceAccount); +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Rate Limits + +### List Organization Rate Limits + +`$client->beta->organization->rateLimits->list(?GroupType groupType, ?int limit, ?string model, ?string page): PageCursor` + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `groupType?:optional GroupType` + + Filter by group type. + +- `limit?:optional int` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + +- `model?:optional string` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + +- `page?:optional string` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `OrganizationRateLimit` + + - `string id` + + Stable identifier for this rate-limit group within the organization. + + - `GroupType groupType` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `list limits` + + The limiter values that apply to this group. + + - `?list models` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `"rate_limit" type` + + Object type. Always `rate_limit` for organization rate-limit entries. + +#### Example + +```php +beta->organization->rateLimits->list( + groupType: 'batch', limit: 1, model: 'model', page: 'page' +); + +var_dump($page); +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" +} +``` diff --git a/content/en/api/php/beta/environments.md b/content/en/api/php/beta/environments.md index ae0af494c..d79d127c4 100644 --- a/content/en/api/php/beta/environments.md +++ b/content/en/api/php/beta/environments.md @@ -822,6 +822,8 @@ var_dump($betaEnvironment); When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + ### Beta Environment - `BetaEnvironment` @@ -912,7 +914,7 @@ var_dump($betaEnvironment); - `?bool allowPackageManagers` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `?list allowedHosts` diff --git a/content/en/api/php/beta/memory_stores.md b/content/en/api/php/beta/memory_stores.md index b48148ca6..f93c1c9ab 100644 --- a/content/en/api/php/beta/memory_stores.md +++ b/content/en/api/php/beta/memory_stores.md @@ -625,7 +625,7 @@ Create a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -742,7 +742,7 @@ List memories - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -858,7 +858,7 @@ Retrieve a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -970,7 +970,7 @@ Update a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -1159,7 +1159,7 @@ List memory versions - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` @@ -1293,7 +1293,7 @@ Retrieve a memory version - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` @@ -1414,7 +1414,7 @@ Redact a memory version - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` diff --git a/content/en/api/php/beta/memory_stores/memories.md b/content/en/api/php/beta/memory_stores/memories.md index 10bb49f8e..bd20ffea2 100644 --- a/content/en/api/php/beta/memory_stores/memories.md +++ b/content/en/api/php/beta/memory_stores/memories.md @@ -54,7 +54,7 @@ Create a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -171,7 +171,7 @@ List memories - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -287,7 +287,7 @@ Retrieve a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -399,7 +399,7 @@ Update a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -652,7 +652,7 @@ var_dump($betaManagedAgentsDeletedMemory); - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` @@ -696,7 +696,7 @@ var_dump($betaManagedAgentsDeletedMemory); - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` diff --git a/content/en/api/php/beta/memory_stores/memories/create.md b/content/en/api/php/beta/memory_stores/memories/create.md index f622a7743..8fda24364 100644 --- a/content/en/api/php/beta/memory_stores/memories/create.md +++ b/content/en/api/php/beta/memory_stores/memories/create.md @@ -52,7 +52,7 @@ Create a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` diff --git a/content/en/api/php/beta/memory_stores/memories/list.md b/content/en/api/php/beta/memory_stores/memories/list.md index a63290375..37b99d53b 100644 --- a/content/en/api/php/beta/memory_stores/memories/list.md +++ b/content/en/api/php/beta/memory_stores/memories/list.md @@ -62,7 +62,7 @@ List memories - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` diff --git a/content/en/api/php/beta/memory_stores/memories/retrieve.md b/content/en/api/php/beta/memory_stores/memories/retrieve.md index 9437b068f..9d8c226d2 100644 --- a/content/en/api/php/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/php/beta/memory_stores/memories/retrieve.md @@ -46,7 +46,7 @@ Retrieve a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` diff --git a/content/en/api/php/beta/memory_stores/memories/update.md b/content/en/api/php/beta/memory_stores/memories/update.md index 03fada7ae..40a268d5b 100644 --- a/content/en/api/php/beta/memory_stores/memories/update.md +++ b/content/en/api/php/beta/memory_stores/memories/update.md @@ -58,7 +58,7 @@ Update a memory - `string memoryVersionID` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `string path` diff --git a/content/en/api/php/beta/memory_stores/memory_versions.md b/content/en/api/php/beta/memory_stores/memory_versions.md index 0ab7760ea..f10d38d7a 100644 --- a/content/en/api/php/beta/memory_stores/memory_versions.md +++ b/content/en/api/php/beta/memory_stores/memory_versions.md @@ -70,7 +70,7 @@ List memory versions - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` @@ -204,7 +204,7 @@ Retrieve a memory version - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` @@ -325,7 +325,7 @@ Redact a memory version - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` @@ -475,7 +475,7 @@ var_dump($betaManagedAgentsMemoryVersion); - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` diff --git a/content/en/api/php/beta/memory_stores/memory_versions/list.md b/content/en/api/php/beta/memory_stores/memory_versions/list.md index a455a07e5..175894153 100644 --- a/content/en/api/php/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/php/beta/memory_stores/memory_versions/list.md @@ -68,7 +68,7 @@ List memory versions - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` diff --git a/content/en/api/php/beta/memory_stores/memory_versions/redact.md b/content/en/api/php/beta/memory_stores/memory_versions/redact.md index 66a42d78c..3c5194909 100644 --- a/content/en/api/php/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/php/beta/memory_stores/memory_versions/redact.md @@ -30,7 +30,7 @@ Redact a memory version - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` diff --git a/content/en/api/php/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/php/beta/memory_stores/memory_versions/retrieve.md index a3cd8c5a7..5f89e4b18 100644 --- a/content/en/api/php/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/php/beta/memory_stores/memory_versions/retrieve.md @@ -34,7 +34,7 @@ Retrieve a memory version - `string memoryID` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `string memoryStoreID` diff --git a/content/en/api/php/beta/messages.md b/content/en/api/php/beta/messages.md index 4260ea721..cc69e19d7 100644 --- a/content/en/api/php/beta/messages.md +++ b/content/en/api/php/beta/messages.md @@ -4529,12 +4529,14 @@ var_dump($betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `int outputTokens` The cumulative number of output tokens which were used. @@ -7280,12 +7282,14 @@ var_dump($betaMessageTokensCount); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `int outputTokens` The number of output tokens which were used. diff --git a/content/en/api/php/beta/sessions.md b/content/en/api/php/beta/sessions.md index 50858c82a..b6ca07fdd 100644 --- a/content/en/api/php/beta/sessions.md +++ b/content/en/api/php/beta/sessions.md @@ -4546,7 +4546,7 @@ List Session Threads - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` @@ -4723,7 +4723,7 @@ Get Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` @@ -4894,7 +4894,7 @@ Archive Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` diff --git a/content/en/api/php/beta/sessions/threads.md b/content/en/api/php/beta/sessions/threads.md index 2851117c9..69127d2c2 100644 --- a/content/en/api/php/beta/sessions/threads.md +++ b/content/en/api/php/beta/sessions/threads.md @@ -34,7 +34,7 @@ List Session Threads - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` @@ -211,7 +211,7 @@ Get Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` @@ -382,7 +382,7 @@ Archive Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` @@ -537,7 +537,7 @@ var_dump($betaManagedAgentsSessionThread); - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` diff --git a/content/en/api/php/beta/sessions/threads/archive.md b/content/en/api/php/beta/sessions/threads/archive.md index 3f1d4cf3b..0d3467057 100644 --- a/content/en/api/php/beta/sessions/threads/archive.md +++ b/content/en/api/php/beta/sessions/threads/archive.md @@ -26,7 +26,7 @@ Archive Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` diff --git a/content/en/api/php/beta/sessions/threads/list.md b/content/en/api/php/beta/sessions/threads/list.md index 3ded56247..191522c83 100644 --- a/content/en/api/php/beta/sessions/threads/list.md +++ b/content/en/api/php/beta/sessions/threads/list.md @@ -32,7 +32,7 @@ List Session Threads - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` diff --git a/content/en/api/php/beta/sessions/threads/retrieve.md b/content/en/api/php/beta/sessions/threads/retrieve.md index 8362275c3..cf3eecd52 100644 --- a/content/en/api/php/beta/sessions/threads/retrieve.md +++ b/content/en/api/php/beta/sessions/threads/retrieve.md @@ -26,7 +26,7 @@ Get Session Thread - `Agent agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `?\Datetime archivedAt` diff --git a/content/en/api/php/beta/tunnels.md b/content/en/api/php/beta/tunnels.md index e77e23e98..b0e6a9ad8 100644 --- a/content/en/api/php/beta/tunnels.md +++ b/content/en/api/php/beta/tunnels.md @@ -480,7 +480,7 @@ var_dump($betaTunnelToken); ### Create Tunnel Certificate -`$client->beta->tunnels->certificates->create(string tunnelID, string caCertificatePem, ?list betas): TunnelCertificate` +`$client->beta->tunnels->certificates->create(string tunnelID, string caCertificatePEM, ?list betas): TunnelCertificate` **POST** `/v1/tunnels/{tunnel_id}/certificates` @@ -492,7 +492,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `tunnelID: string` -- `caCertificatePem: string` +- `caCertificatePEM: string` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -541,7 +541,7 @@ $client = new Client(apiKey: 'my-anthropic-api-key'); $betaTunnelCertificate = $client->beta->tunnels->certificates->create( 'tunnel_id', - caCertificatePem: 'ca_certificate_pem', + caCertificatePEM: 'ca_certificate_pem', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], ); diff --git a/content/en/api/php/beta/tunnels/certificates.md b/content/en/api/php/beta/tunnels/certificates.md index 241d7fe26..20a98b37a 100644 --- a/content/en/api/php/beta/tunnels/certificates.md +++ b/content/en/api/php/beta/tunnels/certificates.md @@ -2,7 +2,7 @@ ## Create Tunnel Certificate -`$client->beta->tunnels->certificates->create(string tunnelID, string caCertificatePem, ?list betas): TunnelCertificate` +`$client->beta->tunnels->certificates->create(string tunnelID, string caCertificatePEM, ?list betas): TunnelCertificate` **POST** `/v1/tunnels/{tunnel_id}/certificates` @@ -14,7 +14,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `tunnelID: string` -- `caCertificatePem: string` +- `caCertificatePEM: string` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -63,7 +63,7 @@ $client = new Client(apiKey: 'my-anthropic-api-key'); $betaTunnelCertificate = $client->beta->tunnels->certificates->create( 'tunnel_id', - caCertificatePem: 'ca_certificate_pem', + caCertificatePEM: 'ca_certificate_pem', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], ); diff --git a/content/en/api/php/beta/tunnels/certificates/create.md b/content/en/api/php/beta/tunnels/certificates/create.md index 8e1b2b8d8..4bab1db15 100644 --- a/content/en/api/php/beta/tunnels/certificates/create.md +++ b/content/en/api/php/beta/tunnels/certificates/create.md @@ -1,6 +1,6 @@ # Create Tunnel Certificate -`$client->beta->tunnels->certificates->create(string tunnelID, string caCertificatePem, ?list betas): TunnelCertificate` +`$client->beta->tunnels->certificates->create(string tunnelID, string caCertificatePEM, ?list betas): TunnelCertificate` **POST** `/v1/tunnels/{tunnel_id}/certificates` @@ -12,7 +12,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `tunnelID: string` -- `caCertificatePem: string` +- `caCertificatePEM: string` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. @@ -61,7 +61,7 @@ $client = new Client(apiKey: 'my-anthropic-api-key'); $betaTunnelCertificate = $client->beta->tunnels->certificates->create( 'tunnel_id', - caCertificatePem: 'ca_certificate_pem', + caCertificatePEM: 'ca_certificate_pem', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], ); diff --git a/content/en/api/python/beta.md b/content/en/api/python/beta.md index 3aef66821..d7eed1547 100644 --- a/content/en/api/python/beta.md +++ b/content/en/api/python/beta.md @@ -4,11 +4,11 @@ ### Anthropic Beta -- `Union[str, Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]]` +- `Union[str, Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]]` - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -78,6 +78,20 @@ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Beta API Error - `class BetaAPIError: …` @@ -436,7 +450,7 @@ The Models API response can be used to determine which models are available for - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -506,6 +520,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaModelInfo: …` @@ -766,7 +794,7 @@ The Models API response can be used to determine information about a specific mo - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -836,6 +864,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaModelInfo: …` @@ -2774,7 +2816,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -2782,6 +2824,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -2790,7 +2834,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -2798,6 +2842,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `Literal["default"]` - `inference_geo: Optional[str]` @@ -4853,7 +4899,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -4923,6 +4969,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -6368,12 +6428,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -6683,12 +6745,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: int` The cumulative number of output tokens which were used. @@ -8621,7 +8685,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -8629,6 +8693,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -8637,7 +8703,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -8645,6 +8711,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice: Optional[BetaToolChoiceParam]` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -10590,7 +10658,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -10660,6 +10728,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -12448,7 +12530,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12456,6 +12538,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -12464,7 +12548,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12472,6 +12556,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `Literal["default"]` - `inference_geo: Optional[str]` @@ -14527,7 +14613,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -14597,6 +14683,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -14787,7 +14887,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -14857,6 +14957,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch: …` @@ -15041,7 +15155,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -15111,6 +15225,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch: …` @@ -15291,7 +15419,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -15361,6 +15489,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch: …` @@ -15535,7 +15677,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -15605,6 +15747,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaDeletedMessageBatch: …` @@ -15671,7 +15827,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -15741,6 +15897,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatchIndividualResponse: …` @@ -17192,12 +17362,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -18276,7 +18448,7 @@ Create Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -18346,6 +18518,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent: …` @@ -19027,7 +19213,7 @@ List Agents - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -19097,6 +19283,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent: …` @@ -19763,7 +19963,7 @@ Get Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -19833,6 +20033,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent: …` @@ -21179,7 +21393,7 @@ Update Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -21249,6 +21463,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent: …` @@ -21906,7 +22134,7 @@ Archive Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -21976,6 +22204,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent: …` @@ -22644,7 +22886,7 @@ List Agent Versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -22714,6 +22956,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent: …` @@ -23420,7 +23676,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: Optional[bool]` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Optional[List[str]]` @@ -23432,6 +23688,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Optional[List[str]]` Ubuntu/Debian packages to install @@ -23494,7 +23752,7 @@ Create a new environment with the specified configuration. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -23564,6 +23822,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment: …` @@ -23796,7 +24068,7 @@ List environments with pagination support. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -23866,6 +24138,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment: …` @@ -24088,7 +24374,7 @@ Retrieve a specific environment by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -24158,6 +24444,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment: …` @@ -24414,7 +24714,7 @@ Update an existing environment's configuration. - `allow_package_managers: Optional[bool]` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Optional[List[str]]` @@ -24426,6 +24726,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Optional[List[str]]` Ubuntu/Debian packages to install @@ -24494,7 +24796,7 @@ Update an existing environment's configuration. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -24564,6 +24866,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment: …` @@ -24782,7 +25098,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -24852,6 +25168,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironmentDeleteResponse: …` @@ -24912,7 +25242,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -24982,6 +25312,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment: …` @@ -25206,7 +25550,7 @@ Retrieve detailed information about a specific work item. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -25276,6 +25620,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -25433,7 +25791,7 @@ Long poll for work items in the queue. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -25503,6 +25861,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `anthropic_worker_id: Optional[str]` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -25653,7 +26025,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -25723,6 +26095,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -25878,7 +26264,7 @@ Record a heartbeat for a work item to maintain the lease. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -25948,6 +26334,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWorkHeartbeatResponse: …` @@ -26044,7 +26444,7 @@ Stop a work item, initiating graceful or forced shutdown. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -26114,6 +26514,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -26269,7 +26683,7 @@ List work items in an environment. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -26339,6 +26753,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -26495,7 +26923,7 @@ Update work item metadata with merge semantics. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -26565,6 +26993,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -26709,7 +27151,7 @@ Get statistics about the work queue for an environment. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -26779,6 +27221,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWorkQueueStats: …` @@ -27854,7 +28310,7 @@ Create Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -27924,6 +28380,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession: …` @@ -29076,7 +29546,7 @@ List Sessions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -29146,6 +29616,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession: …` @@ -30228,7 +30712,7 @@ Get Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -30298,6 +30782,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession: …` @@ -31813,7 +32311,7 @@ Update Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -31883,6 +32381,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession: …` @@ -32960,7 +33472,7 @@ Delete Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -33030,6 +33542,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedSession: …` @@ -33084,7 +33610,7 @@ Archive Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -33154,6 +33680,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession: …` @@ -34279,7 +34819,7 @@ List Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -34349,6 +34889,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent` @@ -36921,7 +37475,7 @@ Send Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -36991,6 +37545,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSendSessionEvents: …` @@ -37511,7 +38079,7 @@ Stream Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -37581,6 +38149,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionEvents` @@ -39846,7 +40428,7 @@ Add Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -39916,6 +40498,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsFileResource: …` @@ -40000,7 +40596,7 @@ List Session Resources - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -40070,6 +40666,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionResource` @@ -40246,7 +40856,7 @@ Get Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -40316,6 +40926,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `ResourceRetrieveResponse` @@ -40485,7 +41109,7 @@ Update Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -40555,6 +41179,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `ResourceUpdateResponse` @@ -40719,7 +41357,7 @@ Delete Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -40789,6 +41427,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeleteSessionResource: …` @@ -40856,7 +41508,7 @@ List Session Threads - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -40926,6 +41578,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread: …` @@ -40938,7 +41604,7 @@ List Session Threads - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -41704,7 +42370,7 @@ Get Session Thread - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -41774,6 +42440,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread: …` @@ -41786,7 +42466,7 @@ Get Session Thread - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -42547,7 +43227,7 @@ Archive Session Thread - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -42617,6 +43297,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread: …` @@ -42629,7 +43323,7 @@ Archive Session Thread - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -43402,7 +44096,7 @@ List Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -43472,6 +44166,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent` @@ -45682,7 +46390,7 @@ Stream Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -45752,6 +46460,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents` @@ -48402,7 +49124,7 @@ Create Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -48472,6 +49194,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment: …` @@ -49139,7 +49875,7 @@ List Deployments - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -49209,6 +49945,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment: …` @@ -49831,7 +50581,7 @@ Get Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -49901,6 +50651,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment: …` @@ -50919,7 +51683,7 @@ Update Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -50989,6 +51753,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment: …` @@ -51607,7 +52385,7 @@ Archive Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -51677,6 +52455,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment: …` @@ -52295,7 +53087,7 @@ Run Deployment Now - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -52365,6 +53157,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeploymentRun: …` @@ -52649,7 +53455,7 @@ Pause Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -52719,6 +53525,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment: …` @@ -53337,7 +54157,7 @@ Unpause Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -53407,6 +54227,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment: …` @@ -54075,7 +54909,7 @@ List Deployment Runs - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -54145,6 +54979,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeploymentRun: …` @@ -54433,7 +55281,7 @@ Get Deployment Run - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -54503,6 +55351,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeploymentRun: …` @@ -54797,7 +55659,7 @@ Create Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -54867,6 +55729,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault: …` @@ -54968,7 +55844,7 @@ List Vaults - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -55038,6 +55914,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault: …` @@ -55131,7 +56021,7 @@ Get Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -55201,6 +56091,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault: …` @@ -55300,7 +56204,7 @@ Update Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -55370,6 +56274,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault: …` @@ -55459,7 +56377,7 @@ Delete Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -55529,6 +56447,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedVault: …` @@ -55585,7 +56517,7 @@ Archive Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -55655,6 +56587,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault: …` @@ -55920,7 +56866,7 @@ Create Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -55990,6 +56936,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -56221,7 +57181,7 @@ List Credentials - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -56291,6 +57251,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -56511,7 +57485,7 @@ Get Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -56581,6 +57555,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -56928,7 +57916,7 @@ Update Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -56998,6 +57986,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -57213,7 +58215,7 @@ Delete Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -57283,6 +58285,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedCredential: …` @@ -57342,7 +58358,7 @@ Archive Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -57412,6 +58428,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -57627,7 +58657,7 @@ Validate Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -57697,6 +58727,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredentialValidation: …` @@ -57868,7 +58912,7 @@ Create a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -57938,6 +58982,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -58056,7 +59114,7 @@ List memory stores - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -58126,6 +59184,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -58224,7 +59296,7 @@ Retrieve a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -58294,6 +59366,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -58404,7 +59490,7 @@ Update a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -58474,6 +59560,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -58568,7 +59668,7 @@ Delete a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -58638,6 +59738,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedMemoryStore: …` @@ -58694,7 +59808,7 @@ Archive a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -58764,6 +59878,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -58878,7 +60006,7 @@ Create a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -58948,6 +60076,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory: …` @@ -58980,7 +60122,7 @@ Create a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -59080,7 +60222,7 @@ List memories - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -59150,6 +60292,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryListItem` @@ -59186,7 +60342,7 @@ List memories - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -59282,7 +60438,7 @@ Retrieve a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -59352,6 +60508,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory: …` @@ -59384,7 +60554,7 @@ Retrieve a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -59485,7 +60655,7 @@ Update a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -59555,6 +60725,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory: …` @@ -59587,7 +60771,7 @@ Update a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -59664,7 +60848,7 @@ Delete a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -59734,11 +60918,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedMemory: …` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: str` @@ -59849,7 +61047,7 @@ List memory versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -59919,11 +61117,25 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -59937,7 +61149,7 @@ List memory versions - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` @@ -60112,7 +61324,7 @@ Retrieve a memory version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -60182,11 +61394,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -60200,7 +61426,7 @@ Retrieve a memory version - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` @@ -60362,7 +61588,7 @@ Redact a memory version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -60432,11 +61658,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -60450,7 +61690,7 @@ Redact a memory version - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` @@ -60616,7 +61856,7 @@ Upload File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -60686,6 +61926,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaFileMetadata: …` @@ -60815,7 +62069,7 @@ List Files - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -60885,6 +62139,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaFileMetadata: …` @@ -61004,7 +62272,7 @@ Download File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -61074,6 +62342,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BinaryResponseContent` @@ -61117,7 +62399,7 @@ Get File Metadata - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -61187,6 +62469,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaFileMetadata: …` @@ -61300,7 +62596,7 @@ Delete File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -61370,6 +62666,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaDeletedFile: …` @@ -61442,7 +62752,7 @@ Create Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -61512,6 +62822,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class SkillCreateResponse: …` @@ -61629,7 +62953,7 @@ List Skills - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -61699,6 +63023,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class SkillListResponse: …` @@ -61804,7 +63142,7 @@ Get Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -61874,6 +63212,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class SkillRetrieveResponse: …` @@ -61974,7 +63326,7 @@ Delete Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -62044,6 +63396,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class SkillDeleteResponse: …` @@ -62118,7 +63484,7 @@ Create Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -62188,6 +63554,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class VersionCreateResponse: …` @@ -62303,7 +63683,7 @@ List Skill Versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -62373,6 +63753,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class VersionListResponse: …` @@ -62490,7 +63884,7 @@ Download a skill version's content as a zip archive. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -62560,6 +63954,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BinaryResponseContent` @@ -62612,7 +64020,7 @@ Get Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -62682,6 +64090,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class VersionRetrieveResponse: …` @@ -62793,7 +64215,7 @@ Delete Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -62863,6 +64285,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class VersionDeleteResponse: …` @@ -62980,7 +64416,7 @@ Create User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -63050,6 +64486,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfile: …` @@ -63188,7 +64638,7 @@ List User Profiles - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -63258,6 +64708,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfile: …` @@ -63386,7 +64850,7 @@ Get User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -63456,6 +64920,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfile: …` @@ -63614,7 +65092,7 @@ Update User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -63684,6 +65162,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfile: …` @@ -63808,7 +65300,7 @@ Create Enrollment URL - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -63878,6 +65370,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfileEnrollmentURL: …` @@ -64009,7 +65515,7 @@ Create a Dream - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -64079,6 +65585,20 @@ Create a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream: …` @@ -64348,7 +65868,7 @@ List Dreams - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -64418,6 +65938,20 @@ List Dreams - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream: …` @@ -64647,7 +66181,7 @@ Get a Dream - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -64717,6 +66251,20 @@ Get a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream: …` @@ -64942,7 +66490,7 @@ Cancel a Dream - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -65012,6 +66560,20 @@ Cancel a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream: …` @@ -65237,7 +66799,7 @@ Archive a Dream - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -65307,6 +66869,20 @@ Archive a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream: …` @@ -65540,7 +67116,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -65610,6 +67186,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnel: …` @@ -65690,7 +67280,7 @@ Fetches a tunnel by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -65760,6 +67350,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnel: …` @@ -65854,7 +67458,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -65924,6 +67528,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnel: …` @@ -66010,7 +67628,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -66080,6 +67698,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnel: …` @@ -66162,7 +67794,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -66232,6 +67864,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelToken: …` @@ -66301,7 +67947,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -66371,6 +68017,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelToken: …` @@ -66442,7 +68102,10447 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelCertificate: …` + + A CA certificate attached to a tunnel. + + - `id: str` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: Optional[datetime]` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: datetime` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: Optional[datetime]` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: str` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: str` + + ID of the tunnel the certificate is registered against. + + - `type: Literal["tunnel_certificate"]` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_tunnel_certificate = client.beta.tunnels.certificates.create( + tunnel_id="tunnel_id", + ca_certificate_pem="ca_certificate_pem", +) +print(beta_tunnel_certificate.id) +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### Get Tunnel Certificate + +`beta.tunnels.certificates.retrieve(certificate_id, **kwargs) -> BetaTunnelCertificate` + +**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Fetches a tunnel certificate by ID. + +#### Parameters + +- `tunnel_id: str` + +- `certificate_id: str` + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelCertificate: …` + + A CA certificate attached to a tunnel. + + - `id: str` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: Optional[datetime]` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: datetime` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: Optional[datetime]` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: str` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: str` + + ID of the tunnel the certificate is registered against. + + - `type: Literal["tunnel_certificate"]` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_tunnel_certificate = client.beta.tunnels.certificates.retrieve( + certificate_id="certificate_id", + tunnel_id="tunnel_id", +) +print(beta_tunnel_certificate.id) +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### List Tunnel Certificates + +`beta.tunnels.certificates.list(tunnel_id, **kwargs) -> SyncPageCursor[BetaTunnelCertificate]` + +**GET** `/v1/tunnels/{tunnel_id}/certificates` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. + +#### Parameters + +- `tunnel_id: str` + +- `include_archived: Optional[bool]` + + Whether to include archived certificates in the results. Defaults to false. + +- `limit: Optional[int]` + + Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + + format: int32 + +- `page: Optional[str]` + + Opaque pagination cursor from a previous `list_tunnel_certificates` response. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelCertificate: …` + + A CA certificate attached to a tunnel. + + - `id: str` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: Optional[datetime]` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: datetime` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: Optional[datetime]` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: str` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: str` + + ID of the tunnel the certificate is registered against. + + - `type: Literal["tunnel_certificate"]` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.tunnels.certificates.list( + tunnel_id="tunnel_id", +) +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" + } + ], + "next_page": "next_page" +} +``` + +### Archive Tunnel Certificate + +`beta.tunnels.certificates.archive(certificate_id, **kwargs) -> BetaTunnelCertificate` + +**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. + +#### Parameters + +- `tunnel_id: str` + +- `certificate_id: str` + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelCertificate: …` + + A CA certificate attached to a tunnel. + + - `id: str` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: Optional[datetime]` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: datetime` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: Optional[datetime]` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: str` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: str` + + ID of the tunnel the certificate is registered against. + + - `type: Literal["tunnel_certificate"]` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_tunnel_certificate = client.beta.tunnels.certificates.archive( + certificate_id="certificate_id", + tunnel_id="tunnel_id", +) +print(beta_tunnel_certificate.id) +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +## Beta › Organization + +### Get Current Organization + +`beta.organization.retrieve() -> BetaOrganization` + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Returns + +- `class BetaOrganization: …` + + - `id: str` + + ID of the Organization. + + format: uuid + + - `name: str` + + Name of the Organization. + + - `type: Literal["organization"]` + + Object type. + + For Organizations, this is always `"organization"`. + + default: organization + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_organization = client.beta.organization.retrieve() +print(beta_organization.id) +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +`beta.organization.api_keys.list(**kwargs) -> SyncPage[BetaAPIKey]` + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Parameters + +- `after_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `created_by_user_id: Optional[str]` + + Filter by the ID of the User who created the object. + +- `limit: Optional[int]` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `status: Optional[Literal["active", "archived", "expired", "inactive"]]` + + Filter by API key status. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + +- `workspace_id: Optional[str]` + + Filter by Workspace ID. + +#### Returns + +- `class BetaAPIKey: …` + + - `id: str` + + ID of the API key. + + - `created_at: datetime` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: Optional[BetaAPIKeyCreatedBy]` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: str` + + ID of the actor that created the object. + + - `type: Literal["service_account", "user"]` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: str` + + Name of the API key. + + - `partial_key_hint: Optional[str]` + + Partially redacted hint for the API key. + + - `principal: Optional[Principal]` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaAPIKeyUserActor: …` + + - `type: Literal["user_actor"]` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: str` + + ID of the User the API key acts as. + + - `class BetaAPIKeyServiceAccountActor: …` + + - `service_account_id: str` + + ID of the Service Account the API key acts as. + + - `type: Literal["service_account_actor"]` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: Scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaAPIKeyOrganizationScope: …` + + - `type: Literal["organization"]` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `class BetaAPIKeyWorkspaceScope: …` + + - `type: Literal["workspace"]` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: str` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: Literal["active", "archived", "expired", "inactive"]` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: Literal["api_key"]` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: Optional[str]` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.api_keys.list() +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +`beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey` + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Parameters + +- `api_key_id: str` + + ID of the API key. + +#### Returns + +- `class BetaAPIKey: …` + + - `id: str` + + ID of the API key. + + - `created_at: datetime` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: Optional[BetaAPIKeyCreatedBy]` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: str` + + ID of the actor that created the object. + + - `type: Literal["service_account", "user"]` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: str` + + Name of the API key. + + - `partial_key_hint: Optional[str]` + + Partially redacted hint for the API key. + + - `principal: Optional[Principal]` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaAPIKeyUserActor: …` + + - `type: Literal["user_actor"]` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: str` + + ID of the User the API key acts as. + + - `class BetaAPIKeyServiceAccountActor: …` + + - `service_account_id: str` + + ID of the Service Account the API key acts as. + + - `type: Literal["service_account_actor"]` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: Scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaAPIKeyOrganizationScope: …` + + - `type: Literal["organization"]` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `class BetaAPIKeyWorkspaceScope: …` + + - `type: Literal["workspace"]` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: str` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: Literal["active", "archived", "expired", "inactive"]` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: Literal["api_key"]` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: Optional[str]` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_api_key = client.beta.organization.api_keys.retrieve( + "api_key_id", +) +print(beta_api_key.id) +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +`beta.organization.api_keys.update(api_key_id, **kwargs) -> BetaAPIKey` + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Parameters + +- `api_key_id: str` + + ID of the API key. + +- `name: Optional[str]` + + Name of the API key. + + maxLength: 500, minLength: 1 + +- `status: Optional[Literal["active", "archived", "inactive"]]` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"inactive"` + +#### Returns + +- `class BetaAPIKey: …` + + - `id: str` + + ID of the API key. + + - `created_at: datetime` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: Optional[BetaAPIKeyCreatedBy]` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: str` + + ID of the actor that created the object. + + - `type: Literal["service_account", "user"]` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: str` + + Name of the API key. + + - `partial_key_hint: Optional[str]` + + Partially redacted hint for the API key. + + - `principal: Optional[Principal]` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaAPIKeyUserActor: …` + + - `type: Literal["user_actor"]` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: str` + + ID of the User the API key acts as. + + - `class BetaAPIKeyServiceAccountActor: …` + + - `service_account_id: str` + + ID of the Service Account the API key acts as. + + - `type: Literal["service_account_actor"]` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: Scope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaAPIKeyOrganizationScope: …` + + - `type: Literal["organization"]` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `class BetaAPIKeyWorkspaceScope: …` + + - `type: Literal["workspace"]` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: str` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: Literal["active", "archived", "expired", "inactive"]` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: Literal["api_key"]` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: Optional[str]` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_api_key = client.beta.organization.api_keys.update( + api_key_id="api_key_id", +) +print(beta_api_key.id) +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +`beta.organization.external_keys.create(**kwargs) -> BetaExternalKey` + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Parameters + +- `provider_config: ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig: …` + + - `kms_arn: str` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: Literal["aws"]` + + - `region: Optional[str]` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: Optional[str]` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig: …` + + - `key_name: str` + + Full resource name of the Cloud KMS key. + + - `type: Literal["gcp"]` + + - `class BetaAzureExternalKeyConfigParam: …` + + Azure Key Vault provider configuration. + + - `key_name: str` + + Name of the key within the vault. + + - `tenant_id: str` + + Azure AD tenant ID. + + - `type: Literal["azure"]` + + - `vault_uri: str` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: Optional[str]` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +- `display_name: Optional[str]` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: Optional[Literal["us"]]` + + Data residency geo. Only `us` is supported. + +#### Returns + +- `class BetaExternalKey: …` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: str` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: Attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment: …` + + - `type: Literal["attached"]` + + default: attached + + - `class BetaExternalKeyUnattachedAttachment: …` + + - `type: Literal["unattached"]` + + default: unattached + + - `created_at: datetime` + + format: date-time + + - `display_name: Optional[str]` + + Human-friendly display name. Null if none was set. + + - `geo: str` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig: …` + + - `kms_arn: str` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: Literal["aws"]` + + - `region: Optional[str]` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: Optional[str]` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig: …` + + - `key_name: str` + + Full resource name of the Cloud KMS key. + + - `type: Literal["gcp"]` + + - `class BetaAzureExternalKeyConfig: …` + + - `key_name: str` + + Name of the key within the vault. + + - `tenant_id: str` + + Azure AD tenant ID. + + - `type: Literal["azure"]` + + - `vault_uri: str` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: Optional[str]` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: Literal["external_key"]` + + default: external_key + + - `updated_at: datetime` + + format: date-time + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_external_key = client.beta.organization.external_keys.create( + provider_config={ + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + }, +) +print(beta_external_key.id) +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +`beta.organization.external_keys.list(**kwargs) -> SyncPageCursor[BetaExternalKey]` + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Parameters + +- `limit: Optional[int]` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaExternalKey: …` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: str` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: Attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment: …` + + - `type: Literal["attached"]` + + default: attached + + - `class BetaExternalKeyUnattachedAttachment: …` + + - `type: Literal["unattached"]` + + default: unattached + + - `created_at: datetime` + + format: date-time + + - `display_name: Optional[str]` + + Human-friendly display name. Null if none was set. + + - `geo: str` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig: …` + + - `kms_arn: str` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: Literal["aws"]` + + - `region: Optional[str]` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: Optional[str]` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig: …` + + - `key_name: str` + + Full resource name of the Cloud KMS key. + + - `type: Literal["gcp"]` + + - `class BetaAzureExternalKeyConfig: …` + + - `key_name: str` + + Name of the key within the vault. + + - `tenant_id: str` + + Azure AD tenant ID. + + - `type: Literal["azure"]` + + - `vault_uri: str` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: Optional[str]` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: Literal["external_key"]` + + default: external_key + + - `updated_at: datetime` + + format: date-time + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.external_keys.list() +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +`beta.organization.external_keys.retrieve(external_key_id) -> BetaExternalKey` + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Parameters + +- `external_key_id: str` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class BetaExternalKey: …` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: str` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: Attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment: …` + + - `type: Literal["attached"]` + + default: attached + + - `class BetaExternalKeyUnattachedAttachment: …` + + - `type: Literal["unattached"]` + + default: unattached + + - `created_at: datetime` + + format: date-time + + - `display_name: Optional[str]` + + Human-friendly display name. Null if none was set. + + - `geo: str` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig: …` + + - `kms_arn: str` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: Literal["aws"]` + + - `region: Optional[str]` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: Optional[str]` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig: …` + + - `key_name: str` + + Full resource name of the Cloud KMS key. + + - `type: Literal["gcp"]` + + - `class BetaAzureExternalKeyConfig: …` + + - `key_name: str` + + Name of the key within the vault. + + - `tenant_id: str` + + Azure AD tenant ID. + + - `type: Literal["azure"]` + + - `vault_uri: str` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: Optional[str]` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: Literal["external_key"]` + + default: external_key + + - `updated_at: datetime` + + format: date-time + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_external_key = client.beta.organization.external_keys.retrieve( + "external_key_id", +) +print(beta_external_key.id) +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +`beta.organization.external_keys.update(external_key_id, **kwargs) -> BetaExternalKey` + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Parameters + +- `external_key_id: str` + + ID of the External Key. + + maxLength: 2048 + +- `display_name: Optional[str]` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: Optional[Literal["us"]]` + + Data residency geo. Only `us` is supported. + +- `provider_config: Optional[ProviderConfig]` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig: …` + + - `kms_arn: str` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: Literal["aws"]` + + - `region: Optional[str]` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: Optional[str]` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig: …` + + - `key_name: str` + + Full resource name of the Cloud KMS key. + + - `type: Literal["gcp"]` + + - `class BetaAzureExternalKeyConfigParam: …` + + Azure Key Vault provider configuration. + + - `key_name: str` + + Name of the key within the vault. + + - `tenant_id: str` + + Azure AD tenant ID. + + - `type: Literal["azure"]` + + - `vault_uri: str` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: Optional[str]` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +#### Returns + +- `class BetaExternalKey: …` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: str` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: Attachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment: …` + + - `type: Literal["attached"]` + + default: attached + + - `class BetaExternalKeyUnattachedAttachment: …` + + - `type: Literal["unattached"]` + + default: unattached + + - `created_at: datetime` + + format: date-time + + - `display_name: Optional[str]` + + Human-friendly display name. Null if none was set. + + - `geo: str` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: ProviderConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig: …` + + - `kms_arn: str` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: Literal["aws"]` + + - `region: Optional[str]` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: Optional[str]` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig: …` + + - `key_name: str` + + Full resource name of the Cloud KMS key. + + - `type: Literal["gcp"]` + + - `class BetaAzureExternalKeyConfig: …` + + - `key_name: str` + + Name of the key within the vault. + + - `tenant_id: str` + + Azure AD tenant ID. + + - `type: Literal["azure"]` + + - `vault_uri: str` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: Optional[str]` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: Literal["external_key"]` + + default: external_key + + - `updated_at: datetime` + + format: date-time + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_external_key = client.beta.organization.external_keys.update( + external_key_id="external_key_id", +) +print(beta_external_key.id) +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +`beta.organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse` + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Parameters + +- `external_key_id: str` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class ExternalKeyDeleteResponse: …` + + - `id: str` + + ID of the deleted External Key. + + - `type: Literal["external_key_deleted"]` + + default: external_key_deleted + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +external_key = client.beta.organization.external_keys.delete( + "external_key_id", +) +print(external_key.id) +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +`beta.organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse` + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Parameters + +- `external_key_id: str` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class ExternalKeyValidateResponse: …` + + Result of a validation roundtrip against the customer's KMS. + + HTTP 200 for both outcomes — the operation completed; `status` says + whether the key works. + + - `error: Optional[str]` + + Error message when status is `failure`. Null otherwise. + + - `status: Literal["failure", "success"]` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"failure"` + + - `"success"` + + - `type: Literal["external_key_validation"]` + + default: external_key_validation + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +response = client.beta.organization.external_keys.validate( + "external_key_id", +) +print(response.error) +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +`beta.organization.federation.issuers.create(**kwargs) -> BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Parameters + +- `issuer_url: str` + + The `iss` claim value to match against. + + minLength: 1 + +- `name: str` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `check_jti: Optional[bool]` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `jwks: Optional[JWKS]` + + How signing keys are obtained. Defaults to OIDC discovery. + + - `class BetaJWKSDiscovery: …` + + JWKS via the issuer's OIDC discovery document. + + - `type: Literal["discovery"]` + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: Optional[str]` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL: …` + + JWKS fetched from a fixed endpoint. + + - `type: Literal["explicit_url"]` + + - `url: str` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline: …` + + JWKS supplied directly; no network fetch. + + - `keys: List[Dict[str, object]]` + + Inline JWK objects. + + minItems: 1 + + - `type: Literal["inline"]` + +- `max_jwt_lifetime_seconds: Optional[int]` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer: …` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: str` + + Tagged ID of the federation issuer. + + - `archived_at: Optional[datetime]` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: datetime` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: str` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: JWKS` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery: …` + + JWKS via the issuer's OIDC discovery document. + + - `type: Literal["discovery"]` + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: Optional[str]` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL: …` + + JWKS fetched from a fixed endpoint. + + - `type: Literal["explicit_url"]` + + - `url: str` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline: …` + + JWKS supplied directly; no network fetch. + + - `keys: List[Dict[str, object]]` + + Inline JWK objects. + + minItems: 1 + + - `type: Literal["inline"]` + + - `jwks_polling_disabled_at: Optional[datetime]` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: int` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: str` + + Admin-chosen slug identifier. + + - `poll_status: Optional[BetaFederationIssuerPollStatus]` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: int` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Optional[datetime]` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Optional[datetime]` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: Literal["federation_issuer"]` + + default: federation_issuer + + - `updated_at: datetime` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_issuer = client.beta.organization.federation.issuers.create( + issuer_url="x", + name="x", +) +print(beta_federation_issuer.id) +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +`beta.organization.federation.issuers.list(**kwargs) -> SyncPageCursor[BetaFederationIssuer]` + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Parameters + +- `include_archived: Optional[bool]` + + Include archived resources. Defaults to false. + + default: false + +- `limit: Optional[int]` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer: …` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: str` + + Tagged ID of the federation issuer. + + - `archived_at: Optional[datetime]` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: datetime` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: str` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: JWKS` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery: …` + + JWKS via the issuer's OIDC discovery document. + + - `type: Literal["discovery"]` + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: Optional[str]` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL: …` + + JWKS fetched from a fixed endpoint. + + - `type: Literal["explicit_url"]` + + - `url: str` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline: …` + + JWKS supplied directly; no network fetch. + + - `keys: List[Dict[str, object]]` + + Inline JWK objects. + + minItems: 1 + + - `type: Literal["inline"]` + + - `jwks_polling_disabled_at: Optional[datetime]` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: int` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: str` + + Admin-chosen slug identifier. + + - `poll_status: Optional[BetaFederationIssuerPollStatus]` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: int` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Optional[datetime]` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Optional[datetime]` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: Literal["federation_issuer"]` + + default: federation_issuer + + - `updated_at: datetime` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.federation.issuers.list() +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +`beta.organization.federation.issuers.retrieve(federation_issuer_id, **kwargs) -> BetaFederationIssuer` + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Parameters + +- `federation_issuer_id: str` + + ID of the federation issuer. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer: …` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: str` + + Tagged ID of the federation issuer. + + - `archived_at: Optional[datetime]` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: datetime` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: str` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: JWKS` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery: …` + + JWKS via the issuer's OIDC discovery document. + + - `type: Literal["discovery"]` + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: Optional[str]` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL: …` + + JWKS fetched from a fixed endpoint. + + - `type: Literal["explicit_url"]` + + - `url: str` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline: …` + + JWKS supplied directly; no network fetch. + + - `keys: List[Dict[str, object]]` + + Inline JWK objects. + + minItems: 1 + + - `type: Literal["inline"]` + + - `jwks_polling_disabled_at: Optional[datetime]` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: int` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: str` + + Admin-chosen slug identifier. + + - `poll_status: Optional[BetaFederationIssuerPollStatus]` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: int` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Optional[datetime]` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Optional[datetime]` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: Literal["federation_issuer"]` + + default: federation_issuer + + - `updated_at: datetime` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_issuer = client.beta.organization.federation.issuers.retrieve( + federation_issuer_id="federation_issuer_id", +) +print(beta_federation_issuer.id) +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +`beta.organization.federation.issuers.update(federation_issuer_id, **kwargs) -> BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Parameters + +- `federation_issuer_id: str` + + ID of the federation issuer to update. + +- `check_jti: Optional[bool]` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `issuer_url: Optional[str]` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + +- `jwks: Optional[JWKS]` + + Replaces the entire JWKS configuration. + + - `class BetaJWKSDiscovery: …` + + JWKS via the issuer's OIDC discovery document. + + - `type: Literal["discovery"]` + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: Optional[str]` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL: …` + + JWKS fetched from a fixed endpoint. + + - `type: Literal["explicit_url"]` + + - `url: str` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline: …` + + JWKS supplied directly; no network fetch. + + - `keys: List[Dict[str, object]]` + + Inline JWK objects. + + minItems: 1 + + - `type: Literal["inline"]` + +- `jwks_polling_disabled: Optional[bool]` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `max_jwt_lifetime_seconds: Optional[int]` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `name: Optional[str]` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer: …` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: str` + + Tagged ID of the federation issuer. + + - `archived_at: Optional[datetime]` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: datetime` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: str` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: JWKS` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery: …` + + JWKS via the issuer's OIDC discovery document. + + - `type: Literal["discovery"]` + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: Optional[str]` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL: …` + + JWKS fetched from a fixed endpoint. + + - `type: Literal["explicit_url"]` + + - `url: str` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline: …` + + JWKS supplied directly; no network fetch. + + - `keys: List[Dict[str, object]]` + + Inline JWK objects. + + minItems: 1 + + - `type: Literal["inline"]` + + - `jwks_polling_disabled_at: Optional[datetime]` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: int` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: str` + + Admin-chosen slug identifier. + + - `poll_status: Optional[BetaFederationIssuerPollStatus]` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: int` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Optional[datetime]` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Optional[datetime]` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: Literal["federation_issuer"]` + + default: federation_issuer + + - `updated_at: datetime` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_issuer = client.beta.organization.federation.issuers.update( + federation_issuer_id="federation_issuer_id", +) +print(beta_federation_issuer.id) +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +`beta.organization.federation.issuers.archive(federation_issuer_id, **kwargs) -> BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Parameters + +- `federation_issuer_id: str` + + ID of the federation issuer to archive. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer: …` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: str` + + Tagged ID of the federation issuer. + + - `archived_at: Optional[datetime]` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: datetime` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: str` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: JWKS` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery: …` + + JWKS via the issuer's OIDC discovery document. + + - `type: Literal["discovery"]` + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: Optional[str]` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL: …` + + JWKS fetched from a fixed endpoint. + + - `type: Literal["explicit_url"]` + + - `url: str` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: Optional[str]` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline: …` + + JWKS supplied directly; no network fetch. + + - `keys: List[Dict[str, object]]` + + Inline JWK objects. + + minItems: 1 + + - `type: Literal["inline"]` + + - `jwks_polling_disabled_at: Optional[datetime]` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: int` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: str` + + Admin-chosen slug identifier. + + - `poll_status: Optional[BetaFederationIssuerPollStatus]` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: int` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Optional[datetime]` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Optional[datetime]` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: Literal["federation_issuer"]` + + default: federation_issuer + + - `updated_at: datetime` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_issuer = client.beta.organization.federation.issuers.archive( + federation_issuer_id="federation_issuer_id", +) +print(beta_federation_issuer.id) +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +`beta.organization.federation.rules.create(**kwargs) -> BetaFederationRule` + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Parameters + +- `issuer_id: str` + + Tagged ID of the federation issuer. + +- `match: BetaFederationRuleMatchParam` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `audience: Optional[str]` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Optional[Dict[str, str]]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: Optional[str]` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: Optional[str]` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: str` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: str` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: BetaServiceAccountTargetParam` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: str` + + Tagged ID of the service account to mint tokens for. + + - `type: Literal["service_account"]` + + - `service_account_name: Optional[str]` + + Service account's display name at read time. Ignored on writes. + +- `applies_to_all_workspaces: Optional[bool]` + + When true, enable this rule for every workspace in the org (including workspaces created later). + +- `attributes: Optional[Dict[str, str]]` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `description: Optional[str]` + + Optional free-text description. + + maxLength: 2000 + +- `token_lifetime_seconds: Optional[int]` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: Optional[str]` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule: …` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: str` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Optional[datetime]` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Optional[Dict[str, str]]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: datetime` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: Optional[str]` + + Optional free-text description. + + - `issuer_id: str` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: Optional[str]` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: Optional[str]` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Optional[Dict[str, str]]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: Optional[str]` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: Optional[str]` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: str` + + Admin-chosen slug identifier. + + - `oauth_scope: str` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: str` + + Tagged ID of the service account to mint tokens for. + + - `type: Literal["service_account"]` + + - `service_account_name: Optional[str]` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: int` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: Literal["federation_rule"]` + + default: federation_rule + + - `updated_at: datetime` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: Optional[str]` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: List[str]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_rule = client.beta.organization.federation.rules.create( + issuer_id="issuer_id", + match={}, + name="x", + oauth_scope="x", + target={ + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + }, +) +print(beta_federation_rule.id) +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +`beta.organization.federation.rules.list(**kwargs) -> SyncPageCursor[BetaFederationRule]` + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Parameters + +- `include_archived: Optional[bool]` + + Include archived resources. Defaults to false. + + default: false + +- `issuer_id: Optional[str]` + + Filter to rules referencing this federation issuer. + +- `limit: Optional[int]` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule: …` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: str` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Optional[datetime]` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Optional[Dict[str, str]]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: datetime` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: Optional[str]` + + Optional free-text description. + + - `issuer_id: str` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: Optional[str]` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: Optional[str]` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Optional[Dict[str, str]]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: Optional[str]` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: Optional[str]` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: str` + + Admin-chosen slug identifier. + + - `oauth_scope: str` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: str` + + Tagged ID of the service account to mint tokens for. + + - `type: Literal["service_account"]` + + - `service_account_name: Optional[str]` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: int` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: Literal["federation_rule"]` + + default: federation_rule + + - `updated_at: datetime` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: Optional[str]` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: List[str]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.federation.rules.list() +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +`beta.organization.federation.rules.retrieve(federation_rule_id, **kwargs) -> BetaFederationRule` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Parameters + +- `federation_rule_id: str` + + ID of the federation rule. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule: …` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: str` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Optional[datetime]` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Optional[Dict[str, str]]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: datetime` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: Optional[str]` + + Optional free-text description. + + - `issuer_id: str` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: Optional[str]` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: Optional[str]` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Optional[Dict[str, str]]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: Optional[str]` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: Optional[str]` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: str` + + Admin-chosen slug identifier. + + - `oauth_scope: str` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: str` + + Tagged ID of the service account to mint tokens for. + + - `type: Literal["service_account"]` + + - `service_account_name: Optional[str]` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: int` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: Literal["federation_rule"]` + + default: federation_rule + + - `updated_at: datetime` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: Optional[str]` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: List[str]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_rule = client.beta.organization.federation.rules.retrieve( + federation_rule_id="federation_rule_id", +) +print(beta_federation_rule.id) +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +`beta.organization.federation.rules.update(federation_rule_id, **kwargs) -> BetaFederationRule` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `federation_rule_id: str` + + ID of the federation rule to update. + +- `applies_to_all_workspaces: Optional[bool]` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `attributes: Optional[Dict[str, str]]` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `description: Optional[str]` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `match: Optional[BetaFederationRuleMatchParam]` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience: Optional[str]` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Optional[Dict[str, str]]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: Optional[str]` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: Optional[str]` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: Optional[str]` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: Optional[str]` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: Optional[BetaServiceAccountTargetParam]` + + Bind to a fixed service account by ID. + + - `service_account_id: str` + + Tagged ID of the service account to mint tokens for. + + - `type: Literal["service_account"]` + + - `service_account_name: Optional[str]` + + Service account's display name at read time. Ignored on writes. + +- `token_lifetime_seconds: Optional[int]` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: Optional[str]` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule: …` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: str` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Optional[datetime]` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Optional[Dict[str, str]]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: datetime` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: Optional[str]` + + Optional free-text description. + + - `issuer_id: str` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: Optional[str]` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: Optional[str]` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Optional[Dict[str, str]]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: Optional[str]` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: Optional[str]` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: str` + + Admin-chosen slug identifier. + + - `oauth_scope: str` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: str` + + Tagged ID of the service account to mint tokens for. + + - `type: Literal["service_account"]` + + - `service_account_name: Optional[str]` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: int` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: Literal["federation_rule"]` + + default: federation_rule + + - `updated_at: datetime` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: Optional[str]` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: List[str]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_rule = client.beta.organization.federation.rules.update( + federation_rule_id="federation_rule_id", +) +print(beta_federation_rule.id) +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +`beta.organization.federation.rules.archive(federation_rule_id, **kwargs) -> BetaFederationRule` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federation_rule_id: str` + + ID of the federation rule to archive. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule: …` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: str` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Optional[datetime]` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Optional[Dict[str, str]]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: datetime` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: Optional[str]` + + Optional free-text description. + + - `issuer_id: str` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: Optional[str]` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: Optional[str]` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Optional[Dict[str, str]]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: Optional[str]` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: Optional[str]` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: str` + + Admin-chosen slug identifier. + + - `oauth_scope: str` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: str` + + Tagged ID of the service account to mint tokens for. + + - `type: Literal["service_account"]` + + - `service_account_name: Optional[str]` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: int` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: Literal["federation_rule"]` + + default: federation_rule + + - `updated_at: datetime` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: Optional[str]` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: List[str]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_rule = client.beta.organization.federation.rules.archive( + federation_rule_id="federation_rule_id", +) +print(beta_federation_rule.id) +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +`beta.organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> BetaFederationRuleWorkspace` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federation_rule_id: str` + + ID of the federation rule. + +- `workspace_id: str` + + Tagged ID of the workspace to enable this rule for. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRuleWorkspace: …` + + - `created_at: datetime` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: str` + + Tagged ID of the federation rule. + + - `type: Literal["federation_rule_workspace"]` + + default: federation_rule_workspace + + - `workspace_id: str` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: Optional[str]` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_federation_rule_workspace = ( + client.beta.organization.federation.rules.workspaces.add( + federation_rule_id="federation_rule_id", + workspace_id="workspace_id", + ) +) +print(beta_federation_rule_workspace.created_by_actor_id) +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +`beta.organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> SyncPageCursor[BetaFederationRuleWorkspace]` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Parameters + +- `federation_rule_id: str` + + ID of the federation rule. + +- `limit: Optional[int]` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRuleWorkspace: …` + + - `created_at: datetime` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: str` + + Tagged ID of the federation rule. + + - `type: Literal["federation_rule_workspace"]` + + default: federation_rule_workspace + + - `workspace_id: str` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: Optional[str]` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.federation.rules.workspaces.list( + federation_rule_id="federation_rule_id", +) +page = page.data[0] +print(page.created_by_actor_id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +`beta.organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse` + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `federation_rule_id: str` + + ID of the federation rule. + +- `workspace_id: str` + + ID of the workspace to disable for. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class WorkspaceRemoveResponse: …` + + - `federation_rule_id: str` + + Tagged ID of the federation rule. + + - `type: Literal["federation_rule_workspace_deleted"]` + + default: federation_rule_workspace_deleted + + - `workspace_id: str` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +workspace = client.beta.organization.federation.rules.workspaces.remove( + workspace_id="workspace_id", + federation_rule_id="federation_rule_id", +) +print(workspace.federation_rule_id) +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +`beta.organization.invites.create(**kwargs) -> BetaOrganizationInvite` + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Parameters + +- `email: str` + + Email of the User. + + format: email + +- `role: Literal["billing", "claude_code_user", "developer", 2 more]` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +- `rbac_group_ids: Optional[Sequence[str]]` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `class BetaOrganizationInvite: …` + + - `id: str` + + ID of the Invite. + + - `accepted_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: str` + + Email of the User being invited. + + - `expires_at: datetime` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: datetime` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: List[str]` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: Literal["accepted", "deleted", "expired", "pending"]` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: Literal["invite"]` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_organization_invite = client.beta.organization.invites.create( + email="user@emaildomain.com", + role="user", +) +print(beta_organization_invite.id) +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +`beta.organization.invites.list(**kwargs) -> SyncPage[BetaOrganizationInvite]` + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Parameters + +- `after_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: Optional[str]` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + +- `limit: Optional[int]` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: Optional[Sequence[str]]` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +- `statuses: Optional[List[Literal["accepted", "expired", "pending"]]]` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `"accepted"` + + - `"expired"` + + - `"pending"` + +#### Returns + +- `class BetaOrganizationInvite: …` + + - `id: str` + + ID of the Invite. + + - `accepted_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: str` + + Email of the User being invited. + + - `expires_at: datetime` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: datetime` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: List[str]` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: Literal["accepted", "deleted", "expired", "pending"]` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: Literal["invite"]` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.invites.list() +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +`beta.organization.invites.retrieve(invite_id) -> BetaOrganizationInvite` + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Parameters + +- `invite_id: str` + + ID of the Invite. + +#### Returns + +- `class BetaOrganizationInvite: …` + + - `id: str` + + ID of the Invite. + + - `accepted_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: str` + + Email of the User being invited. + + - `expires_at: datetime` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: datetime` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: List[str]` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: Literal["accepted", "deleted", "expired", "pending"]` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: Literal["invite"]` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_organization_invite = client.beta.organization.invites.retrieve( + "invite_id", +) +print(beta_organization_invite.id) +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +`beta.organization.invites.delete(invite_id) -> InviteDeleteResponse` + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Parameters + +- `invite_id: str` + + ID of the Invite. + +#### Returns + +- `class InviteDeleteResponse: …` + + - `id: str` + + ID of the Invite. + + - `type: Literal["invite_deleted"]` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + + default: invite_deleted + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +invite = client.beta.organization.invites.delete( + "invite_id", +) +print(invite.id) +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +`beta.organization.service_accounts.create(**kwargs) -> BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Parameters + +- `name: str` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `description: Optional[str]` + + Optional free-text description. + + maxLength: 2000 + +- `organization_role: Optional[Literal["admin", "developer"]]` + + Org-level role. Defaults to `developer`. + + - `"admin"` + + - `"developer"` + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount: …` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: str` + + Tagged ID of the service account. + + - `archived_at: Optional[datetime]` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: datetime` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: Optional[str]` + + Optional free-text description. + + - `name: str` + + Admin-chosen slug identifier. + + - `organization_role: Literal["admin", "developer"]` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: Literal["service_account"]` + + default: service_account + + - `updated_at: datetime` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_service_account = client.beta.organization.service_accounts.create( + name="ci-deploy-bot", +) +print(beta_service_account.id) +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +`beta.organization.service_accounts.list(**kwargs) -> SyncPageCursor[BetaServiceAccount]` + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Parameters + +- `include_archived: Optional[bool]` + + Include archived resources. Defaults to false. + + default: false + +- `limit: Optional[int]` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount: …` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: str` + + Tagged ID of the service account. + + - `archived_at: Optional[datetime]` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: datetime` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: Optional[str]` + + Optional free-text description. + + - `name: str` + + Admin-chosen slug identifier. + + - `organization_role: Literal["admin", "developer"]` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: Literal["service_account"]` + + default: service_account + + - `updated_at: datetime` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.service_accounts.list() +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +`beta.organization.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccount` + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Parameters + +- `service_account_id: str` + + ID of the service account. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount: …` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: str` + + Tagged ID of the service account. + + - `archived_at: Optional[datetime]` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: datetime` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: Optional[str]` + + Optional free-text description. + + - `name: str` + + Admin-chosen slug identifier. + + - `organization_role: Literal["admin", "developer"]` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: Literal["service_account"]` + + default: service_account + + - `updated_at: datetime` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_service_account = client.beta.organization.service_accounts.retrieve( + service_account_id="service_account_id", +) +print(beta_service_account.id) +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +`beta.organization.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Parameters + +- `service_account_id: str` + + ID of the service account to update. + +- `description: Optional[str]` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `organization_role: Optional[Literal["admin", "developer"]]` + + Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `"admin"` + + - `"developer"` + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount: …` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: str` + + Tagged ID of the service account. + + - `archived_at: Optional[datetime]` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: datetime` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: Optional[str]` + + Optional free-text description. + + - `name: str` + + Admin-chosen slug identifier. + + - `organization_role: Literal["admin", "developer"]` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: Literal["service_account"]` + + default: service_account + + - `updated_at: datetime` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_service_account = client.beta.organization.service_accounts.update( + service_account_id="service_account_id", +) +print(beta_service_account.id) +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +`beta.organization.service_accounts.archive(service_account_id, **kwargs) -> BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Parameters + +- `service_account_id: str` + + ID of the service account to archive. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount: …` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: str` + + Tagged ID of the service account. + + - `archived_at: Optional[datetime]` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: datetime` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: Optional[str]` + + Optional free-text description. + + - `name: str` + + Admin-chosen slug identifier. + + - `organization_role: Literal["admin", "developer"]` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: Literal["service_account"]` + + default: service_account + + - `updated_at: datetime` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: Optional[str]` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_service_account = client.beta.organization.service_accounts.archive( + service_account_id="service_account_id", +) +print(beta_service_account.id) +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +`beta.organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Parameters + +- `service_account_id: str` + + ID of the service account. + +- `workspace_id: str` + + Tagged workspace ID to add the service account to. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccountWorkspaceMember: …` + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: Optional[bool]` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: str` + + Tagged service account ID (`svac_...`). + + - `type: Literal["service_account_workspace_member"]` + + default: service_account_workspace_member + + - `workspace_id: str` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_service_account_workspace_member = ( + client.beta.organization.service_accounts.workspaces.add( + service_account_id="service_account_id", + workspace_id="workspace_id", + workspace_role="workspace_admin", + ) +) +print(beta_service_account_workspace_member.created_by_actor_id) +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +`beta.organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]` + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Parameters + +- `service_account_id: str` + + ID of the service account. + +- `limit: Optional[int]` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccountWorkspaceMember: …` + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: Optional[bool]` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: str` + + Tagged service account ID (`svac_...`). + + - `type: Literal["service_account_workspace_member"]` + + default: service_account_workspace_member + + - `workspace_id: str` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.service_accounts.workspaces.list( + service_account_id="service_account_id", +) +page = page.data[0] +print(page.created_by_actor_id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +`beta.organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse` + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Parameters + +- `service_account_id: str` + + ID of the service account. + +- `workspace_id: str` + + ID of the workspace. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class WorkspaceRemoveResponse: …` + + - `service_account_id: str` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: Literal["service_account_workspace_member_deleted"]` + + default: service_account_workspace_member_deleted + + - `workspace_id: str` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +workspace = client.beta.organization.service_accounts.workspaces.remove( + workspace_id="workspace_id", + service_account_id="service_account_id", +) +print(workspace.service_account_id) +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +`beta.organization.users.list(**kwargs) -> SyncPage[BetaOrganizationUser]` + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Parameters + +- `after_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: Optional[str]` + + Filter by user email. + + format: email + +- `limit: Optional[int]` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +- `roles: Optional[Sequence[str]]` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `class BetaOrganizationUser: …` + + - `id: str` + + ID of the User. + + - `added_at: datetime` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: str` + + Email of the User. + + - `name: str` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: Literal["user"]` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.users.list() +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +`beta.organization.users.retrieve(user_id) -> BetaOrganizationUser` + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Parameters + +- `user_id: str` + + ID of the User. + +#### Returns + +- `class BetaOrganizationUser: …` + + - `id: str` + + ID of the User. + + - `added_at: datetime` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: str` + + Email of the User. + + - `name: str` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: Literal["user"]` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_organization_user = client.beta.organization.users.retrieve( + "user_id", +) +print(beta_organization_user.id) +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +`beta.organization.users.update(user_id, **kwargs) -> BetaOrganizationUser` + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Parameters + +- `user_id: str` + + ID of the User. + +- `role: Literal["billing", "claude_code_user", "developer", 2 more]` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +#### Returns + +- `class BetaOrganizationUser: …` + + - `id: str` + + ID of the User. + + - `added_at: datetime` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: str` + + Email of the User. + + - `name: str` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: Literal["user"]` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_organization_user = client.beta.organization.users.update( + user_id="user_id", + role="user", +) +print(beta_organization_user.id) +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +`beta.organization.users.remove(user_id) -> UserRemoveResponse` + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Parameters + +- `user_id: str` + + ID of the User. + +#### Returns + +- `class UserRemoveResponse: …` + + - `id: str` + + ID of the User. + + - `type: Literal["user_deleted"]` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + + default: user_deleted + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +user = client.beta.organization.users.remove( + "user_id", +) +print(user.id) +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +`beta.organization.workspaces.list(**kwargs) -> SyncPage[BetaWorkspace]` + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Parameters + +- `after_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `include_archived: Optional[bool]` + + Whether to include Workspaces that have been archived in the response + + default: false + +- `limit: Optional[int]` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +#### Returns + +- `class BetaWorkspace: …` + + - `id: str` + + ID of the Workspace. + + - `archived_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: str` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: datetime` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Union[List[str], Literal["unrestricted"]]` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List[str]` + + - `Literal["unrestricted"]` + + - `default_inference_geo: str` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: str` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: str` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: Optional[str]` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: str` + + Name of the Workspace. + + - `tags: Dict[str, str]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: Literal["workspace"]` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.workspaces.list() +page = page.data[0] +print(page.id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +`beta.organization.workspaces.create(**kwargs) -> BetaWorkspace` + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Parameters + +- `name: str` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `data_residency: Optional[BetaDataResidencyCreateConfigParam]` + + Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `allowed_inference_geos: Optional[Union[List[BetaAllowedInferenceGeo], Literal["unrestricted"], null]]` + + Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. + + - `List[BetaAllowedInferenceGeo]` + + - `"global"` + + - `"us"` + + - `Literal["unrestricted"]` + + - `default_inference_geo: Optional[Literal["global", "us"]]` + + Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + + - `workspace_geo: Optional[Literal["us"]]` + + Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. + +- `display_color: Optional[str]` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: Optional[str]` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `tags: Optional[Dict[str, str]]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaWorkspace: …` + + - `id: str` + + ID of the Workspace. + + - `archived_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: str` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: datetime` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Union[List[str], Literal["unrestricted"]]` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List[str]` + + - `Literal["unrestricted"]` + + - `default_inference_geo: str` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: str` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: str` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: Optional[str]` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: str` + + Name of the Workspace. + + - `tags: Dict[str, str]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: Literal["workspace"]` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_workspace = client.beta.organization.workspaces.create( + name="x", +) +print(beta_workspace.id) +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +`beta.organization.workspaces.retrieve(workspace_id) -> BetaWorkspace` + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Parameters + +- `workspace_id: str` + + ID of the Workspace. + +#### Returns + +- `class BetaWorkspace: …` + + - `id: str` + + ID of the Workspace. + + - `archived_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: str` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: datetime` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Union[List[str], Literal["unrestricted"]]` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List[str]` + + - `Literal["unrestricted"]` + + - `default_inference_geo: str` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: str` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: str` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: Optional[str]` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: str` + + Name of the Workspace. + + - `tags: Dict[str, str]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: Literal["workspace"]` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_workspace = client.beta.organization.workspaces.retrieve( + "workspace_id", +) +print(beta_workspace.id) +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +`beta.organization.workspaces.update(workspace_id, **kwargs) -> BetaWorkspace` + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Parameters + +- `workspace_id: str` + +- `data_residency: Optional[BetaDataResidencyUpdateConfigParam]` + + Data residency configuration for the workspace. + + - `allowed_inference_geos: Optional[Union[List[BetaAllowedInferenceGeo], Literal["unrestricted"], null]]` + + Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. + + - `List[BetaAllowedInferenceGeo]` + + - `"global"` + + - `"us"` + + - `Literal["unrestricted"]` + + - `default_inference_geo: Optional[Literal["global", "us"]]` + + Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + +- `display_color: Optional[str]` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: Optional[str]` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `name: Optional[str]` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `tags: Optional[Dict[str, Optional[str]]]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `class BetaWorkspace: …` + + - `id: str` + + ID of the Workspace. + + - `archived_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: str` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: datetime` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Union[List[str], Literal["unrestricted"]]` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List[str]` + + - `Literal["unrestricted"]` + + - `default_inference_geo: str` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: str` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: str` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: Optional[str]` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: str` + + Name of the Workspace. + + - `tags: Dict[str, str]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: Literal["workspace"]` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_workspace = client.beta.organization.workspaces.update( + workspace_id="workspace_id", +) +print(beta_workspace.id) +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +`beta.organization.workspaces.archive(workspace_id) -> BetaWorkspace` + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Parameters + +- `workspace_id: str` + +#### Returns + +- `class BetaWorkspace: …` + + - `id: str` + + ID of the Workspace. + + - `archived_at: Optional[datetime]` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: str` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: datetime` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Union[List[str], Literal["unrestricted"]]` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `List[str]` + + - `Literal["unrestricted"]` + + - `default_inference_geo: str` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: str` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: str` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: Optional[str]` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: str` + + Name of the Workspace. + + - `tags: Dict[str, str]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: Literal["workspace"]` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_workspace = client.beta.organization.workspaces.archive( + "workspace_id", +) +print(beta_workspace.id) +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +`beta.organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> SyncPageCursor[BetaWorkspaceRateLimit]` + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `workspace_id: str` + + The ID of the workspace. + +- `group_type: Optional[Literal["batch", "files", "model_group", 3 more]]` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: Optional[int]` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaWorkspaceRateLimit: …` + + - `group_type: Literal["batch", "files", "model_group", 3 more]` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: List[BetaWorkspaceRateLimitValue]` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: Optional[int]` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: str` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: int` + + The workspace-level override value for this limiter type. + + - `models: Optional[List[str]]` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: str` + + The `id` of the RateLimit group this override applies to. + + - `type: Literal["workspace_rate_limit"]` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `workspace_id: str` + + ID of the Workspace this override applies to. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.workspaces.rate_limits.list( + workspace_id="workspace_id", +) +page = page.data[0] +print(page.rate_limit_id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +`beta.organization.workspaces.members.list(workspace_id, **kwargs) -> SyncPage[BetaWorkspaceMember]` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Parameters + +- `workspace_id: str` + + ID of the Workspace. + +- `after_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: Optional[str]` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `limit: Optional[int]` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + default: 20, maximum: 1000, minimum: 1 + +#### Returns + +- `class BetaWorkspaceMember: …` + + - `type: Literal["workspace_member"]` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: str` + + ID of the User. + + - `workspace_id: str` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.workspaces.members.list( + workspace_id="workspace_id", +) +page = page.data[0] +print(page.user_id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +`beta.organization.workspaces.members.add(workspace_id, **kwargs) -> BetaWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Parameters + +- `workspace_id: str` + + ID of the Workspace. + +- `user_id: str` + + ID of the User. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `class BetaWorkspaceMember: …` + + - `type: Literal["workspace_member"]` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: str` + + ID of the User. + + - `workspace_id: str` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_workspace_member = client.beta.organization.workspaces.members.add( + workspace_id="workspace_id", + user_id="user_01WCz1FkmYMm4gnmykNKUu3Q", + workspace_role="workspace_admin", +) +print(beta_workspace_member.user_id) +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +`beta.organization.workspaces.members.retrieve(user_id, **kwargs) -> BetaWorkspaceMember` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Parameters + +- `workspace_id: str` + + ID of the Workspace. + +- `user_id: str` + + ID of the User. + +#### Returns + +- `class BetaWorkspaceMember: …` + + - `type: Literal["workspace_member"]` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: str` + + ID of the User. + + - `workspace_id: str` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_workspace_member = client.beta.organization.workspaces.members.retrieve( + user_id="user_id", + workspace_id="workspace_id", +) +print(beta_workspace_member.user_id) +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +`beta.organization.workspaces.members.update(user_id, **kwargs) -> BetaWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Parameters + +- `workspace_id: str` + + ID of the Workspace. + +- `user_id: str` + + ID of the User. + +- `workspace_role: BetaWorkspaceRole` + + New workspace role for the User. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `class BetaWorkspaceMember: …` + + - `type: Literal["workspace_member"]` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: str` + + ID of the User. + + - `workspace_id: str` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +beta_workspace_member = client.beta.organization.workspaces.members.update( + user_id="user_id", + workspace_id="workspace_id", + workspace_role="workspace_admin", +) +print(beta_workspace_member.user_id) +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +`beta.organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Parameters + +- `workspace_id: str` + + ID of the Workspace. + +- `user_id: str` + + ID of the User. + +#### Returns + +- `class MemberRemoveResponse: …` + + - `type: Literal["workspace_member_deleted"]` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + + - `user_id: str` + + ID of the User. + + - `workspace_id: str` + + ID of the Workspace. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +member = client.beta.organization.workspaces.members.remove( + user_id="user_id", + workspace_id="workspace_id", +) +print(member.user_id) +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +`beta.organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Parameters + +- `workspace_id: str` + + ID of the workspace. + +- `limit: Optional[int]` + + Number of results per page. + + default: 20, maximum: 100, minimum: 1 + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccountWorkspaceMember: …` + + - `created_by_actor_id: Optional[str]` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: Optional[bool]` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: str` + + Tagged service account ID (`svac_...`). + + - `type: Literal["service_account_workspace_member"]` + + default: service_account_workspace_member + + - `workspace_id: str` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +page = client.beta.organization.workspaces.service_accounts.list( + workspace_id="workspace_id", +) +page = page.data[0] +print(page.created_by_actor_id) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +`beta.organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> BetaServiceAccountWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Parameters + +- `workspace_id: str` + + ID of the workspace. + +- `service_account_id: str` + + Tagged service account ID to add. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +- `betas: Optional[List[AnthropicBetaParam]]` + + Optional header to specify the beta version(s) you want to use. + + - `str` + + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -66512,43 +78612,57 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `class BetaTunnelCertificate: …` +- `class BetaServiceAccountWorkspaceMember: …` - A CA certificate attached to a tunnel. + - `created_by_actor_id: Optional[str]` - - `id: str` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `implicit: Optional[bool]` - - `archived_at: Optional[datetime]` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `service_account_id: str` - format: date-time + Tagged service account ID (`svac_...`). - - `created_at: datetime` + - `type: Literal["service_account_workspace_member"]` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `workspace_id: str` - - `expires_at: Optional[datetime]` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `workspace_role: BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `fingerprint: str` + - `"workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `"workspace_billing"` - - `tunnel_id: str` + - `"workspace_developer"` - ID of the tunnel the certificate is registered against. + - `"workspace_restricted_developer"` - - `type: Literal["tunnel_certificate"]` + - `"workspace_user"` #### Example @@ -66561,42 +78675,55 @@ client = Anthropic( "ANTHROPIC_API_KEY" ), # This is the default and can be omitted ) -beta_tunnel_certificate = client.beta.tunnels.certificates.create( - tunnel_id="tunnel_id", - ca_certificate_pem="ca_certificate_pem", +beta_service_account_workspace_member = ( + client.beta.organization.workspaces.service_accounts.add( + workspace_id="workspace_id", + service_account_id="service_account_id", + workspace_role="workspace_admin", + ) ) -print(beta_tunnel_certificate.id) +print(beta_service_account_workspace_member.created_by_actor_id) ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Get Tunnel Certificate +### Get Service Account Workspace Member -`beta.tunnels.certificates.retrieve(certificate_id, **kwargs) -> BetaTunnelCertificate` +`beta.organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember` -**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Fetches a tunnel certificate by ID. +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. #### Parameters -- `tunnel_id: str` +- `workspace_id: str` -- `certificate_id: str` + ID of the workspace. + +- `service_account_id: str` + + ID of the service account. - `betas: Optional[List[AnthropicBetaParam]]` @@ -66604,7 +78731,7 @@ Fetches a tunnel certificate by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -66674,43 +78801,57 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `class BetaTunnelCertificate: …` +- `class BetaServiceAccountWorkspaceMember: …` - A CA certificate attached to a tunnel. + - `created_by_actor_id: Optional[str]` - - `id: str` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `implicit: Optional[bool]` - - `archived_at: Optional[datetime]` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `service_account_id: str` - format: date-time + Tagged service account ID (`svac_...`). - - `created_at: datetime` + - `type: Literal["service_account_workspace_member"]` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `workspace_id: str` - - `expires_at: Optional[datetime]` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `workspace_role: BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `fingerprint: str` + - `"workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `"workspace_billing"` - - `tunnel_id: str` + - `"workspace_developer"` - ID of the tunnel the certificate is registered against. + - `"workspace_restricted_developer"` - - `type: Literal["tunnel_certificate"]` + - `"workspace_user"` #### Example @@ -66723,54 +78864,66 @@ client = Anthropic( "ANTHROPIC_API_KEY" ), # This is the default and can be omitted ) -beta_tunnel_certificate = client.beta.tunnels.certificates.retrieve( - certificate_id="certificate_id", - tunnel_id="tunnel_id", +beta_service_account_workspace_member = ( + client.beta.organization.workspaces.service_accounts.retrieve( + service_account_id="service_account_id", + workspace_id="workspace_id", + ) ) -print(beta_tunnel_certificate.id) +print(beta_service_account_workspace_member.created_by_actor_id) ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### List Tunnel Certificates +### Update Service Account Workspace Member -`beta.tunnels.certificates.list(tunnel_id, **kwargs) -> SyncPageCursor[BetaTunnelCertificate]` +`beta.organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember` -**GET** `/v1/tunnels/{tunnel_id}/certificates` +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. #### Parameters -- `tunnel_id: str` +- `workspace_id: str` -- `include_archived: Optional[bool]` + ID of the workspace. - Whether to include archived certificates in the results. Defaults to false. +- `service_account_id: str` -- `limit: Optional[int]` + ID of the service account. - Maximum number of certificates to return per page. Defaults to 20, maximum 1000. +- `workspace_role: BetaNoBillingWorkspaceRole` - format: int32 + New role for the service account in this workspace. -- `page: Optional[str]` + - `"workspace_admin"` - Opaque pagination cursor from a previous `list_tunnel_certificates` response. + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` - `betas: Optional[List[AnthropicBetaParam]]` @@ -66778,7 +78931,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -66848,43 +79001,57 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `class BetaTunnelCertificate: …` +- `class BetaServiceAccountWorkspaceMember: …` - A CA certificate attached to a tunnel. + - `created_by_actor_id: Optional[str]` - - `id: str` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `implicit: Optional[bool]` - - `archived_at: Optional[datetime]` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `service_account_id: str` - format: date-time + Tagged service account ID (`svac_...`). - - `created_at: datetime` + - `type: Literal["service_account_workspace_member"]` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `workspace_id: str` - - `expires_at: Optional[datetime]` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `workspace_role: BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `fingerprint: str` + - `"workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `"workspace_billing"` - - `tunnel_id: str` + - `"workspace_developer"` - ID of the tunnel the certificate is registered against. + - `"workspace_restricted_developer"` - - `type: Literal["tunnel_certificate"]` + - `"workspace_user"` #### Example @@ -66897,47 +79064,54 @@ client = Anthropic( "ANTHROPIC_API_KEY" ), # This is the default and can be omitted ) -page = client.beta.tunnels.certificates.list( - tunnel_id="tunnel_id", +beta_service_account_workspace_member = ( + client.beta.organization.workspaces.service_accounts.update( + service_account_id="service_account_id", + workspace_id="workspace_id", + workspace_role="workspace_admin", + ) ) -page = page.data[0] -print(page.id) +print(beta_service_account_workspace_member.created_by_actor_id) ``` ##### Response (200) ```json { - "data": [ - { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" - } - ], - "next_page": "next_page" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Archive Tunnel Certificate +### Delete Service Account Workspace Member -`beta.tunnels.certificates.archive(certificate_id, **kwargs) -> BetaTunnelCertificate` +`beta.organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse` -**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. #### Parameters -- `tunnel_id: str` +- `workspace_id: str` -- `certificate_id: str` + ID of the workspace. + +- `service_account_id: str` + + ID of the service account. - `betas: Optional[List[AnthropicBetaParam]]` @@ -66945,7 +79119,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -67015,43 +79189,161 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `class BetaTunnelCertificate: …` +- `class ServiceAccountRemoveResponse: …` - A CA certificate attached to a tunnel. + - `service_account_id: str` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: Literal["service_account_workspace_member_deleted"]` + + default: service_account_workspace_member_deleted + + - `workspace_id: str` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```python +import os +from anthropic import Anthropic + +client = Anthropic( + api_key=os.environ.get( + "ANTHROPIC_API_KEY" + ), # This is the default and can be omitted +) +service_account = client.beta.organization.workspaces.service_accounts.remove( + service_account_id="service_account_id", + workspace_id="workspace_id", +) +print(service_account.service_account_id) +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Rate Limits + +### List Organization Rate Limits + +`beta.organization.rate_limits.list(**kwargs) -> SyncPageCursor[BetaOrganizationRateLimit]` + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `group_type: Optional[Literal["batch", "files", "model_group", 3 more]]` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + +- `limit: Optional[int]` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `model: Optional[str]` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + +- `page: Optional[str]` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaOrganizationRateLimit: …` - `id: str` - Unique identifier for the certificate, prefixed with `tcrt_`. + Stable identifier for this rate-limit group within the organization. - - `archived_at: Optional[datetime]` + - `group_type: Literal["batch", "files", "model_group", 3 more]` - A timestamp in RFC 3339 format + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. - format: date-time + - `"batch"` - - `created_at: datetime` + - `"files"` - A timestamp in RFC 3339 format + - `"model_group"` - format: date-time + - `"skills"` - - `expires_at: Optional[datetime]` + - `"token_count"` - A timestamp in RFC 3339 format + - `"web_search"` - format: date-time + - `limits: List[BetaOrganizationRateLimitValue]` - - `fingerprint: str` + The limiter values that apply to this group. - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `type: str` - - `tunnel_id: str` + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - ID of the tunnel the certificate is registered against. + - `value: int` - - `type: Literal["tunnel_certificate"]` + The configured limit value for this limiter type. + + - `models: Optional[List[str]]` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: Literal["rate_limit"]` + + Object type. Always `rate_limit` for organization rate-limit entries. + + default: rate_limit #### Example @@ -67064,23 +79356,31 @@ client = Anthropic( "ANTHROPIC_API_KEY" ), # This is the default and can be omitted ) -beta_tunnel_certificate = client.beta.tunnels.certificates.archive( - certificate_id="certificate_id", - tunnel_id="tunnel_id", -) -print(beta_tunnel_certificate.id) +page = client.beta.organization.rate_limits.list() +page = page.data[0] +print(page.id) ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" } ``` diff --git a/content/en/api/python/beta/agents.md b/content/en/api/python/beta/agents.md index ade1ac7ef..ecf51649a 100644 --- a/content/en/api/python/beta/agents.md +++ b/content/en/api/python/beta/agents.md @@ -700,7 +700,7 @@ Create Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -770,6 +770,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent: …` @@ -1451,7 +1465,7 @@ List Agents - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1521,6 +1535,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent: …` @@ -2187,7 +2215,7 @@ Get Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2257,6 +2285,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent: …` @@ -3603,7 +3645,7 @@ Update Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3673,6 +3715,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent: …` @@ -4330,7 +4386,7 @@ Archive Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -4400,6 +4456,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent: …` @@ -8878,7 +8948,7 @@ List Agent Versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -8948,6 +9018,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent: …` diff --git a/content/en/api/python/beta/agents/archive.md b/content/en/api/python/beta/agents/archive.md index 2cdde27de..d18eb30ae 100644 --- a/content/en/api/python/beta/agents/archive.md +++ b/content/en/api/python/beta/agents/archive.md @@ -16,7 +16,7 @@ Archive Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent: …` diff --git a/content/en/api/python/beta/agents/create.md b/content/en/api/python/beta/agents/create.md index cde4acc8b..8c50d3064 100644 --- a/content/en/api/python/beta/agents/create.md +++ b/content/en/api/python/beta/agents/create.md @@ -698,7 +698,7 @@ Create Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -768,6 +768,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent: …` diff --git a/content/en/api/python/beta/agents/list.md b/content/en/api/python/beta/agents/list.md index 890d25f59..1721f142c 100644 --- a/content/en/api/python/beta/agents/list.md +++ b/content/en/api/python/beta/agents/list.md @@ -40,7 +40,7 @@ List Agents - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -110,6 +110,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent: …` diff --git a/content/en/api/python/beta/agents/retrieve.md b/content/en/api/python/beta/agents/retrieve.md index 7bffecdb3..bfea89c31 100644 --- a/content/en/api/python/beta/agents/retrieve.md +++ b/content/en/api/python/beta/agents/retrieve.md @@ -22,7 +22,7 @@ Get Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent: …` diff --git a/content/en/api/python/beta/agents/update.md b/content/en/api/python/beta/agents/update.md index 83872d554..511a50f60 100644 --- a/content/en/api/python/beta/agents/update.md +++ b/content/en/api/python/beta/agents/update.md @@ -706,7 +706,7 @@ Update Agent - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -776,6 +776,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent: …` diff --git a/content/en/api/python/beta/agents/versions.md b/content/en/api/python/beta/agents/versions.md index 20c05a082..e1237a984 100644 --- a/content/en/api/python/beta/agents/versions.md +++ b/content/en/api/python/beta/agents/versions.md @@ -28,7 +28,7 @@ List Agent Versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent: …` diff --git a/content/en/api/python/beta/agents/versions/list.md b/content/en/api/python/beta/agents/versions/list.md index 710a0efe4..2d6e93f76 100644 --- a/content/en/api/python/beta/agents/versions/list.md +++ b/content/en/api/python/beta/agents/versions/list.md @@ -26,7 +26,7 @@ List Agent Versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent: …` diff --git a/content/en/api/python/beta/deployment_runs.md b/content/en/api/python/beta/deployment_runs.md index ee5aa14d0..0717c03a9 100644 --- a/content/en/api/python/beta/deployment_runs.md +++ b/content/en/api/python/beta/deployment_runs.md @@ -66,7 +66,7 @@ List Deployment Runs - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -136,6 +136,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeploymentRun: …` @@ -424,7 +438,7 @@ Get Deployment Run - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -494,6 +508,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeploymentRun: …` diff --git a/content/en/api/python/beta/deployment_runs/list.md b/content/en/api/python/beta/deployment_runs/list.md index 7e72ee2f9..77283e631 100644 --- a/content/en/api/python/beta/deployment_runs/list.md +++ b/content/en/api/python/beta/deployment_runs/list.md @@ -64,7 +64,7 @@ List Deployment Runs - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -134,6 +134,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeploymentRun: …` diff --git a/content/en/api/python/beta/deployment_runs/retrieve.md b/content/en/api/python/beta/deployment_runs/retrieve.md index 4b82272df..900abaafa 100644 --- a/content/en/api/python/beta/deployment_runs/retrieve.md +++ b/content/en/api/python/beta/deployment_runs/retrieve.md @@ -16,7 +16,7 @@ Get Deployment Run - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeploymentRun: …` diff --git a/content/en/api/python/beta/deployments.md b/content/en/api/python/beta/deployments.md index a76cb5ce7..9a3a90c69 100644 --- a/content/en/api/python/beta/deployments.md +++ b/content/en/api/python/beta/deployments.md @@ -416,7 +416,7 @@ Create Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -486,6 +486,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment: …` @@ -1153,7 +1167,7 @@ List Deployments - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1223,6 +1237,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment: …` @@ -1845,7 +1873,7 @@ Get Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1915,6 +1943,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment: …` @@ -2933,7 +2975,7 @@ Update Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3003,6 +3045,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment: …` @@ -3621,7 +3677,7 @@ Archive Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3691,6 +3747,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment: …` @@ -4309,7 +4379,7 @@ Run Deployment Now - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -4379,6 +4449,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeploymentRun: …` @@ -4663,7 +4747,7 @@ Pause Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -4733,6 +4817,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment: …` @@ -5351,7 +5449,7 @@ Unpause Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -5421,6 +5519,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment: …` diff --git a/content/en/api/python/beta/deployments/archive.md b/content/en/api/python/beta/deployments/archive.md index 584876319..8014d5b91 100644 --- a/content/en/api/python/beta/deployments/archive.md +++ b/content/en/api/python/beta/deployments/archive.md @@ -16,7 +16,7 @@ Archive Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment: …` diff --git a/content/en/api/python/beta/deployments/create.md b/content/en/api/python/beta/deployments/create.md index c96be4da6..08f558f06 100644 --- a/content/en/api/python/beta/deployments/create.md +++ b/content/en/api/python/beta/deployments/create.md @@ -414,7 +414,7 @@ Create Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -484,6 +484,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment: …` diff --git a/content/en/api/python/beta/deployments/list.md b/content/en/api/python/beta/deployments/list.md index 85ba78fe7..a86b14965 100644 --- a/content/en/api/python/beta/deployments/list.md +++ b/content/en/api/python/beta/deployments/list.md @@ -52,7 +52,7 @@ List Deployments - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -122,6 +122,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment: …` diff --git a/content/en/api/python/beta/deployments/pause.md b/content/en/api/python/beta/deployments/pause.md index 744989da0..9600177c7 100644 --- a/content/en/api/python/beta/deployments/pause.md +++ b/content/en/api/python/beta/deployments/pause.md @@ -16,7 +16,7 @@ Pause Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment: …` diff --git a/content/en/api/python/beta/deployments/retrieve.md b/content/en/api/python/beta/deployments/retrieve.md index cedb2ce9d..d209f90aa 100644 --- a/content/en/api/python/beta/deployments/retrieve.md +++ b/content/en/api/python/beta/deployments/retrieve.md @@ -16,7 +16,7 @@ Get Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment: …` diff --git a/content/en/api/python/beta/deployments/run.md b/content/en/api/python/beta/deployments/run.md index 8deefb2f2..3f0ee1e64 100644 --- a/content/en/api/python/beta/deployments/run.md +++ b/content/en/api/python/beta/deployments/run.md @@ -16,7 +16,7 @@ Run Deployment Now - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeploymentRun: …` diff --git a/content/en/api/python/beta/deployments/unpause.md b/content/en/api/python/beta/deployments/unpause.md index 8cb0a53d7..c6d2de9e1 100644 --- a/content/en/api/python/beta/deployments/unpause.md +++ b/content/en/api/python/beta/deployments/unpause.md @@ -16,7 +16,7 @@ Unpause Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment: …` diff --git a/content/en/api/python/beta/deployments/update.md b/content/en/api/python/beta/deployments/update.md index 7777fef0c..0aa27b91e 100644 --- a/content/en/api/python/beta/deployments/update.md +++ b/content/en/api/python/beta/deployments/update.md @@ -416,7 +416,7 @@ Update Deployment - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -486,6 +486,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment: …` diff --git a/content/en/api/python/beta/environments.md b/content/en/api/python/beta/environments.md index b06d929c0..f5e069d46 100644 --- a/content/en/api/python/beta/environments.md +++ b/content/en/api/python/beta/environments.md @@ -60,7 +60,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: Optional[bool]` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Optional[List[str]]` @@ -72,6 +72,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Optional[List[str]]` Ubuntu/Debian packages to install @@ -134,7 +136,7 @@ Create a new environment with the specified configuration. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -204,6 +206,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment: …` @@ -436,7 +452,7 @@ List environments with pagination support. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -506,6 +522,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment: …` @@ -728,7 +758,7 @@ Retrieve a specific environment by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -798,6 +828,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment: …` @@ -1054,7 +1098,7 @@ Update an existing environment's configuration. - `allow_package_managers: Optional[bool]` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Optional[List[str]]` @@ -1066,6 +1110,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Optional[List[str]]` Ubuntu/Debian packages to install @@ -1134,7 +1180,7 @@ Update an existing environment's configuration. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1204,6 +1250,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment: …` @@ -1422,7 +1482,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1492,6 +1552,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironmentDeleteResponse: …` @@ -1552,7 +1626,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1622,6 +1696,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment: …` @@ -1942,7 +2030,7 @@ print(beta_environment.id) - `allow_package_managers: Optional[bool]` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Optional[List[str]]` @@ -1954,6 +2042,8 @@ print(beta_environment.id) When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Optional[List[str]]` Ubuntu/Debian packages to install @@ -2175,7 +2265,7 @@ print(beta_environment.id) - `allow_package_managers: Optional[bool]` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Optional[List[str]]` @@ -2225,6 +2315,8 @@ print(beta_environment.id) When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Optional[List[str]]` Ubuntu/Debian packages to install @@ -2309,7 +2401,7 @@ Retrieve detailed information about a specific work item. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2379,6 +2471,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -2536,7 +2642,7 @@ Long poll for work items in the queue. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2606,6 +2712,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `anthropic_worker_id: Optional[str]` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -2756,7 +2876,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2826,6 +2946,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -2981,7 +3115,7 @@ Record a heartbeat for a work item to maintain the lease. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3051,6 +3185,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWorkHeartbeatResponse: …` @@ -3147,7 +3295,7 @@ Stop a work item, initiating graceful or forced shutdown. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3217,6 +3365,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -3372,7 +3534,7 @@ List work items in an environment. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3442,6 +3604,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -3598,7 +3774,7 @@ Update work item metadata with merge semantics. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3668,6 +3844,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork: …` @@ -3812,7 +4002,7 @@ Get statistics about the work queue for an environment. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3882,6 +4072,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWorkQueueStats: …` diff --git a/content/en/api/python/beta/environments/archive.md b/content/en/api/python/beta/environments/archive.md index 34ed7bb5d..cdf8d9d06 100644 --- a/content/en/api/python/beta/environments/archive.md +++ b/content/en/api/python/beta/environments/archive.md @@ -16,7 +16,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment: …` diff --git a/content/en/api/python/beta/environments/create.md b/content/en/api/python/beta/environments/create.md index 470475dcf..f07a3422f 100644 --- a/content/en/api/python/beta/environments/create.md +++ b/content/en/api/python/beta/environments/create.md @@ -58,7 +58,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: Optional[bool]` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Optional[List[str]]` @@ -70,6 +70,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Optional[List[str]]` Ubuntu/Debian packages to install @@ -132,7 +134,7 @@ Create a new environment with the specified configuration. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -202,6 +204,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment: …` diff --git a/content/en/api/python/beta/environments/delete.md b/content/en/api/python/beta/environments/delete.md index 62094aced..3986216a6 100644 --- a/content/en/api/python/beta/environments/delete.md +++ b/content/en/api/python/beta/environments/delete.md @@ -16,7 +16,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironmentDeleteResponse: …` diff --git a/content/en/api/python/beta/environments/list.md b/content/en/api/python/beta/environments/list.md index 4386fd734..2ce600ab2 100644 --- a/content/en/api/python/beta/environments/list.md +++ b/content/en/api/python/beta/environments/list.md @@ -30,7 +30,7 @@ List environments with pagination support. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment: …` diff --git a/content/en/api/python/beta/environments/retrieve.md b/content/en/api/python/beta/environments/retrieve.md index 8b57385d0..2c09b2d39 100644 --- a/content/en/api/python/beta/environments/retrieve.md +++ b/content/en/api/python/beta/environments/retrieve.md @@ -16,7 +16,7 @@ Retrieve a specific environment by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment: …` diff --git a/content/en/api/python/beta/environments/update.md b/content/en/api/python/beta/environments/update.md index 15fbdc728..6c920b727 100644 --- a/content/en/api/python/beta/environments/update.md +++ b/content/en/api/python/beta/environments/update.md @@ -54,7 +54,7 @@ Update an existing environment's configuration. - `allow_package_managers: Optional[bool]` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Optional[List[str]]` @@ -66,6 +66,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Optional[List[str]]` Ubuntu/Debian packages to install @@ -134,7 +136,7 @@ Update an existing environment's configuration. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -204,6 +206,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment: …` diff --git a/content/en/api/python/beta/environments/work.md b/content/en/api/python/beta/environments/work.md index b17c90e6f..e73ebee39 100644 --- a/content/en/api/python/beta/environments/work.md +++ b/content/en/api/python/beta/environments/work.md @@ -22,7 +22,7 @@ Retrieve detailed information about a specific work item. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork: …` @@ -249,7 +263,7 @@ Long poll for work items in the queue. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -319,6 +333,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `anthropic_worker_id: Optional[str]` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -469,7 +497,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -539,6 +567,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork: …` @@ -694,7 +736,7 @@ Record a heartbeat for a work item to maintain the lease. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -764,6 +806,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWorkHeartbeatResponse: …` @@ -860,7 +916,7 @@ Stop a work item, initiating graceful or forced shutdown. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -930,6 +986,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork: …` @@ -1085,7 +1155,7 @@ List work items in an environment. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1155,6 +1225,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork: …` @@ -1311,7 +1395,7 @@ Update work item metadata with merge semantics. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1381,6 +1465,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork: …` @@ -1525,7 +1623,7 @@ Get statistics about the work queue for an environment. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1595,6 +1693,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWorkQueueStats: …` diff --git a/content/en/api/python/beta/environments/work/ack.md b/content/en/api/python/beta/environments/work/ack.md index c5e471099..f0b5b7384 100644 --- a/content/en/api/python/beta/environments/work/ack.md +++ b/content/en/api/python/beta/environments/work/ack.md @@ -20,7 +20,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork: …` diff --git a/content/en/api/python/beta/environments/work/heartbeat.md b/content/en/api/python/beta/environments/work/heartbeat.md index aee2771b9..bae7b3e1d 100644 --- a/content/en/api/python/beta/environments/work/heartbeat.md +++ b/content/en/api/python/beta/environments/work/heartbeat.md @@ -28,7 +28,7 @@ Record a heartbeat for a work item to maintain the lease. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWorkHeartbeatResponse: …` diff --git a/content/en/api/python/beta/environments/work/list.md b/content/en/api/python/beta/environments/work/list.md index 390ab2c67..8726e9104 100644 --- a/content/en/api/python/beta/environments/work/list.md +++ b/content/en/api/python/beta/environments/work/list.md @@ -28,7 +28,7 @@ List work items in an environment. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork: …` diff --git a/content/en/api/python/beta/environments/work/poll.md b/content/en/api/python/beta/environments/work/poll.md index 019b2370f..68b1e2aae 100644 --- a/content/en/api/python/beta/environments/work/poll.md +++ b/content/en/api/python/beta/environments/work/poll.md @@ -30,7 +30,7 @@ Long poll for work items in the queue. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `anthropic_worker_id: Optional[str]` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console diff --git a/content/en/api/python/beta/environments/work/retrieve.md b/content/en/api/python/beta/environments/work/retrieve.md index 0aa4479e8..fc79cf08c 100644 --- a/content/en/api/python/beta/environments/work/retrieve.md +++ b/content/en/api/python/beta/environments/work/retrieve.md @@ -20,7 +20,7 @@ Retrieve detailed information about a specific work item. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork: …` diff --git a/content/en/api/python/beta/environments/work/stats.md b/content/en/api/python/beta/environments/work/stats.md index 6581a82b4..706930e21 100644 --- a/content/en/api/python/beta/environments/work/stats.md +++ b/content/en/api/python/beta/environments/work/stats.md @@ -16,7 +16,7 @@ Get statistics about the work queue for an environment. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWorkQueueStats: …` diff --git a/content/en/api/python/beta/environments/work/stop.md b/content/en/api/python/beta/environments/work/stop.md index 934994714..cf73fd1bb 100644 --- a/content/en/api/python/beta/environments/work/stop.md +++ b/content/en/api/python/beta/environments/work/stop.md @@ -26,7 +26,7 @@ Stop a work item, initiating graceful or forced shutdown. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork: …` diff --git a/content/en/api/python/beta/environments/work/update.md b/content/en/api/python/beta/environments/work/update.md index 0488a5c21..678311859 100644 --- a/content/en/api/python/beta/environments/work/update.md +++ b/content/en/api/python/beta/environments/work/update.md @@ -24,7 +24,7 @@ Update work item metadata with merge semantics. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork: …` diff --git a/content/en/api/python/beta/files.md b/content/en/api/python/beta/files.md index 8b4ec1a7c..4b42398f3 100644 --- a/content/en/api/python/beta/files.md +++ b/content/en/api/python/beta/files.md @@ -22,7 +22,7 @@ Upload File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaFileMetadata: …` @@ -221,7 +235,7 @@ List Files - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -291,6 +305,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaFileMetadata: …` @@ -410,7 +438,7 @@ Download File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -480,6 +508,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BinaryResponseContent` @@ -523,7 +565,7 @@ Get File Metadata - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -593,6 +635,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaFileMetadata: …` @@ -706,7 +762,7 @@ Delete File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -776,6 +832,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaDeletedFile: …` diff --git a/content/en/api/python/beta/files/delete.md b/content/en/api/python/beta/files/delete.md index b909830f6..c83676337 100644 --- a/content/en/api/python/beta/files/delete.md +++ b/content/en/api/python/beta/files/delete.md @@ -18,7 +18,7 @@ Delete File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaDeletedFile: …` diff --git a/content/en/api/python/beta/files/download.md b/content/en/api/python/beta/files/download.md index 5619528fe..778ba04a1 100644 --- a/content/en/api/python/beta/files/download.md +++ b/content/en/api/python/beta/files/download.md @@ -18,7 +18,7 @@ Download File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BinaryResponseContent` diff --git a/content/en/api/python/beta/files/list.md b/content/en/api/python/beta/files/list.md index 6ed89b12b..714848512 100644 --- a/content/en/api/python/beta/files/list.md +++ b/content/en/api/python/beta/files/list.md @@ -34,7 +34,7 @@ List Files - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaFileMetadata: …` diff --git a/content/en/api/python/beta/files/retrieve_metadata.md b/content/en/api/python/beta/files/retrieve_metadata.md index e3e54b671..692b868bc 100644 --- a/content/en/api/python/beta/files/retrieve_metadata.md +++ b/content/en/api/python/beta/files/retrieve_metadata.md @@ -18,7 +18,7 @@ Get File Metadata - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaFileMetadata: …` diff --git a/content/en/api/python/beta/files/upload.md b/content/en/api/python/beta/files/upload.md index 1cbfaa98a..2b57d8e84 100644 --- a/content/en/api/python/beta/files/upload.md +++ b/content/en/api/python/beta/files/upload.md @@ -20,7 +20,7 @@ Upload File - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaFileMetadata: …` diff --git a/content/en/api/python/beta/memory_stores.md b/content/en/api/python/beta/memory_stores.md index 1c5579f45..be276e47c 100644 --- a/content/en/api/python/beta/memory_stores.md +++ b/content/en/api/python/beta/memory_stores.md @@ -32,7 +32,7 @@ Create a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -220,7 +234,7 @@ List memory stores - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -290,6 +304,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -388,7 +416,7 @@ Retrieve a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -458,6 +486,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -568,7 +610,7 @@ Update a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -638,6 +680,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -732,7 +788,7 @@ Delete a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -802,6 +858,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedMemoryStore: …` @@ -858,7 +928,7 @@ Archive a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -928,6 +998,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore: …` @@ -1098,7 +1182,7 @@ Create a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1168,6 +1252,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory: …` @@ -1200,7 +1298,7 @@ Create a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -1300,7 +1398,7 @@ List memories - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1370,6 +1468,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryListItem` @@ -1406,7 +1518,7 @@ List memories - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -1502,7 +1614,7 @@ Retrieve a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1572,6 +1684,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory: …` @@ -1604,7 +1730,7 @@ Retrieve a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -1705,7 +1831,7 @@ Update a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1775,6 +1901,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory: …` @@ -1807,7 +1947,7 @@ Update a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -1884,7 +2024,7 @@ Delete a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1954,11 +2094,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedMemory: …` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: str` @@ -2069,7 +2223,7 @@ List memory versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2139,11 +2293,25 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -2157,7 +2325,7 @@ List memory versions - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` @@ -2332,7 +2500,7 @@ Retrieve a memory version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2402,11 +2570,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -2420,7 +2602,7 @@ Retrieve a memory version - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` @@ -2582,7 +2764,7 @@ Redact a memory version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2652,11 +2834,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -2670,7 +2866,7 @@ Redact a memory version - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` diff --git a/content/en/api/python/beta/memory_stores/archive.md b/content/en/api/python/beta/memory_stores/archive.md index 364ba10b6..66c312ace 100644 --- a/content/en/api/python/beta/memory_stores/archive.md +++ b/content/en/api/python/beta/memory_stores/archive.md @@ -16,7 +16,7 @@ Archive a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore: …` diff --git a/content/en/api/python/beta/memory_stores/create.md b/content/en/api/python/beta/memory_stores/create.md index 6201487d3..03eb25760 100644 --- a/content/en/api/python/beta/memory_stores/create.md +++ b/content/en/api/python/beta/memory_stores/create.md @@ -30,7 +30,7 @@ Create a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore: …` diff --git a/content/en/api/python/beta/memory_stores/delete.md b/content/en/api/python/beta/memory_stores/delete.md index 2536c6c7c..22cd4b725 100644 --- a/content/en/api/python/beta/memory_stores/delete.md +++ b/content/en/api/python/beta/memory_stores/delete.md @@ -16,7 +16,7 @@ Delete a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedMemoryStore: …` diff --git a/content/en/api/python/beta/memory_stores/list.md b/content/en/api/python/beta/memory_stores/list.md index 0e32c4d79..fe5d1336e 100644 --- a/content/en/api/python/beta/memory_stores/list.md +++ b/content/en/api/python/beta/memory_stores/list.md @@ -40,7 +40,7 @@ List memory stores - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -110,6 +110,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore: …` diff --git a/content/en/api/python/beta/memory_stores/memories.md b/content/en/api/python/beta/memory_stores/memories.md index 01a4a6e07..54e471756 100644 --- a/content/en/api/python/beta/memory_stores/memories.md +++ b/content/en/api/python/beta/memory_stores/memories.md @@ -36,7 +36,7 @@ Create a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -106,6 +106,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemory: …` @@ -138,7 +152,7 @@ Create a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -238,7 +252,7 @@ List memories - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -308,6 +322,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryListItem` @@ -344,7 +372,7 @@ List memories - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -440,7 +468,7 @@ Retrieve a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -510,6 +538,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemory: …` @@ -542,7 +584,7 @@ Retrieve a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -643,7 +685,7 @@ Update a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -713,6 +755,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemory: …` @@ -745,7 +801,7 @@ Update a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -822,7 +878,7 @@ Delete a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -892,11 +948,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedMemory: …` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: str` @@ -957,7 +1027,7 @@ print(beta_managed_agents_deleted_memory.id) - `class BetaManagedAgentsDeletedMemory: …` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: str` @@ -1113,7 +1183,7 @@ print(beta_managed_agents_deleted_memory.id) - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` @@ -1167,7 +1237,7 @@ print(beta_managed_agents_deleted_memory.id) - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` diff --git a/content/en/api/python/beta/memory_stores/memories/create.md b/content/en/api/python/beta/memory_stores/memories/create.md index b7f31f0bb..6c00983f7 100644 --- a/content/en/api/python/beta/memory_stores/memories/create.md +++ b/content/en/api/python/beta/memory_stores/memories/create.md @@ -34,7 +34,7 @@ Create a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemory: …` @@ -136,7 +150,7 @@ Create a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` diff --git a/content/en/api/python/beta/memory_stores/memories/delete.md b/content/en/api/python/beta/memory_stores/memories/delete.md index 40e22a2e0..2aa88bf86 100644 --- a/content/en/api/python/beta/memory_stores/memories/delete.md +++ b/content/en/api/python/beta/memory_stores/memories/delete.md @@ -22,7 +22,7 @@ Delete a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -92,11 +92,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedMemory: …` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: str` diff --git a/content/en/api/python/beta/memory_stores/memories/list.md b/content/en/api/python/beta/memory_stores/memories/list.md index aeff9a719..75be171c6 100644 --- a/content/en/api/python/beta/memory_stores/memories/list.md +++ b/content/en/api/python/beta/memory_stores/memories/list.md @@ -44,7 +44,7 @@ List memories - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -114,6 +114,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryListItem` @@ -150,7 +164,7 @@ List memories - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` diff --git a/content/en/api/python/beta/memory_stores/memories/retrieve.md b/content/en/api/python/beta/memory_stores/memories/retrieve.md index 8c88c1bd4..a30c44b45 100644 --- a/content/en/api/python/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/python/beta/memory_stores/memories/retrieve.md @@ -26,7 +26,7 @@ Retrieve a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemory: …` @@ -128,7 +142,7 @@ Retrieve a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` diff --git a/content/en/api/python/beta/memory_stores/memories/update.md b/content/en/api/python/beta/memory_stores/memories/update.md index e4aef9c07..0ffd21064 100644 --- a/content/en/api/python/beta/memory_stores/memories/update.md +++ b/content/en/api/python/beta/memory_stores/memories/update.md @@ -46,7 +46,7 @@ Update a memory - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -116,6 +116,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemory: …` @@ -148,7 +162,7 @@ Update a memory - `memory_version_id: str` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: str` diff --git a/content/en/api/python/beta/memory_stores/memory_versions.md b/content/en/api/python/beta/memory_stores/memory_versions.md index 49c841112..bf2ae5fac 100644 --- a/content/en/api/python/beta/memory_stores/memory_versions.md +++ b/content/en/api/python/beta/memory_stores/memory_versions.md @@ -74,7 +74,7 @@ List memory versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -144,11 +144,25 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -162,7 +176,7 @@ List memory versions - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` @@ -337,7 +351,7 @@ Retrieve a memory version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -407,11 +421,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -425,7 +453,7 @@ Retrieve a memory version - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` @@ -587,7 +615,7 @@ Redact a memory version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -657,11 +685,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -675,7 +717,7 @@ Redact a memory version - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` @@ -891,7 +933,7 @@ print(beta_managed_agents_memory_version.id) - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -905,7 +947,7 @@ print(beta_managed_agents_memory_version.id) - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` diff --git a/content/en/api/python/beta/memory_stores/memory_versions/list.md b/content/en/api/python/beta/memory_stores/memory_versions/list.md index 2111ce99a..520a59d1c 100644 --- a/content/en/api/python/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/python/beta/memory_stores/memory_versions/list.md @@ -72,7 +72,7 @@ List memory versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -142,11 +142,25 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -160,7 +174,7 @@ List memory versions - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` diff --git a/content/en/api/python/beta/memory_stores/memory_versions/redact.md b/content/en/api/python/beta/memory_stores/memory_versions/redact.md index 0ad8f65ee..64e6f7197 100644 --- a/content/en/api/python/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/python/beta/memory_stores/memory_versions/redact.md @@ -18,7 +18,7 @@ Redact a memory version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,11 +88,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -106,7 +120,7 @@ Redact a memory version - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` diff --git a/content/en/api/python/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/python/beta/memory_stores/memory_versions/retrieve.md index e42e06476..70bfaa4e7 100644 --- a/content/en/api/python/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/python/beta/memory_stores/memory_versions/retrieve.md @@ -26,7 +26,7 @@ Retrieve a memory version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,11 +96,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryVersion: …` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: str` @@ -114,7 +128,7 @@ Retrieve a memory version - `memory_id: str` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: str` diff --git a/content/en/api/python/beta/memory_stores/retrieve.md b/content/en/api/python/beta/memory_stores/retrieve.md index 3517ef494..f5b287b18 100644 --- a/content/en/api/python/beta/memory_stores/retrieve.md +++ b/content/en/api/python/beta/memory_stores/retrieve.md @@ -16,7 +16,7 @@ Retrieve a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore: …` diff --git a/content/en/api/python/beta/memory_stores/update.md b/content/en/api/python/beta/memory_stores/update.md index cf313fcf5..a5debfe6e 100644 --- a/content/en/api/python/beta/memory_stores/update.md +++ b/content/en/api/python/beta/memory_stores/update.md @@ -32,7 +32,7 @@ Update a memory store - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore: …` diff --git a/content/en/api/python/beta/messages.md b/content/en/api/python/beta/messages.md index 70930d086..5b6f63694 100644 --- a/content/en/api/python/beta/messages.md +++ b/content/en/api/python/beta/messages.md @@ -1704,7 +1704,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1712,6 +1712,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -1720,7 +1722,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1728,6 +1730,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `Literal["default"]` - `inference_geo: Optional[str]` @@ -3783,7 +3787,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3853,6 +3857,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5298,12 +5316,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -5613,12 +5633,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: int` The cumulative number of output tokens which were used. @@ -7551,7 +7573,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -7559,6 +7581,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -7567,7 +7591,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -7575,6 +7599,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice: Optional[BetaToolChoiceParam]` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -9520,7 +9546,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -9590,6 +9616,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -18295,7 +18335,7 @@ print(beta_message_tokens_count.context_management) - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18303,6 +18343,8 @@ print(beta_message_tokens_count.context_management) - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -18311,7 +18353,7 @@ print(beta_message_tokens_count.context_management) - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18319,6 +18361,8 @@ print(beta_message_tokens_count.context_management) - `"omitted"` + - `"updates"` + ### Beta Fallback Refusal Trigger - `class BetaFallbackRefusalTrigger: …` @@ -18523,7 +18567,7 @@ print(beta_message_tokens_count.context_management) - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18531,6 +18575,8 @@ print(beta_message_tokens_count.context_management) - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -18539,7 +18585,7 @@ print(beta_message_tokens_count.context_management) - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18547,6 +18593,8 @@ print(beta_message_tokens_count.context_management) - `"omitted"` + - `"updates"` + - `Literal["default"]` ### Beta File Document Source @@ -18686,12 +18734,14 @@ print(beta_message_tokens_count.context_management) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -20982,12 +21032,14 @@ print(beta_message_tokens_count.context_management) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -21323,12 +21375,14 @@ print(beta_message_tokens_count.context_management) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -24913,12 +24967,14 @@ print(beta_message_tokens_count.context_management) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -26667,12 +26723,14 @@ print(beta_message_tokens_count.context_management) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -28359,12 +28417,14 @@ print(beta_message_tokens_count.context_management) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -28668,12 +28728,14 @@ print(beta_message_tokens_count.context_management) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: int` The cumulative number of output tokens which were used. @@ -30922,7 +30984,7 @@ print(beta_message_tokens_count.context_management) - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30930,6 +30992,8 @@ print(beta_message_tokens_count.context_management) - `"omitted"` + - `"updates"` + ### Beta Thinking Config Disabled - `class BetaThinkingConfigDisabled: …` @@ -30952,7 +31016,7 @@ print(beta_message_tokens_count.context_management) - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30960,6 +31024,8 @@ print(beta_message_tokens_count.context_management) - `"omitted"` + - `"updates"` + ### Beta Thinking Config Param - `BetaThinkingConfigParam` @@ -30984,7 +31050,7 @@ print(beta_message_tokens_count.context_management) - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30992,6 +31058,8 @@ print(beta_message_tokens_count.context_management) - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -31000,7 +31068,7 @@ print(beta_message_tokens_count.context_management) - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -31008,6 +31076,8 @@ print(beta_message_tokens_count.context_management) - `"omitted"` + - `"updates"` + ### Beta Thinking Delta - `class BetaThinkingDelta: …` @@ -34870,12 +34940,14 @@ print(beta_message_tokens_count.context_management) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -38773,7 +38845,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -38781,6 +38853,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -38789,7 +38863,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -38797,6 +38871,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `Literal["default"]` - `inference_geo: Optional[str]` @@ -40852,7 +40928,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -40922,6 +40998,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -41112,7 +41202,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -41182,6 +41272,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch: …` @@ -41366,7 +41470,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -41436,6 +41540,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch: …` @@ -41616,7 +41734,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -41686,6 +41804,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch: …` @@ -41860,7 +41992,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -41930,6 +42062,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaDeletedMessageBatch: …` @@ -41996,7 +42142,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -42066,6 +42212,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatchIndividualResponse: …` @@ -43517,12 +43677,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. diff --git a/content/en/api/python/beta/messages/batches.md b/content/en/api/python/beta/messages/batches.md index b0cea0d26..a7ce494b7 100644 --- a/content/en/api/python/beta/messages/batches.md +++ b/content/en/api/python/beta/messages/batches.md @@ -1724,7 +1724,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1732,6 +1732,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -1740,7 +1742,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1748,6 +1750,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `Literal["default"]` - `inference_geo: Optional[str]` @@ -3803,7 +3807,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3873,6 +3877,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -4063,7 +4081,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -4133,6 +4151,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaMessageBatch: …` @@ -4317,7 +4349,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -4387,6 +4419,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaMessageBatch: …` @@ -4567,7 +4613,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -4637,6 +4683,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaMessageBatch: …` @@ -4811,7 +4871,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -4881,6 +4941,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaDeletedMessageBatch: …` @@ -4947,7 +5021,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -5017,6 +5091,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaMessageBatchIndividualResponse: …` @@ -6468,12 +6556,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -8553,12 +8643,14 @@ for batch in client.beta.messages.batches.results( Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -10401,12 +10493,14 @@ for batch in client.beta.messages.batches.results( Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -12201,12 +12295,14 @@ for batch in client.beta.messages.batches.results( Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. diff --git a/content/en/api/python/beta/messages/batches/cancel.md b/content/en/api/python/beta/messages/batches/cancel.md index 9d524c8a4..ac734b24a 100644 --- a/content/en/api/python/beta/messages/batches/cancel.md +++ b/content/en/api/python/beta/messages/batches/cancel.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaMessageBatch: …` diff --git a/content/en/api/python/beta/messages/batches/create.md b/content/en/api/python/beta/messages/batches/create.md index 6516df7d0..52cf595dc 100644 --- a/content/en/api/python/beta/messages/batches/create.md +++ b/content/en/api/python/beta/messages/batches/create.md @@ -1722,7 +1722,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1730,6 +1730,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -1738,7 +1740,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1746,6 +1748,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `Literal["default"]` - `inference_geo: Optional[str]` @@ -3801,7 +3805,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3871,6 +3875,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. diff --git a/content/en/api/python/beta/messages/batches/delete.md b/content/en/api/python/beta/messages/batches/delete.md index e2e7dd2d3..f532421f0 100644 --- a/content/en/api/python/beta/messages/batches/delete.md +++ b/content/en/api/python/beta/messages/batches/delete.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaDeletedMessageBatch: …` diff --git a/content/en/api/python/beta/messages/batches/list.md b/content/en/api/python/beta/messages/batches/list.md index 021e925cb..18e17f3aa 100644 --- a/content/en/api/python/beta/messages/batches/list.md +++ b/content/en/api/python/beta/messages/batches/list.md @@ -32,7 +32,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaMessageBatch: …` diff --git a/content/en/api/python/beta/messages/batches/results.md b/content/en/api/python/beta/messages/batches/results.md index afa03bc73..c31ccb7cf 100644 --- a/content/en/api/python/beta/messages/batches/results.md +++ b/content/en/api/python/beta/messages/batches/results.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaMessageBatchIndividualResponse: …` @@ -1543,12 +1557,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. diff --git a/content/en/api/python/beta/messages/batches/retrieve.md b/content/en/api/python/beta/messages/batches/retrieve.md index b9b49962c..4051575dd 100644 --- a/content/en/api/python/beta/messages/batches/retrieve.md +++ b/content/en/api/python/beta/messages/batches/retrieve.md @@ -20,7 +20,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaMessageBatch: …` diff --git a/content/en/api/python/beta/messages/count_tokens.md b/content/en/api/python/beta/messages/count_tokens.md index 8176386e1..165bbbf30 100644 --- a/content/en/api/python/beta/messages/count_tokens.md +++ b/content/en/api/python/beta/messages/count_tokens.md @@ -1626,7 +1626,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1634,6 +1634,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -1642,7 +1644,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1650,6 +1652,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice: Optional[BetaToolChoiceParam]` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -3595,7 +3599,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3665,6 +3669,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. diff --git a/content/en/api/python/beta/messages/create.md b/content/en/api/python/beta/messages/create.md index e4205f432..13fbf57d8 100644 --- a/content/en/api/python/beta/messages/create.md +++ b/content/en/api/python/beta/messages/create.md @@ -1702,7 +1702,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: Literal["enabled"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1710,6 +1710,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `class BetaThinkingConfigDisabled: …` - `type: Literal["disabled"]` @@ -1718,7 +1720,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: Literal["adaptive"]` - - `display: Optional[Literal["summarized", "omitted"]]` + - `display: Optional[Literal["summarized", "omitted", "updates"]]` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1726,6 +1728,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `Literal["default"]` - `inference_geo: Optional[str]` @@ -3781,7 +3785,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3851,6 +3855,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id: Optional[str]` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5296,12 +5314,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage: …` Token usage for a sampling iteration. @@ -5611,12 +5631,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: int` The cumulative number of output tokens which were used. diff --git a/content/en/api/python/beta/models.md b/content/en/api/python/beta/models.md index 07da1de4f..57fb2609b 100644 --- a/content/en/api/python/beta/models.md +++ b/content/en/api/python/beta/models.md @@ -34,7 +34,7 @@ The Models API response can be used to determine which models are available for - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaModelInfo: …` @@ -364,7 +378,7 @@ The Models API response can be used to determine information about a specific mo - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -434,6 +448,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaModelInfo: …` diff --git a/content/en/api/python/beta/models/list.md b/content/en/api/python/beta/models/list.md index 013044a6b..e7be67e32 100644 --- a/content/en/api/python/beta/models/list.md +++ b/content/en/api/python/beta/models/list.md @@ -32,7 +32,7 @@ The Models API response can be used to determine which models are available for - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaModelInfo: …` diff --git a/content/en/api/python/beta/models/retrieve.md b/content/en/api/python/beta/models/retrieve.md index 0a223c252..2f4de56e5 100644 --- a/content/en/api/python/beta/models/retrieve.md +++ b/content/en/api/python/beta/models/retrieve.md @@ -20,7 +20,7 @@ The Models API response can be used to determine information about a specific mo - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaModelInfo: …` diff --git a/content/en/api/python/beta/sessions.md b/content/en/api/python/beta/sessions.md index e8b4ed210..e328a0d3a 100644 --- a/content/en/api/python/beta/sessions.md +++ b/content/en/api/python/beta/sessions.md @@ -1012,7 +1012,7 @@ Create Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1082,6 +1082,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession: …` @@ -2234,7 +2248,7 @@ List Sessions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2304,6 +2318,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession: …` @@ -3386,7 +3414,7 @@ Get Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3456,6 +3484,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession: …` @@ -4971,7 +5013,7 @@ Update Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -5041,6 +5083,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession: …` @@ -6118,7 +6174,7 @@ Delete Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -6188,6 +6244,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedSession: …` @@ -6242,7 +6312,7 @@ Archive Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -6312,6 +6382,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession: …` @@ -11977,7 +12061,7 @@ List Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -12047,6 +12131,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent` @@ -14619,7 +14717,7 @@ Send Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -14689,6 +14787,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSendSessionEvents: …` @@ -15209,7 +15321,7 @@ Stream Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -15279,6 +15391,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionEvents` @@ -17544,7 +17670,7 @@ Add Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -17614,6 +17740,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsFileResource: …` @@ -17698,7 +17838,7 @@ List Session Resources - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -17768,6 +17908,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionResource` @@ -17944,7 +18098,7 @@ Get Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -18014,6 +18168,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `ResourceRetrieveResponse` @@ -18183,7 +18351,7 @@ Update Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -18253,6 +18421,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `ResourceUpdateResponse` @@ -18417,7 +18599,7 @@ Delete Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -18487,6 +18669,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeleteSessionResource: …` @@ -18554,7 +18750,7 @@ List Session Threads - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -18624,6 +18820,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread: …` @@ -18636,7 +18846,7 @@ List Session Threads - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -19402,7 +19612,7 @@ Get Session Thread - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -19472,6 +19682,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread: …` @@ -19484,7 +19708,7 @@ Get Session Thread - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -20245,7 +20469,7 @@ Archive Session Thread - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -20315,6 +20539,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread: …` @@ -20327,7 +20565,7 @@ Archive Session Thread - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -21100,7 +21338,7 @@ List Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -21170,6 +21408,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent` @@ -23380,7 +23632,7 @@ Stream Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -23450,6 +23702,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents` diff --git a/content/en/api/python/beta/sessions/archive.md b/content/en/api/python/beta/sessions/archive.md index d3459767c..187ac75ad 100644 --- a/content/en/api/python/beta/sessions/archive.md +++ b/content/en/api/python/beta/sessions/archive.md @@ -16,7 +16,7 @@ Archive Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession: …` diff --git a/content/en/api/python/beta/sessions/create.md b/content/en/api/python/beta/sessions/create.md index 060b8a85a..fb4b7428d 100644 --- a/content/en/api/python/beta/sessions/create.md +++ b/content/en/api/python/beta/sessions/create.md @@ -1010,7 +1010,7 @@ Create Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1080,6 +1080,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession: …` diff --git a/content/en/api/python/beta/sessions/delete.md b/content/en/api/python/beta/sessions/delete.md index 4fc164b27..d11f6dea2 100644 --- a/content/en/api/python/beta/sessions/delete.md +++ b/content/en/api/python/beta/sessions/delete.md @@ -16,7 +16,7 @@ Delete Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedSession: …` diff --git a/content/en/api/python/beta/sessions/events.md b/content/en/api/python/beta/sessions/events.md index 52a805291..e2af0ed18 100644 --- a/content/en/api/python/beta/sessions/events.md +++ b/content/en/api/python/beta/sessions/events.md @@ -64,7 +64,7 @@ List Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -134,6 +134,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionEvent` @@ -2706,7 +2720,7 @@ Send Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2776,6 +2790,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSendSessionEvents: …` @@ -3296,7 +3324,7 @@ Stream Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -3366,6 +3394,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionEvents` diff --git a/content/en/api/python/beta/sessions/events/list.md b/content/en/api/python/beta/sessions/events/list.md index 7bb66eab2..281beed18 100644 --- a/content/en/api/python/beta/sessions/events/list.md +++ b/content/en/api/python/beta/sessions/events/list.md @@ -62,7 +62,7 @@ List Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -132,6 +132,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionEvent` diff --git a/content/en/api/python/beta/sessions/events/send.md b/content/en/api/python/beta/sessions/events/send.md index c76fcbf8f..550dbe36a 100644 --- a/content/en/api/python/beta/sessions/events/send.md +++ b/content/en/api/python/beta/sessions/events/send.md @@ -378,7 +378,7 @@ Send Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -448,6 +448,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSendSessionEvents: …` diff --git a/content/en/api/python/beta/sessions/events/stream.md b/content/en/api/python/beta/sessions/events/stream.md index 08e56fb4e..d3d49f39b 100644 --- a/content/en/api/python/beta/sessions/events/stream.md +++ b/content/en/api/python/beta/sessions/events/stream.md @@ -24,7 +24,7 @@ Stream Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsStreamSessionEvents` diff --git a/content/en/api/python/beta/sessions/list.md b/content/en/api/python/beta/sessions/list.md index 91fbefd46..fd20cfe4c 100644 --- a/content/en/api/python/beta/sessions/list.md +++ b/content/en/api/python/beta/sessions/list.md @@ -90,7 +90,7 @@ List Sessions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -160,6 +160,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession: …` diff --git a/content/en/api/python/beta/sessions/resources.md b/content/en/api/python/beta/sessions/resources.md index 09c5877ef..12c3b8240 100644 --- a/content/en/api/python/beta/sessions/resources.md +++ b/content/en/api/python/beta/sessions/resources.md @@ -32,7 +32,7 @@ Add Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsFileResource: …` @@ -186,7 +200,7 @@ List Session Resources - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -256,6 +270,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionResource` @@ -432,7 +460,7 @@ Get Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -502,6 +530,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `ResourceRetrieveResponse` @@ -671,7 +713,7 @@ Update Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -741,6 +783,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `ResourceUpdateResponse` @@ -905,7 +961,7 @@ Delete Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -975,6 +1031,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeleteSessionResource: …` diff --git a/content/en/api/python/beta/sessions/resources/add.md b/content/en/api/python/beta/sessions/resources/add.md index 670d9a6e7..45a7e87f2 100644 --- a/content/en/api/python/beta/sessions/resources/add.md +++ b/content/en/api/python/beta/sessions/resources/add.md @@ -30,7 +30,7 @@ Add Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsFileResource: …` diff --git a/content/en/api/python/beta/sessions/resources/delete.md b/content/en/api/python/beta/sessions/resources/delete.md index 7dc34cea5..8bd5a04da 100644 --- a/content/en/api/python/beta/sessions/resources/delete.md +++ b/content/en/api/python/beta/sessions/resources/delete.md @@ -18,7 +18,7 @@ Delete Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeleteSessionResource: …` diff --git a/content/en/api/python/beta/sessions/resources/list.md b/content/en/api/python/beta/sessions/resources/list.md index 441ac7c52..feafc0f6c 100644 --- a/content/en/api/python/beta/sessions/resources/list.md +++ b/content/en/api/python/beta/sessions/resources/list.md @@ -26,7 +26,7 @@ List Session Resources - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionResource` diff --git a/content/en/api/python/beta/sessions/resources/retrieve.md b/content/en/api/python/beta/sessions/resources/retrieve.md index 6b3d4cfb3..8a493d848 100644 --- a/content/en/api/python/beta/sessions/resources/retrieve.md +++ b/content/en/api/python/beta/sessions/resources/retrieve.md @@ -18,7 +18,7 @@ Get Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `ResourceRetrieveResponse` diff --git a/content/en/api/python/beta/sessions/resources/update.md b/content/en/api/python/beta/sessions/resources/update.md index 26ce80765..04c521c9f 100644 --- a/content/en/api/python/beta/sessions/resources/update.md +++ b/content/en/api/python/beta/sessions/resources/update.md @@ -24,7 +24,7 @@ Update Session Resource - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `ResourceUpdateResponse` diff --git a/content/en/api/python/beta/sessions/retrieve.md b/content/en/api/python/beta/sessions/retrieve.md index 65711819d..46cb75b20 100644 --- a/content/en/api/python/beta/sessions/retrieve.md +++ b/content/en/api/python/beta/sessions/retrieve.md @@ -16,7 +16,7 @@ Get Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession: …` diff --git a/content/en/api/python/beta/sessions/threads.md b/content/en/api/python/beta/sessions/threads.md index 7d458aa92..7b4e46e10 100644 --- a/content/en/api/python/beta/sessions/threads.md +++ b/content/en/api/python/beta/sessions/threads.md @@ -28,7 +28,7 @@ List Session Threads - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSessionThread: …` @@ -110,7 +124,7 @@ List Session Threads - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -876,7 +890,7 @@ Get Session Thread - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -946,6 +960,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSessionThread: …` @@ -958,7 +986,7 @@ Get Session Thread - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -1719,7 +1747,7 @@ Archive Session Thread - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1789,6 +1817,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSessionThread: …` @@ -1801,7 +1843,7 @@ Archive Session Thread - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -2556,7 +2598,7 @@ print(beta_managed_agents_session_thread.id) - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` @@ -5528,7 +5570,7 @@ List Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -5598,6 +5640,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent` @@ -7808,7 +7864,7 @@ Stream Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -7878,6 +7934,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents` diff --git a/content/en/api/python/beta/sessions/threads/archive.md b/content/en/api/python/beta/sessions/threads/archive.md index c6f47fb57..572a5b89d 100644 --- a/content/en/api/python/beta/sessions/threads/archive.md +++ b/content/en/api/python/beta/sessions/threads/archive.md @@ -18,7 +18,7 @@ Archive Session Thread - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSessionThread: …` @@ -100,7 +114,7 @@ Archive Session Thread - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` diff --git a/content/en/api/python/beta/sessions/threads/events.md b/content/en/api/python/beta/sessions/threads/events.md index 276aad927..5648bf759 100644 --- a/content/en/api/python/beta/sessions/threads/events.md +++ b/content/en/api/python/beta/sessions/threads/events.md @@ -30,7 +30,7 @@ List Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionEvent` @@ -2310,7 +2324,7 @@ Stream Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2380,6 +2394,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionThreadEvents` diff --git a/content/en/api/python/beta/sessions/threads/events/list.md b/content/en/api/python/beta/sessions/threads/events/list.md index 412faca8d..253528f92 100644 --- a/content/en/api/python/beta/sessions/threads/events/list.md +++ b/content/en/api/python/beta/sessions/threads/events/list.md @@ -28,7 +28,7 @@ List Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionEvent` diff --git a/content/en/api/python/beta/sessions/threads/events/stream.md b/content/en/api/python/beta/sessions/threads/events/stream.md index 7d990f567..b5af795bf 100644 --- a/content/en/api/python/beta/sessions/threads/events/stream.md +++ b/content/en/api/python/beta/sessions/threads/events/stream.md @@ -26,7 +26,7 @@ Stream Session Thread Events - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsStreamSessionThreadEvents` diff --git a/content/en/api/python/beta/sessions/threads/list.md b/content/en/api/python/beta/sessions/threads/list.md index 25035999a..22953e4b8 100644 --- a/content/en/api/python/beta/sessions/threads/list.md +++ b/content/en/api/python/beta/sessions/threads/list.md @@ -26,7 +26,7 @@ List Session Threads - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSessionThread: …` @@ -108,7 +122,7 @@ List Session Threads - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` diff --git a/content/en/api/python/beta/sessions/threads/retrieve.md b/content/en/api/python/beta/sessions/threads/retrieve.md index df0c41ba1..4c56319a9 100644 --- a/content/en/api/python/beta/sessions/threads/retrieve.md +++ b/content/en/api/python/beta/sessions/threads/retrieve.md @@ -18,7 +18,7 @@ Get Session Thread - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSessionThread: …` @@ -100,7 +114,7 @@ Get Session Thread - `agent: Agent` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent: …` diff --git a/content/en/api/python/beta/sessions/update.md b/content/en/api/python/beta/sessions/update.md index f3f615b3a..412654e47 100644 --- a/content/en/api/python/beta/sessions/update.md +++ b/content/en/api/python/beta/sessions/update.md @@ -454,7 +454,7 @@ Update Session - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -524,6 +524,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession: …` diff --git a/content/en/api/python/beta/skills.md b/content/en/api/python/beta/skills.md index b2a7ea7ee..cf5b97544 100644 --- a/content/en/api/python/beta/skills.md +++ b/content/en/api/python/beta/skills.md @@ -28,7 +28,7 @@ Create Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class SkillCreateResponse: …` @@ -215,7 +229,7 @@ List Skills - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -285,6 +299,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class SkillListResponse: …` @@ -390,7 +418,7 @@ Get Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -460,6 +488,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class SkillRetrieveResponse: …` @@ -560,7 +602,7 @@ Delete Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -630,6 +672,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class SkillDeleteResponse: …` @@ -865,7 +921,7 @@ Create Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -935,6 +991,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class VersionCreateResponse: …` @@ -1050,7 +1120,7 @@ List Skill Versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1120,6 +1190,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class VersionListResponse: …` @@ -1237,7 +1321,7 @@ Download a skill version's content as a zip archive. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1307,6 +1391,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BinaryResponseContent` @@ -1359,7 +1457,7 @@ Get Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1429,6 +1527,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class VersionRetrieveResponse: …` @@ -1540,7 +1652,7 @@ Delete Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1610,6 +1722,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class VersionDeleteResponse: …` diff --git a/content/en/api/python/beta/skills/create.md b/content/en/api/python/beta/skills/create.md index bc16ab533..8ea5ee681 100644 --- a/content/en/api/python/beta/skills/create.md +++ b/content/en/api/python/beta/skills/create.md @@ -26,7 +26,7 @@ Create Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class SkillCreateResponse: …` diff --git a/content/en/api/python/beta/skills/delete.md b/content/en/api/python/beta/skills/delete.md index 89c7f7ac9..a98302a0b 100644 --- a/content/en/api/python/beta/skills/delete.md +++ b/content/en/api/python/beta/skills/delete.md @@ -20,7 +20,7 @@ Delete Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class SkillDeleteResponse: …` diff --git a/content/en/api/python/beta/skills/list.md b/content/en/api/python/beta/skills/list.md index c170f66e9..6995d180a 100644 --- a/content/en/api/python/beta/skills/list.md +++ b/content/en/api/python/beta/skills/list.md @@ -37,7 +37,7 @@ List Skills - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -107,6 +107,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class SkillListResponse: …` diff --git a/content/en/api/python/beta/skills/retrieve.md b/content/en/api/python/beta/skills/retrieve.md index e02efbb3d..8d70898fd 100644 --- a/content/en/api/python/beta/skills/retrieve.md +++ b/content/en/api/python/beta/skills/retrieve.md @@ -20,7 +20,7 @@ Get Skill - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class SkillRetrieveResponse: …` diff --git a/content/en/api/python/beta/skills/versions.md b/content/en/api/python/beta/skills/versions.md index f1709cdb3..035f7b93f 100644 --- a/content/en/api/python/beta/skills/versions.md +++ b/content/en/api/python/beta/skills/versions.md @@ -28,7 +28,7 @@ Create Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class VersionCreateResponse: …` @@ -213,7 +227,7 @@ List Skill Versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -283,6 +297,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class VersionListResponse: …` @@ -400,7 +428,7 @@ Download a skill version's content as a zip archive. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -470,6 +498,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BinaryResponseContent` @@ -522,7 +564,7 @@ Get Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -592,6 +634,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class VersionRetrieveResponse: …` @@ -703,7 +759,7 @@ Delete Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -773,6 +829,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class VersionDeleteResponse: …` diff --git a/content/en/api/python/beta/skills/versions/create.md b/content/en/api/python/beta/skills/versions/create.md index 575eb7458..8fe3d6a51 100644 --- a/content/en/api/python/beta/skills/versions/create.md +++ b/content/en/api/python/beta/skills/versions/create.md @@ -26,7 +26,7 @@ Create Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class VersionCreateResponse: …` diff --git a/content/en/api/python/beta/skills/versions/delete.md b/content/en/api/python/beta/skills/versions/delete.md index 145ed91d8..6d40e8212 100644 --- a/content/en/api/python/beta/skills/versions/delete.md +++ b/content/en/api/python/beta/skills/versions/delete.md @@ -26,7 +26,7 @@ Delete Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class VersionDeleteResponse: …` diff --git a/content/en/api/python/beta/skills/versions/download.md b/content/en/api/python/beta/skills/versions/download.md index 9564903e7..64caf8693 100644 --- a/content/en/api/python/beta/skills/versions/download.md +++ b/content/en/api/python/beta/skills/versions/download.md @@ -26,7 +26,7 @@ Download a skill version's content as a zip archive. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BinaryResponseContent` diff --git a/content/en/api/python/beta/skills/versions/list.md b/content/en/api/python/beta/skills/versions/list.md index b9f8094da..aadf042cd 100644 --- a/content/en/api/python/beta/skills/versions/list.md +++ b/content/en/api/python/beta/skills/versions/list.md @@ -30,7 +30,7 @@ List Skill Versions - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class VersionListResponse: …` diff --git a/content/en/api/python/beta/skills/versions/retrieve.md b/content/en/api/python/beta/skills/versions/retrieve.md index f5ee3deb6..2863f1ffe 100644 --- a/content/en/api/python/beta/skills/versions/retrieve.md +++ b/content/en/api/python/beta/skills/versions/retrieve.md @@ -26,7 +26,7 @@ Get Skill Version - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class VersionRetrieveResponse: …` diff --git a/content/en/api/python/beta/tunnels.md b/content/en/api/python/beta/tunnels.md index b25746550..406bcbaa2 100644 --- a/content/en/api/python/beta/tunnels.md +++ b/content/en/api/python/beta/tunnels.md @@ -24,7 +24,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnel: …` @@ -174,7 +188,7 @@ Fetches a tunnel by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -244,6 +258,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnel: …` @@ -338,7 +366,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -408,6 +436,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnel: …` @@ -494,7 +536,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -564,6 +606,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnel: …` @@ -646,7 +702,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -716,6 +772,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelToken: …` @@ -785,7 +855,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -855,6 +925,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelToken: …` @@ -976,7 +1060,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1046,6 +1130,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelCertificate: …` @@ -1138,7 +1236,7 @@ Fetches a tunnel certificate by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1208,6 +1306,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelCertificate: …` @@ -1312,7 +1424,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1382,6 +1494,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelCertificate: …` @@ -1479,7 +1605,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1549,6 +1675,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelCertificate: …` diff --git a/content/en/api/python/beta/tunnels/archive.md b/content/en/api/python/beta/tunnels/archive.md index 49bba72e4..254d09608 100644 --- a/content/en/api/python/beta/tunnels/archive.md +++ b/content/en/api/python/beta/tunnels/archive.md @@ -18,7 +18,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnel: …` diff --git a/content/en/api/python/beta/tunnels/certificates.md b/content/en/api/python/beta/tunnels/certificates.md index 6264601c7..9b7deed0f 100644 --- a/content/en/api/python/beta/tunnels/certificates.md +++ b/content/en/api/python/beta/tunnels/certificates.md @@ -26,7 +26,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelCertificate: …` @@ -188,7 +202,7 @@ Fetches a tunnel certificate by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -258,6 +272,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelCertificate: …` @@ -362,7 +390,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -432,6 +460,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelCertificate: …` @@ -529,7 +571,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -599,6 +641,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelCertificate: …` diff --git a/content/en/api/python/beta/tunnels/certificates/archive.md b/content/en/api/python/beta/tunnels/certificates/archive.md index 7738ba326..48a83035e 100644 --- a/content/en/api/python/beta/tunnels/certificates/archive.md +++ b/content/en/api/python/beta/tunnels/certificates/archive.md @@ -20,7 +20,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelCertificate: …` diff --git a/content/en/api/python/beta/tunnels/certificates/create.md b/content/en/api/python/beta/tunnels/certificates/create.md index ee7882d95..923fd91f5 100644 --- a/content/en/api/python/beta/tunnels/certificates/create.md +++ b/content/en/api/python/beta/tunnels/certificates/create.md @@ -24,7 +24,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelCertificate: …` diff --git a/content/en/api/python/beta/tunnels/certificates/list.md b/content/en/api/python/beta/tunnels/certificates/list.md index 4c40eeb24..261742fe3 100644 --- a/content/en/api/python/beta/tunnels/certificates/list.md +++ b/content/en/api/python/beta/tunnels/certificates/list.md @@ -32,7 +32,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelCertificate: …` diff --git a/content/en/api/python/beta/tunnels/certificates/retrieve.md b/content/en/api/python/beta/tunnels/certificates/retrieve.md index dd989686d..67a2fbc79 100644 --- a/content/en/api/python/beta/tunnels/certificates/retrieve.md +++ b/content/en/api/python/beta/tunnels/certificates/retrieve.md @@ -20,7 +20,7 @@ Fetches a tunnel certificate by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelCertificate: …` diff --git a/content/en/api/python/beta/tunnels/create.md b/content/en/api/python/beta/tunnels/create.md index 55ece2884..65f8154d8 100644 --- a/content/en/api/python/beta/tunnels/create.md +++ b/content/en/api/python/beta/tunnels/create.md @@ -22,7 +22,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnel: …` diff --git a/content/en/api/python/beta/tunnels/list.md b/content/en/api/python/beta/tunnels/list.md index bab8f2396..fd4fbedfe 100644 --- a/content/en/api/python/beta/tunnels/list.md +++ b/content/en/api/python/beta/tunnels/list.md @@ -30,7 +30,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnel: …` diff --git a/content/en/api/python/beta/tunnels/retrieve.md b/content/en/api/python/beta/tunnels/retrieve.md index 674408bdd..247f10d93 100644 --- a/content/en/api/python/beta/tunnels/retrieve.md +++ b/content/en/api/python/beta/tunnels/retrieve.md @@ -18,7 +18,7 @@ Fetches a tunnel by ID. - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnel: …` diff --git a/content/en/api/python/beta/tunnels/reveal_token.md b/content/en/api/python/beta/tunnels/reveal_token.md index a66a397c4..1b7e03068 100644 --- a/content/en/api/python/beta/tunnels/reveal_token.md +++ b/content/en/api/python/beta/tunnels/reveal_token.md @@ -18,7 +18,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelToken: …` diff --git a/content/en/api/python/beta/tunnels/rotate_token.md b/content/en/api/python/beta/tunnels/rotate_token.md index d4e0f8af7..cb11510b3 100644 --- a/content/en/api/python/beta/tunnels/rotate_token.md +++ b/content/en/api/python/beta/tunnels/rotate_token.md @@ -24,7 +24,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelToken: …` diff --git a/content/en/api/python/beta/user_profiles.md b/content/en/api/python/beta/user_profiles.md index 35e8e5aa6..bc31a36bb 100644 --- a/content/en/api/python/beta/user_profiles.md +++ b/content/en/api/python/beta/user_profiles.md @@ -50,7 +50,7 @@ Create User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -120,6 +120,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfile: …` @@ -258,7 +272,7 @@ List User Profiles - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -328,6 +342,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfile: …` @@ -456,7 +484,7 @@ Get User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -526,6 +554,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfile: …` @@ -684,7 +726,7 @@ Update User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -754,6 +796,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfile: …` @@ -878,7 +934,7 @@ Create Enrollment URL - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -948,6 +1004,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfileEnrollmentURL: …` diff --git a/content/en/api/python/beta/user_profiles/create.md b/content/en/api/python/beta/user_profiles/create.md index afe102ec9..58dcacdb6 100644 --- a/content/en/api/python/beta/user_profiles/create.md +++ b/content/en/api/python/beta/user_profiles/create.md @@ -48,7 +48,7 @@ Create User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -118,6 +118,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfile: …` diff --git a/content/en/api/python/beta/user_profiles/create_enrollment_url.md b/content/en/api/python/beta/user_profiles/create_enrollment_url.md index ca9c8f803..28f9ec55a 100644 --- a/content/en/api/python/beta/user_profiles/create_enrollment_url.md +++ b/content/en/api/python/beta/user_profiles/create_enrollment_url.md @@ -16,7 +16,7 @@ Create Enrollment URL - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfileEnrollmentURL: …` diff --git a/content/en/api/python/beta/user_profiles/list.md b/content/en/api/python/beta/user_profiles/list.md index c349bfc99..f35e26450 100644 --- a/content/en/api/python/beta/user_profiles/list.md +++ b/content/en/api/python/beta/user_profiles/list.md @@ -32,7 +32,7 @@ List User Profiles - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfile: …` diff --git a/content/en/api/python/beta/user_profiles/retrieve.md b/content/en/api/python/beta/user_profiles/retrieve.md index 73412665c..2a1ae841f 100644 --- a/content/en/api/python/beta/user_profiles/retrieve.md +++ b/content/en/api/python/beta/user_profiles/retrieve.md @@ -16,7 +16,7 @@ Get User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfile: …` diff --git a/content/en/api/python/beta/user_profiles/update.md b/content/en/api/python/beta/user_profiles/update.md index b6aae00b0..50b1995ea 100644 --- a/content/en/api/python/beta/user_profiles/update.md +++ b/content/en/api/python/beta/user_profiles/update.md @@ -50,7 +50,7 @@ Update User Profile - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -120,6 +120,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfile: …` diff --git a/content/en/api/python/beta/vaults.md b/content/en/api/python/beta/vaults.md index 748e71942..d6cd06863 100644 --- a/content/en/api/python/beta/vaults.md +++ b/content/en/api/python/beta/vaults.md @@ -26,7 +26,7 @@ Create Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault: …` @@ -197,7 +211,7 @@ List Vaults - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -267,6 +281,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault: …` @@ -360,7 +388,7 @@ Get Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -430,6 +458,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault: …` @@ -529,7 +571,7 @@ Update Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -599,6 +641,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault: …` @@ -688,7 +744,7 @@ Delete Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -758,6 +814,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedVault: …` @@ -814,7 +884,7 @@ Archive Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -884,6 +954,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault: …` @@ -1201,7 +1285,7 @@ Create Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1271,6 +1355,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -1502,7 +1600,7 @@ List Credentials - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1572,6 +1670,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -1792,7 +1904,7 @@ Get Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1862,6 +1974,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -2209,7 +2335,7 @@ Update Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2279,6 +2405,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -2494,7 +2634,7 @@ Delete Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2564,6 +2704,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedCredential: …` @@ -2623,7 +2777,7 @@ Archive Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2693,6 +2847,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential: …` @@ -2908,7 +3076,7 @@ Validate Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -2978,6 +3146,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredentialValidation: …` diff --git a/content/en/api/python/beta/vaults/archive.md b/content/en/api/python/beta/vaults/archive.md index 0821f705d..99aa405fd 100644 --- a/content/en/api/python/beta/vaults/archive.md +++ b/content/en/api/python/beta/vaults/archive.md @@ -16,7 +16,7 @@ Archive Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault: …` diff --git a/content/en/api/python/beta/vaults/create.md b/content/en/api/python/beta/vaults/create.md index d5825f17a..edb9fbcc8 100644 --- a/content/en/api/python/beta/vaults/create.md +++ b/content/en/api/python/beta/vaults/create.md @@ -24,7 +24,7 @@ Create Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault: …` diff --git a/content/en/api/python/beta/vaults/credentials.md b/content/en/api/python/beta/vaults/credentials.md index ca1166b13..937b2e60c 100644 --- a/content/en/api/python/beta/vaults/credentials.md +++ b/content/en/api/python/beta/vaults/credentials.md @@ -192,7 +192,7 @@ Create Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -262,6 +262,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential: …` @@ -493,7 +507,7 @@ List Credentials - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -563,6 +577,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential: …` @@ -783,7 +811,7 @@ Get Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -853,6 +881,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential: …` @@ -1200,7 +1242,7 @@ Update Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1270,6 +1312,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential: …` @@ -1485,7 +1541,7 @@ Delete Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1555,6 +1611,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedCredential: …` @@ -1614,7 +1684,7 @@ Archive Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1684,6 +1754,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential: …` @@ -1899,7 +1983,7 @@ Validate Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -1969,6 +2053,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredentialValidation: …` diff --git a/content/en/api/python/beta/vaults/credentials/archive.md b/content/en/api/python/beta/vaults/credentials/archive.md index ba395cf23..29ac4d094 100644 --- a/content/en/api/python/beta/vaults/credentials/archive.md +++ b/content/en/api/python/beta/vaults/credentials/archive.md @@ -18,7 +18,7 @@ Archive Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential: …` diff --git a/content/en/api/python/beta/vaults/credentials/create.md b/content/en/api/python/beta/vaults/credentials/create.md index f11af5f5b..0f5b017d6 100644 --- a/content/en/api/python/beta/vaults/credentials/create.md +++ b/content/en/api/python/beta/vaults/credentials/create.md @@ -190,7 +190,7 @@ Create Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -260,6 +260,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential: …` diff --git a/content/en/api/python/beta/vaults/credentials/delete.md b/content/en/api/python/beta/vaults/credentials/delete.md index d6cede78c..35d3ae1e8 100644 --- a/content/en/api/python/beta/vaults/credentials/delete.md +++ b/content/en/api/python/beta/vaults/credentials/delete.md @@ -18,7 +18,7 @@ Delete Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedCredential: …` diff --git a/content/en/api/python/beta/vaults/credentials/list.md b/content/en/api/python/beta/vaults/credentials/list.md index 296a9e467..1c5d1d47f 100644 --- a/content/en/api/python/beta/vaults/credentials/list.md +++ b/content/en/api/python/beta/vaults/credentials/list.md @@ -30,7 +30,7 @@ List Credentials - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential: …` diff --git a/content/en/api/python/beta/vaults/credentials/mcp_oauth_validate.md b/content/en/api/python/beta/vaults/credentials/mcp_oauth_validate.md index b05967ff4..9cc20b32b 100644 --- a/content/en/api/python/beta/vaults/credentials/mcp_oauth_validate.md +++ b/content/en/api/python/beta/vaults/credentials/mcp_oauth_validate.md @@ -18,7 +18,7 @@ Validate Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredentialValidation: …` diff --git a/content/en/api/python/beta/vaults/credentials/retrieve.md b/content/en/api/python/beta/vaults/credentials/retrieve.md index 7dd37ecda..38e6c2c68 100644 --- a/content/en/api/python/beta/vaults/credentials/retrieve.md +++ b/content/en/api/python/beta/vaults/credentials/retrieve.md @@ -18,7 +18,7 @@ Get Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential: …` diff --git a/content/en/api/python/beta/vaults/credentials/update.md b/content/en/api/python/beta/vaults/credentials/update.md index 00d60cf2f..bca5ed1b9 100644 --- a/content/en/api/python/beta/vaults/credentials/update.md +++ b/content/en/api/python/beta/vaults/credentials/update.md @@ -150,7 +150,7 @@ Update Credential - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -220,6 +220,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential: …` diff --git a/content/en/api/python/beta/vaults/delete.md b/content/en/api/python/beta/vaults/delete.md index ed76ca10b..91bd13019 100644 --- a/content/en/api/python/beta/vaults/delete.md +++ b/content/en/api/python/beta/vaults/delete.md @@ -16,7 +16,7 @@ Delete Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedVault: …` diff --git a/content/en/api/python/beta/vaults/list.md b/content/en/api/python/beta/vaults/list.md index 5cf706394..085215a6c 100644 --- a/content/en/api/python/beta/vaults/list.md +++ b/content/en/api/python/beta/vaults/list.md @@ -28,7 +28,7 @@ List Vaults - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault: …` diff --git a/content/en/api/python/beta/vaults/retrieve.md b/content/en/api/python/beta/vaults/retrieve.md index 3ef393417..c8c3e6f9c 100644 --- a/content/en/api/python/beta/vaults/retrieve.md +++ b/content/en/api/python/beta/vaults/retrieve.md @@ -16,7 +16,7 @@ Get Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault: …` diff --git a/content/en/api/python/beta/vaults/update.md b/content/en/api/python/beta/vaults/update.md index 96933726d..1ed38127c 100644 --- a/content/en/api/python/beta/vaults/update.md +++ b/content/en/api/python/beta/vaults/update.md @@ -26,7 +26,7 @@ Update Vault - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault: …` diff --git a/content/en/api/python/models.md b/content/en/api/python/models.md index 4592a0c09..ed061c413 100644 --- a/content/en/api/python/models.md +++ b/content/en/api/python/models.md @@ -34,7 +34,7 @@ The Models API response can be used to determine which models are available for - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class ModelInfo: …` @@ -357,7 +371,7 @@ The Models API response can be used to determine information about a specific mo - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -427,6 +441,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `class ModelInfo: …` diff --git a/content/en/api/python/models/list.md b/content/en/api/python/models/list.md index a9e4ee6d8..a214d2c75 100644 --- a/content/en/api/python/models/list.md +++ b/content/en/api/python/models/list.md @@ -32,7 +32,7 @@ The Models API response can be used to determine which models are available for - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class ModelInfo: …` diff --git a/content/en/api/python/models/retrieve.md b/content/en/api/python/models/retrieve.md index 92d30a65c..a561b506c 100644 --- a/content/en/api/python/models/retrieve.md +++ b/content/en/api/python/models/retrieve.md @@ -20,7 +20,7 @@ The Models API response can be used to determine information about a specific mo - `str` - - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 31 more]` + - `Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 38 more]` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `class ModelInfo: …` diff --git a/content/en/api/ruby/beta.md b/content/en/api/ruby/beta.md index 91010fb7e..0511d5c01 100644 --- a/content/en/api/ruby/beta.md +++ b/content/en/api/ruby/beta.md @@ -4,11 +4,11 @@ ### Anthropic Beta -- `AnthropicBeta = String | :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` +- `AnthropicBeta = String | :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -78,6 +78,20 @@ - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Beta API Error - `class BetaAPIError` @@ -326,7 +340,7 @@ The Models API response can be used to determine which models are available for - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -396,6 +410,20 @@ The Models API response can be used to determine which models are available for - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaModelInfo` @@ -650,7 +678,7 @@ The Models API response can be used to determine information about a specific mo - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -720,6 +748,20 @@ The Models API response can be used to determine information about a specific mo - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaModelInfo` @@ -2635,7 +2677,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -2643,6 +2685,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -2651,7 +2695,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -2659,6 +2703,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:omitted` + - `:updates` + - `BetaFallbacksParam = :default` - `inference_geo: String` @@ -4714,7 +4760,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4784,6 +4830,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -6125,12 +6185,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -6428,12 +6490,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: Integer` The cumulative number of output tokens which were used. @@ -8322,7 +8386,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -8330,6 +8394,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -8338,7 +8404,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -8346,6 +8412,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:omitted` + - `:updates` + - `tool_choice: BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -10291,7 +10359,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -10361,6 +10429,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -12125,7 +12207,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12133,6 +12215,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -12141,7 +12225,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12149,6 +12233,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:omitted` + - `:updates` + - `BetaFallbacksParam = :default` - `inference_geo: String` @@ -14248,7 +14334,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -14318,6 +14404,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -14484,7 +14584,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -14554,6 +14654,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch` @@ -14721,7 +14835,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -14791,6 +14905,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch` @@ -14955,7 +15083,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -15025,6 +15153,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch` @@ -15182,7 +15324,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -15252,6 +15394,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaDeletedMessageBatch` @@ -15311,7 +15467,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -15381,6 +15537,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatchIndividualResponse` @@ -16692,12 +16862,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -17685,7 +17857,7 @@ Create Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -17755,6 +17927,20 @@ Create Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent` @@ -18419,7 +18605,7 @@ List Agents - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -18489,6 +18675,20 @@ List Agents - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent` @@ -19137,7 +19337,7 @@ Get Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -19207,6 +19407,20 @@ Get Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent` @@ -20502,7 +20716,7 @@ Update Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -20572,6 +20786,20 @@ Update Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent` @@ -21209,7 +21437,7 @@ Archive Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -21279,6 +21507,20 @@ Archive Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent` @@ -21928,7 +22170,7 @@ List Agent Versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -21998,6 +22240,20 @@ List Agent Versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent` @@ -22684,7 +22940,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: bool` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Array[String]` @@ -22696,6 +22952,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Array[String]` Ubuntu/Debian packages to install @@ -22756,7 +23014,7 @@ Create a new environment with the specified configuration. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -22826,6 +23084,20 @@ Create a new environment with the specified configuration. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment` @@ -23047,7 +23319,7 @@ List environments with pagination support. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -23117,6 +23389,20 @@ List environments with pagination support. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment` @@ -23331,7 +23617,7 @@ Retrieve a specific environment by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -23401,6 +23687,20 @@ Retrieve a specific environment by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment` @@ -23648,7 +23948,7 @@ Update an existing environment's configuration. - `allow_package_managers: bool` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Array[String]` @@ -23660,6 +23960,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Array[String]` Ubuntu/Debian packages to install @@ -23726,7 +24028,7 @@ Update an existing environment's configuration. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -23796,6 +24098,20 @@ Update an existing environment's configuration. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment` @@ -24005,7 +24321,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -24075,6 +24391,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironmentDeleteResponse` @@ -24128,7 +24458,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -24198,6 +24528,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaEnvironment` @@ -24413,7 +24757,7 @@ Retrieve detailed information about a specific work item. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -24483,6 +24827,20 @@ Retrieve detailed information about a specific work item. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -24632,7 +24990,7 @@ Long poll for work items in the queue. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -24702,6 +25060,20 @@ Long poll for work items in the queue. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `anthropic_worker_id: String` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -24845,7 +25217,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -24915,6 +25287,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -25062,7 +25448,7 @@ Record a heartbeat for a work item to maintain the lease. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -25132,6 +25518,20 @@ Record a heartbeat for a work item to maintain the lease. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWorkHeartbeatResponse` @@ -25218,7 +25618,7 @@ Stop a work item, initiating graceful or forced shutdown. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -25288,6 +25688,20 @@ Stop a work item, initiating graceful or forced shutdown. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -25435,7 +25849,7 @@ List work items in an environment. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -25505,6 +25919,20 @@ List work items in an environment. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -25653,7 +26081,7 @@ Update work item metadata with merge semantics. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -25723,6 +26151,20 @@ Update work item metadata with merge semantics. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -25862,7 +26304,7 @@ Get statistics about the work queue for an environment. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -25932,6 +26374,20 @@ Get statistics about the work queue for an environment. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWorkQueueStats` @@ -26966,7 +27422,7 @@ Create Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -27036,6 +27492,20 @@ Create Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession` @@ -28171,7 +28641,7 @@ List Sessions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -28241,6 +28711,20 @@ List Sessions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession` @@ -29305,7 +29789,7 @@ Get Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -29375,6 +29859,20 @@ Get Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession` @@ -30871,7 +31369,7 @@ Update Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -30941,6 +31439,20 @@ Update Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession` @@ -31999,7 +32511,7 @@ Delete Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -32069,6 +32581,20 @@ Delete Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedSession` @@ -32118,7 +32644,7 @@ Archive Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -32188,6 +32714,20 @@ Archive Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSession` @@ -33294,7 +33834,7 @@ List Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -33364,6 +33904,20 @@ List Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -35916,7 +36470,7 @@ Send Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -35986,6 +36540,20 @@ Send Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSendSessionEvents` @@ -36493,7 +37061,7 @@ Stream Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -36563,6 +37131,20 @@ Stream Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` @@ -38809,7 +39391,7 @@ Add Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -38879,6 +39461,20 @@ Add Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsFileResource` @@ -38960,7 +39556,7 @@ List Session Resources - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -39030,6 +39626,20 @@ List Session Resources - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionResource = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -39200,7 +39810,7 @@ Get Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -39270,6 +39880,20 @@ Get Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `ResourceRetrieveResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -39436,7 +40060,7 @@ Update Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -39506,6 +40130,20 @@ Update Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `ResourceUpdateResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -39667,7 +40305,7 @@ Delete Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -39737,6 +40375,20 @@ Delete Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeleteSessionResource` @@ -39801,7 +40453,7 @@ List Session Threads - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -39871,6 +40523,20 @@ List Session Threads - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread` @@ -39883,7 +40549,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -40629,7 +41295,7 @@ Get Session Thread - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -40699,6 +41365,20 @@ Get Session Thread - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread` @@ -40711,7 +41391,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -41455,7 +42135,7 @@ Archive Session Thread - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -41525,6 +42205,20 @@ Archive Session Thread - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread` @@ -41537,7 +42231,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -42293,7 +42987,7 @@ List Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -42363,6 +43057,20 @@ List Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -44555,7 +45263,7 @@ Stream Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -44625,6 +45333,20 @@ Stream Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` @@ -47258,7 +47980,7 @@ Create Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -47328,6 +48050,20 @@ Create Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment` @@ -47982,7 +48718,7 @@ List Deployments - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -48052,6 +48788,20 @@ List Deployments - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment` @@ -48670,7 +49420,7 @@ Get Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -48740,6 +49490,20 @@ Get Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment` @@ -49753,7 +50517,7 @@ Update Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -49823,6 +50587,20 @@ Update Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment` @@ -50436,7 +51214,7 @@ Archive Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -50506,6 +51284,20 @@ Archive Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment` @@ -51119,7 +51911,7 @@ Run Deployment Now - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -51189,6 +51981,20 @@ Run Deployment Now - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeploymentRun` @@ -51468,7 +52274,7 @@ Pause Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -51538,6 +52344,20 @@ Pause Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment` @@ -52151,7 +52971,7 @@ Unpause Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -52221,6 +53041,20 @@ Unpause Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeployment` @@ -52884,7 +53718,7 @@ List Deployment Runs - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -52954,6 +53788,20 @@ List Deployment Runs - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeploymentRun` @@ -53238,7 +54086,7 @@ Get Deployment Run - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -53308,6 +54156,20 @@ Get Deployment Run - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeploymentRun` @@ -53597,7 +54459,7 @@ Create Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -53667,6 +54529,20 @@ Create Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault` @@ -53763,7 +54639,7 @@ List Vaults - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -53833,6 +54709,20 @@ List Vaults - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault` @@ -53922,7 +54812,7 @@ Get Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -53992,6 +54882,20 @@ Get Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault` @@ -54086,7 +54990,7 @@ Update Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -54156,6 +55060,20 @@ Update Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault` @@ -54240,7 +55158,7 @@ Delete Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -54310,6 +55228,20 @@ Delete Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedVault` @@ -54361,7 +55293,7 @@ Archive Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -54431,6 +55363,20 @@ Archive Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsVault` @@ -54691,7 +55637,7 @@ Create Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -54761,6 +55707,20 @@ Create Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -54989,7 +55949,7 @@ List Credentials - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -55059,6 +56019,20 @@ List Credentials - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -55273,7 +56247,7 @@ Get Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -55343,6 +56317,20 @@ Get Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -55687,7 +56675,7 @@ Update Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -55757,6 +56745,20 @@ Update Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -55969,7 +56971,7 @@ Delete Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -56039,6 +57041,20 @@ Delete Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedCredential` @@ -56095,7 +57111,7 @@ Archive Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -56165,6 +57181,20 @@ Archive Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -56377,7 +57407,7 @@ Validate Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -56447,6 +57477,20 @@ Validate Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredentialValidation` @@ -56613,7 +57657,7 @@ Create a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -56683,6 +57727,20 @@ Create a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore` @@ -56796,7 +57854,7 @@ List memory stores - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -56866,6 +57924,20 @@ List memory stores - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore` @@ -56960,7 +58032,7 @@ Retrieve a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -57030,6 +58102,20 @@ Retrieve a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore` @@ -57135,7 +58221,7 @@ Update a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -57205,6 +58291,20 @@ Update a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore` @@ -57294,7 +58394,7 @@ Delete a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -57364,6 +58464,20 @@ Delete a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedMemoryStore` @@ -57415,7 +58529,7 @@ Archive a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -57485,6 +58599,20 @@ Archive a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryStore` @@ -57594,7 +58722,7 @@ Create a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -57664,6 +58792,20 @@ Create a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory` @@ -57696,7 +58838,7 @@ Create a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -57789,7 +58931,7 @@ List memories - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -57859,6 +59001,20 @@ List memories - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryListItem = BetaManagedAgentsMemory | BetaManagedAgentsMemoryPrefix` @@ -57895,7 +59051,7 @@ List memories - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -57985,7 +59141,7 @@ Retrieve a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -58055,6 +59211,20 @@ Retrieve a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory` @@ -58087,7 +59257,7 @@ Retrieve a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -58182,7 +59352,7 @@ Update a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -58252,6 +59422,20 @@ Update a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory` @@ -58284,7 +59468,7 @@ Update a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -58355,7 +59539,7 @@ Delete a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -58425,11 +59609,25 @@ Delete a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: String` @@ -58534,7 +59732,7 @@ List memory versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -58604,11 +59802,25 @@ List memory versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -58622,7 +59834,7 @@ List memory versions - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` @@ -58791,7 +60003,7 @@ Retrieve a memory version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -58861,11 +60073,25 @@ Retrieve a memory version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -58879,7 +60105,7 @@ Retrieve a memory version - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` @@ -59038,7 +60264,7 @@ Redact a memory version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -59108,11 +60334,25 @@ Redact a memory version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -59126,7 +60366,7 @@ Redact a memory version - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` @@ -59289,7 +60529,7 @@ Upload File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -59359,6 +60599,20 @@ Upload File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaFileMetadata` @@ -59481,7 +60735,7 @@ List Files - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -59551,6 +60805,20 @@ List Files - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaFileMetadata` @@ -59664,7 +60932,7 @@ Download File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -59734,6 +61002,20 @@ Download File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `StringIO` @@ -59770,7 +61052,7 @@ Get File Metadata - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -59840,6 +61122,20 @@ Get File Metadata - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaFileMetadata` @@ -59946,7 +61242,7 @@ Delete File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -60016,6 +61312,20 @@ Delete File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaDeletedFile` @@ -60081,7 +61391,7 @@ Create Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -60151,6 +61461,20 @@ Create Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class SkillCreateResponse` @@ -60259,7 +61583,7 @@ List Skills - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -60329,6 +61653,20 @@ List Skills - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class SkillListResponse` @@ -60428,7 +61766,7 @@ Get Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -60498,6 +61836,20 @@ Get Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class SkillRetrieveResponse` @@ -60591,7 +61943,7 @@ Delete Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -60661,6 +62013,20 @@ Delete Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class SkillDeleteResponse` @@ -60728,7 +62094,7 @@ Create Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -60798,6 +62164,20 @@ Create Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class VersionCreateResponse` @@ -60905,7 +62285,7 @@ List Skill Versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -60975,6 +62355,20 @@ List Skill Versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class VersionListResponse` @@ -61084,7 +62478,7 @@ Download a skill version's content as a zip archive. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -61154,6 +62548,20 @@ Download a skill version's content as a zip archive. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `StringIO` @@ -61198,7 +62606,7 @@ Get Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -61268,6 +62676,20 @@ Get Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class VersionRetrieveResponse` @@ -61371,7 +62793,7 @@ Delete Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -61441,6 +62863,20 @@ Delete Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class VersionDeleteResponse` @@ -61548,7 +62984,7 @@ Create User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -61618,6 +63054,20 @@ Create User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfile` @@ -61753,7 +63203,7 @@ List User Profiles - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -61823,6 +63273,20 @@ List User Profiles - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfile` @@ -61947,7 +63411,7 @@ Get User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -62017,6 +63481,20 @@ Get User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfile` @@ -62170,7 +63648,7 @@ Update User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -62240,6 +63718,20 @@ Update User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfile` @@ -62359,7 +63851,7 @@ Create Enrollment URL - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -62429,6 +63921,20 @@ Create Enrollment URL - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaUserProfileEnrollmentURL` @@ -62555,7 +64061,7 @@ Create a Dream - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -62625,6 +64131,20 @@ Create a Dream - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream` @@ -62883,7 +64403,7 @@ List Dreams - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -62953,6 +64473,20 @@ List Dreams - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream` @@ -63178,7 +64712,7 @@ Get a Dream - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -63248,6 +64782,20 @@ Get a Dream - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream` @@ -63468,7 +65016,7 @@ Cancel a Dream - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -63538,6 +65086,20 @@ Cancel a Dream - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream` @@ -63758,7 +65320,7 @@ Archive a Dream - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -63828,6 +65390,20 @@ Archive a Dream - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaDream` @@ -64056,7 +65632,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -64126,6 +65702,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnel` @@ -64203,7 +65793,7 @@ Fetches a tunnel by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -64273,6 +65863,20 @@ Fetches a tunnel by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnel` @@ -64362,7 +65966,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -64432,6 +66036,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnel` @@ -64514,7 +66132,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -64584,6 +66202,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnel` @@ -64661,7 +66293,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -64731,6 +66363,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelToken` @@ -64795,7 +66441,9977 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelToken` + + A tunnel's connector token. + + - `id: String` + + Stable identifier for the current token value. Changes when the token is rotated. + + - `tunnel_token: String` + + The connector token used to run the tunnel. Treat as a credential. + + - `type: :tunnel_token` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_tunnel_token = anthropic.beta.tunnels.rotate_token("tunnel_id") + +puts(beta_tunnel_token) +``` + +##### Response (200) + +```json +{ + "id": "id", + "tunnel_token": "tunnel_token", + "type": "tunnel_token" +} +``` + +## Beta › Tunnels › Certificates + +### Create Tunnel Certificate + +`beta.tunnels.certificates.create(tunnel_id, **kwargs) -> BetaTunnelCertificate` + +**POST** `/v1/tunnels/{tunnel_id}/certificates` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. A tunnel holds at most two non-archived certificates. + +#### Parameters + +- `tunnel_id: String` + +- `ca_certificate_pem: String` + + PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. + + maxLength: 8192 + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelCertificate` + + A CA certificate attached to a tunnel. + + - `id: String` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: String` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: String` + + ID of the tunnel the certificate is registered against. + + - `type: :tunnel_certificate` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_tunnel_certificate = anthropic.beta.tunnels.certificates.create("tunnel_id", ca_certificate_pem: "ca_certificate_pem") + +puts(beta_tunnel_certificate) +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### Get Tunnel Certificate + +`beta.tunnels.certificates.retrieve(certificate_id, **kwargs) -> BetaTunnelCertificate` + +**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Fetches a tunnel certificate by ID. + +#### Parameters + +- `tunnel_id: String` + +- `certificate_id: String` + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelCertificate` + + A CA certificate attached to a tunnel. + + - `id: String` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: String` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: String` + + ID of the tunnel the certificate is registered against. + + - `type: :tunnel_certificate` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_tunnel_certificate = anthropic.beta.tunnels.certificates.retrieve("certificate_id", tunnel_id: "tunnel_id") + +puts(beta_tunnel_certificate) +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### List Tunnel Certificates + +`beta.tunnels.certificates.list(tunnel_id, **kwargs) -> PageCursor` + +**GET** `/v1/tunnels/{tunnel_id}/certificates` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. + +#### Parameters + +- `tunnel_id: String` + +- `include_archived: bool` + + Whether to include archived certificates in the results. Defaults to false. + +- `limit: Integer` + + Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + + format: int32 + +- `page: String` + + Opaque pagination cursor from a previous `list_tunnel_certificates` response. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelCertificate` + + A CA certificate attached to a tunnel. + + - `id: String` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: String` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: String` + + ID of the tunnel the certificate is registered against. + + - `type: :tunnel_certificate` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.tunnels.certificates.list("tunnel_id") + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" + } + ], + "next_page": "next_page" +} +``` + +### Archive Tunnel Certificate + +`beta.tunnels.certificates.archive(certificate_id, **kwargs) -> BetaTunnelCertificate` + +**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. + +#### Parameters + +- `tunnel_id: String` + +- `certificate_id: String` + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaTunnelCertificate` + + A CA certificate attached to a tunnel. + + - `id: String` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: Time` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: String` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: String` + + ID of the tunnel the certificate is registered against. + + - `type: :tunnel_certificate` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_tunnel_certificate = anthropic.beta.tunnels.certificates.archive("certificate_id", tunnel_id: "tunnel_id") + +puts(beta_tunnel_certificate) +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +## Beta › Organization + +### Get Current Organization + +`beta.organization.retrieve() -> BetaOrganization` + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Returns + +- `class BetaOrganization` + + - `id: String` + + ID of the Organization. + + format: uuid + + - `name: String` + + Name of the Organization. + + - `type: :organization` + + Object type. + + For Organizations, this is always `"organization"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_organization = anthropic.beta.organization.retrieve + +puts(beta_organization) +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +`beta.organization.api_keys.list(**kwargs) -> Page` + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Parameters + +- `after_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `created_by_user_id: String` + + Filter by the ID of the User who created the object. + +- `limit: Integer` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +- `status: :active | :archived | :expired | :inactive` + + Filter by API key status. + + - `:active` + + - `:archived` + + - `:expired` + + - `:inactive` + +- `workspace_id: String` + + Filter by Workspace ID. + +#### Returns + +- `class BetaAPIKey` + + - `id: String` + + ID of the API key. + + - `created_at: Time` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: String` + + ID of the actor that created the object. + + - `type: :service_account | :user` + + Type of the actor that created the object. + + - `:service_account` + + - `:user` + + - `expires_at: Time` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: String` + + Name of the API key. + + - `partial_key_hint: String` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor | BetaAPIKeyServiceAccountActor` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaAPIKeyUserActor` + + - `type: :user_actor` + + Principal type. Always `"user_actor"` for a User. + + - `user_id: String` + + ID of the User the API key acts as. + + - `class BetaAPIKeyServiceAccountActor` + + - `service_account_id: String` + + ID of the Service Account the API key acts as. + + - `type: :service_account_actor` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `scope: BetaAPIKeyOrganizationScope | BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaAPIKeyOrganizationScope` + + - `type: :organization` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaAPIKeyWorkspaceScope` + + - `type: :workspace` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `workspace_id: String` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: :active | :archived | :expired | :inactive` + + Status of the API key. + + - `:active` + + - `:archived` + + - `:expired` + + - `:inactive` + + - `type: :api_key` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `workspace_id: String` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.api_keys.list + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +`beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey` + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Parameters + +- `api_key_id: String` + + ID of the API key. + +#### Returns + +- `class BetaAPIKey` + + - `id: String` + + ID of the API key. + + - `created_at: Time` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: String` + + ID of the actor that created the object. + + - `type: :service_account | :user` + + Type of the actor that created the object. + + - `:service_account` + + - `:user` + + - `expires_at: Time` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: String` + + Name of the API key. + + - `partial_key_hint: String` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor | BetaAPIKeyServiceAccountActor` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaAPIKeyUserActor` + + - `type: :user_actor` + + Principal type. Always `"user_actor"` for a User. + + - `user_id: String` + + ID of the User the API key acts as. + + - `class BetaAPIKeyServiceAccountActor` + + - `service_account_id: String` + + ID of the Service Account the API key acts as. + + - `type: :service_account_actor` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `scope: BetaAPIKeyOrganizationScope | BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaAPIKeyOrganizationScope` + + - `type: :organization` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaAPIKeyWorkspaceScope` + + - `type: :workspace` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `workspace_id: String` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: :active | :archived | :expired | :inactive` + + Status of the API key. + + - `:active` + + - `:archived` + + - `:expired` + + - `:inactive` + + - `type: :api_key` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `workspace_id: String` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_api_key = anthropic.beta.organization.api_keys.retrieve("api_key_id") + +puts(beta_api_key) +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +`beta.organization.api_keys.update(api_key_id, **kwargs) -> BetaAPIKey` + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Parameters + +- `api_key_id: String` + + ID of the API key. + +- `name: String` + + Name of the API key. + + maxLength: 500, minLength: 1 + +- `status: :active | :archived | :inactive` + + Status of the API key. + + - `:active` + + - `:archived` + + - `:inactive` + +#### Returns + +- `class BetaAPIKey` + + - `id: String` + + ID of the API key. + + - `created_at: Time` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: String` + + ID of the actor that created the object. + + - `type: :service_account | :user` + + Type of the actor that created the object. + + - `:service_account` + + - `:user` + + - `expires_at: Time` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: String` + + Name of the API key. + + - `partial_key_hint: String` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor | BetaAPIKeyServiceAccountActor` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `class BetaAPIKeyUserActor` + + - `type: :user_actor` + + Principal type. Always `"user_actor"` for a User. + + - `user_id: String` + + ID of the User the API key acts as. + + - `class BetaAPIKeyServiceAccountActor` + + - `service_account_id: String` + + ID of the Service Account the API key acts as. + + - `type: :service_account_actor` + + Principal type. Always `"service_account_actor"` for a Service Account. + + - `scope: BetaAPIKeyOrganizationScope | BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `class BetaAPIKeyOrganizationScope` + + - `type: :organization` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + - `class BetaAPIKeyWorkspaceScope` + + - `type: :workspace` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + - `workspace_id: String` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: :active | :archived | :expired | :inactive` + + Status of the API key. + + - `:active` + + - `:archived` + + - `:expired` + + - `:inactive` + + - `type: :api_key` + + Object type. + + For API Keys, this is always `"api_key"`. + + - `workspace_id: String` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_api_key = anthropic.beta.organization.api_keys.update("api_key_id") + +puts(beta_api_key) +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +`beta.organization.external_keys.create(**kwargs) -> BetaExternalKey` + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Parameters + +- `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig` + + - `kms_arn: String` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: :aws` + + - `region: String` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: String` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig` + + - `key_name: String` + + Full resource name of the Cloud KMS key. + + - `type: :gcp` + + - `class BetaAzureExternalKeyConfigParam` + + Azure Key Vault provider configuration. + + - `key_name: String` + + Name of the key within the vault. + + - `tenant_id: String` + + Azure AD tenant ID. + + - `type: :azure` + + - `vault_uri: String` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: String` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +- `display_name: String` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: :us` + + Data residency geo. Only `us` is supported. + +#### Returns + +- `class BetaExternalKey` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: String` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment` + + - `type: :attached` + + - `class BetaExternalKeyUnattachedAttachment` + + - `type: :unattached` + + - `created_at: Time` + + format: date-time + + - `display_name: String` + + Human-friendly display name. Null if none was set. + + - `geo: String` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig` + + - `kms_arn: String` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: :aws` + + - `region: String` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: String` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig` + + - `key_name: String` + + Full resource name of the Cloud KMS key. + + - `type: :gcp` + + - `class BetaAzureExternalKeyConfig` + + - `key_name: String` + + Name of the key within the vault. + + - `tenant_id: String` + + Azure AD tenant ID. + + - `type: :azure` + + - `vault_uri: String` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: String` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: :external_key` + + - `updated_at: Time` + + format: date-time + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_external_key = anthropic.beta.organization.external_keys.create( + provider_config: {kms_arn: "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", type: :aws} +) + +puts(beta_external_key) +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +`beta.organization.external_keys.list(**kwargs) -> PageCursor` + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Parameters + +- `limit: Integer` + + Number of results per page. + + maximum: 100, minimum: 1 + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaExternalKey` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: String` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment` + + - `type: :attached` + + - `class BetaExternalKeyUnattachedAttachment` + + - `type: :unattached` + + - `created_at: Time` + + format: date-time + + - `display_name: String` + + Human-friendly display name. Null if none was set. + + - `geo: String` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig` + + - `kms_arn: String` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: :aws` + + - `region: String` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: String` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig` + + - `key_name: String` + + Full resource name of the Cloud KMS key. + + - `type: :gcp` + + - `class BetaAzureExternalKeyConfig` + + - `key_name: String` + + Name of the key within the vault. + + - `tenant_id: String` + + Azure AD tenant ID. + + - `type: :azure` + + - `vault_uri: String` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: String` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: :external_key` + + - `updated_at: Time` + + format: date-time + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.external_keys.list + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +`beta.organization.external_keys.retrieve(external_key_id) -> BetaExternalKey` + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Parameters + +- `external_key_id: String` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class BetaExternalKey` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: String` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment` + + - `type: :attached` + + - `class BetaExternalKeyUnattachedAttachment` + + - `type: :unattached` + + - `created_at: Time` + + format: date-time + + - `display_name: String` + + Human-friendly display name. Null if none was set. + + - `geo: String` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig` + + - `kms_arn: String` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: :aws` + + - `region: String` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: String` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig` + + - `key_name: String` + + Full resource name of the Cloud KMS key. + + - `type: :gcp` + + - `class BetaAzureExternalKeyConfig` + + - `key_name: String` + + Name of the key within the vault. + + - `tenant_id: String` + + Azure AD tenant ID. + + - `type: :azure` + + - `vault_uri: String` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: String` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: :external_key` + + - `updated_at: Time` + + format: date-time + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_external_key = anthropic.beta.organization.external_keys.retrieve("external_key_id") + +puts(beta_external_key) +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +`beta.organization.external_keys.update(external_key_id, **kwargs) -> BetaExternalKey` + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Parameters + +- `external_key_id: String` + + ID of the External Key. + + maxLength: 2048 + +- `display_name: String` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + +- `geo: :us` + + Data residency geo. Only `us` is supported. + +- `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig` + + - `kms_arn: String` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: :aws` + + - `region: String` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: String` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig` + + - `key_name: String` + + Full resource name of the Cloud KMS key. + + - `type: :gcp` + + - `class BetaAzureExternalKeyConfigParam` + + Azure Key Vault provider configuration. + + - `key_name: String` + + Name of the key within the vault. + + - `tenant_id: String` + + Azure AD tenant ID. + + - `type: :azure` + + - `vault_uri: String` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: String` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +#### Returns + +- `class BetaExternalKey` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: String` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `class BetaExternalKeyAttachedAttachment` + + - `type: :attached` + + - `class BetaExternalKeyUnattachedAttachment` + + - `type: :unattached` + + - `created_at: Time` + + format: date-time + + - `display_name: String` + + Human-friendly display name. Null if none was set. + + - `geo: String` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `class BetaAWSExternalKeyConfig` + + - `kms_arn: String` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: :aws` + + - `region: String` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn: String` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `class BetaGCPExternalKeyConfig` + + - `key_name: String` + + Full resource name of the Cloud KMS key. + + - `type: :gcp` + + - `class BetaAzureExternalKeyConfig` + + - `key_name: String` + + Name of the key within the vault. + + - `tenant_id: String` + + Azure AD tenant ID. + + - `type: :azure` + + - `vault_uri: String` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id: String` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: :external_key` + + - `updated_at: Time` + + format: date-time + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_external_key = anthropic.beta.organization.external_keys.update("external_key_id") + +puts(beta_external_key) +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +`beta.organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse` + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Parameters + +- `external_key_id: String` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class ExternalKeyDeleteResponse` + + - `id: String` + + ID of the deleted External Key. + + - `type: :external_key_deleted` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +external_key = anthropic.beta.organization.external_keys.delete("external_key_id") + +puts(external_key) +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +`beta.organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse` + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Parameters + +- `external_key_id: String` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `class ExternalKeyValidateResponse` + + Result of a validation roundtrip against the customer's KMS. + + HTTP 200 for both outcomes — the operation completed; `status` says + whether the key works. + + - `error: String` + + Error message when status is `failure`. Null otherwise. + + - `status: :failure | :success` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `:failure` + + - `:success` + + - `type: :external_key_validation` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +response = anthropic.beta.organization.external_keys.validate("external_key_id") + +puts(response) +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +`beta.organization.federation.issuers.create(**kwargs) -> BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Parameters + +- `issuer_url: String` + + The `iss` claim value to match against. + + minLength: 1 + +- `name: String` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained. Defaults to OIDC discovery. + + - `class BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: :discovery` + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: String` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: :explicit_url` + + - `url: String` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array[Hash[Symbol, untyped]]` + + Inline JWK objects. + + minItems: 1 + + - `type: :inline` + +- `max_jwt_lifetime_seconds: Integer` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: String` + + Tagged ID of the federation issuer. + + - `archived_at: Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: Time` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: String` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: :discovery` + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: String` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: :explicit_url` + + - `url: String` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array[Hash[Symbol, untyped]]` + + Inline JWK objects. + + minItems: 1 + + - `type: :inline` + + - `jwks_polling_disabled_at: Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: Integer` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: String` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: Integer` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Time` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: :federation_issuer` + + - `updated_at: Time` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_issuer = anthropic.beta.organization.federation.issuers.create(issuer_url: "x", name: "x") + +puts(beta_federation_issuer) +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +`beta.organization.federation.issuers.list(**kwargs) -> PageCursor` + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Parameters + +- `include_archived: bool` + + Include archived resources. Defaults to false. + +- `limit: Integer` + + Number of results per page. + + maximum: 100, minimum: 1 + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: String` + + Tagged ID of the federation issuer. + + - `archived_at: Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: Time` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: String` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: :discovery` + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: String` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: :explicit_url` + + - `url: String` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array[Hash[Symbol, untyped]]` + + Inline JWK objects. + + minItems: 1 + + - `type: :inline` + + - `jwks_polling_disabled_at: Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: Integer` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: String` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: Integer` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Time` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: :federation_issuer` + + - `updated_at: Time` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.federation.issuers.list + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +`beta.organization.federation.issuers.retrieve(federation_issuer_id, **kwargs) -> BetaFederationIssuer` + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Parameters + +- `federation_issuer_id: String` + + ID of the federation issuer. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: String` + + Tagged ID of the federation issuer. + + - `archived_at: Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: Time` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: String` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: :discovery` + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: String` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: :explicit_url` + + - `url: String` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array[Hash[Symbol, untyped]]` + + Inline JWK objects. + + minItems: 1 + + - `type: :inline` + + - `jwks_polling_disabled_at: Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: Integer` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: String` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: Integer` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Time` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: :federation_issuer` + + - `updated_at: Time` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_issuer = anthropic.beta.organization.federation.issuers.retrieve("federation_issuer_id") + +puts(beta_federation_issuer) +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +`beta.organization.federation.issuers.update(federation_issuer_id, **kwargs) -> BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Parameters + +- `federation_issuer_id: String` + + ID of the federation issuer to update. + +- `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + +- `issuer_url: String` + + Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + +- `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + Replaces the entire JWKS configuration. + + - `class BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: :discovery` + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: String` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: :explicit_url` + + - `url: String` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array[Hash[Symbol, untyped]]` + + Inline JWK objects. + + minItems: 1 + + - `type: :inline` + +- `jwks_polling_disabled: bool` + + Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + +- `max_jwt_lifetime_seconds: Integer` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + +- `name: String` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: String` + + Tagged ID of the federation issuer. + + - `archived_at: Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: Time` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: String` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: :discovery` + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: String` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: :explicit_url` + + - `url: String` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array[Hash[Symbol, untyped]]` + + Inline JWK objects. + + minItems: 1 + + - `type: :inline` + + - `jwks_polling_disabled_at: Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: Integer` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: String` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: Integer` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Time` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: :federation_issuer` + + - `updated_at: Time` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_issuer = anthropic.beta.organization.federation.issuers.update("federation_issuer_id") + +puts(beta_federation_issuer) +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +`beta.organization.federation.issuers.archive(federation_issuer_id, **kwargs) -> BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Parameters + +- `federation_issuer_id: String` + + ID of the federation issuer to archive. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: String` + + Tagged ID of the federation issuer. + + - `archived_at: Time` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: bool` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: Time` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: String` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `class BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: :discovery` + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base: String` + + Set when the discovery URL differs from `issuer_url`. + + - `class BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: :explicit_url` + + - `url: String` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem: String` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `class BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array[Hash[Symbol, untyped]]` + + Inline JWK objects. + + minItems: 1 + + - `type: :inline` + + - `jwks_polling_disabled_at: Time` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: Integer` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: String` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: Integer` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: Time` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: Time` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: :federation_issuer` + + - `updated_at: Time` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_issuer = anthropic.beta.organization.federation.issuers.archive("federation_issuer_id") + +puts(beta_federation_issuer) +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +`beta.organization.federation.rules.create(**kwargs) -> BetaFederationRule` + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Parameters + +- `issuer_id: String` + + Tagged ID of the federation issuer. + +- `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `audience: String` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Hash[Symbol, String]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: String` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: String` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: String` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: String` + + Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: String` + + Tagged ID of the service account to mint tokens for. + + - `type: :service_account` + + - `service_account_name: String` + + Service account's display name at read time. Ignored on writes. + +- `applies_to_all_workspaces: bool` + + When true, enable this rule for every workspace in the org (including workspaces created later). + +- `attributes: Hash[Symbol, String]` + + CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + +- `description: String` + + Optional free-text description. + + maxLength: 2000 + +- `token_lifetime_seconds: Integer` + + Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: String` + + Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: String` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Hash[Symbol, String]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: Time` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: String` + + Optional free-text description. + + - `issuer_id: String` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: String` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: String` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Hash[Symbol, String]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: String` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: String` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: String` + + Admin-chosen slug identifier. + + - `oauth_scope: String` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: String` + + Tagged ID of the service account to mint tokens for. + + - `type: :service_account` + + - `service_account_name: String` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: Integer` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: :federation_rule` + + - `updated_at: Time` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: String` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array[String]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_rule = anthropic.beta.organization.federation.rules.create( + issuer_id: "issuer_id", + match: {}, + name: "x", + oauth_scope: "x", + target: {service_account_id: "svac_01SDCCSbTxrXDpWc1phhtcfK", type: :service_account} +) + +puts(beta_federation_rule) +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +`beta.organization.federation.rules.list(**kwargs) -> PageCursor` + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Parameters + +- `include_archived: bool` + + Include archived resources. Defaults to false. + +- `issuer_id: String` + + Filter to rules referencing this federation issuer. + +- `limit: Integer` + + Number of results per page. + + maximum: 100, minimum: 1 + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: String` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Hash[Symbol, String]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: Time` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: String` + + Optional free-text description. + + - `issuer_id: String` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: String` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: String` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Hash[Symbol, String]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: String` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: String` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: String` + + Admin-chosen slug identifier. + + - `oauth_scope: String` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: String` + + Tagged ID of the service account to mint tokens for. + + - `type: :service_account` + + - `service_account_name: String` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: Integer` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: :federation_rule` + + - `updated_at: Time` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: String` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array[String]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.federation.rules.list + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +`beta.organization.federation.rules.retrieve(federation_rule_id, **kwargs) -> BetaFederationRule` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Parameters + +- `federation_rule_id: String` + + ID of the federation rule. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: String` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Hash[Symbol, String]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: Time` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: String` + + Optional free-text description. + + - `issuer_id: String` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: String` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: String` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Hash[Symbol, String]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: String` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: String` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: String` + + Admin-chosen slug identifier. + + - `oauth_scope: String` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: String` + + Tagged ID of the service account to mint tokens for. + + - `type: :service_account` + + - `service_account_name: String` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: Integer` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: :federation_rule` + + - `updated_at: Time` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: String` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array[String]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_rule = anthropic.beta.organization.federation.rules.retrieve("federation_rule_id") + +puts(beta_federation_rule) +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +`beta.organization.federation.rules.update(federation_rule_id, **kwargs) -> BetaFederationRule` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `federation_rule_id: String` + + ID of the federation rule to update. + +- `applies_to_all_workspaces: bool` + + When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + +- `attributes: Hash[Symbol, String]` + + Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + +- `description: String` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `match: BetaFederationRuleMatch` + + Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience: String` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Hash[Symbol, String]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: String` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: String` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + +- `name: String` + + Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `oauth_scope: String` + + Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + +- `target: BetaServiceAccountTarget` + + Bind to a fixed service account by ID. + + - `service_account_id: String` + + Tagged ID of the service account to mint tokens for. + + - `type: :service_account` + + - `service_account_name: String` + + Service account's display name at read time. Ignored on writes. + +- `token_lifetime_seconds: Integer` + + Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + +- `workspace_id: String` + + Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: String` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Hash[Symbol, String]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: Time` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: String` + + Optional free-text description. + + - `issuer_id: String` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: String` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: String` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Hash[Symbol, String]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: String` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: String` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: String` + + Admin-chosen slug identifier. + + - `oauth_scope: String` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: String` + + Tagged ID of the service account to mint tokens for. + + - `type: :service_account` + + - `service_account_name: String` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: Integer` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: :federation_rule` + + - `updated_at: Time` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: String` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array[String]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_rule = anthropic.beta.organization.federation.rules.update("federation_rule_id") + +puts(beta_federation_rule) +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +`beta.organization.federation.rules.archive(federation_rule_id, **kwargs) -> BetaFederationRule` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federation_rule_id: String` + + ID of the federation rule to archive. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: String` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: bool` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: Time` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Hash[Symbol, String]` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: Time` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: String` + + Optional free-text description. + + - `issuer_id: String` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: String` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience: String` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims: Hash[Symbol, String]` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition: String` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix: String` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: String` + + Admin-chosen slug identifier. + + - `oauth_scope: String` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: String` + + Tagged ID of the service account to mint tokens for. + + - `type: :service_account` + + - `service_account_name: String` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: Integer` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: :federation_rule` + + - `updated_at: Time` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: String` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array[String]` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_rule = anthropic.beta.organization.federation.rules.archive("federation_rule_id") + +puts(beta_federation_rule) +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +`beta.organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> BetaFederationRuleWorkspace` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federation_rule_id: String` + + ID of the federation rule. + +- `workspace_id: String` + + Tagged ID of the workspace to enable this rule for. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRuleWorkspace` + + - `created_at: Time` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: String` + + Tagged ID of the federation rule. + + - `type: :federation_rule_workspace` + + - `workspace_id: String` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: String` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_federation_rule_workspace = anthropic.beta.organization.federation.rules.workspaces.add( + "federation_rule_id", + workspace_id: "workspace_id" +) + +puts(beta_federation_rule_workspace) +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +`beta.organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> PageCursor` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Parameters + +- `federation_rule_id: String` + + ID of the federation rule. + +- `limit: Integer` + + Number of results per page. + + maximum: 100, minimum: 1 + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaFederationRuleWorkspace` + + - `created_at: Time` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: String` + + Tagged ID of the federation rule. + + - `type: :federation_rule_workspace` + + - `workspace_id: String` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: String` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.federation.rules.workspaces.list("federation_rule_id") + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +`beta.organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse` + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `federation_rule_id: String` + + ID of the federation rule. + +- `workspace_id: String` + + ID of the workspace to disable for. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class WorkspaceRemoveResponse` + + - `federation_rule_id: String` + + Tagged ID of the federation rule. + + - `type: :federation_rule_workspace_deleted` + + - `workspace_id: String` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +workspace = anthropic.beta.organization.federation.rules.workspaces.remove( + "workspace_id", + federation_rule_id: "federation_rule_id" +) + +puts(workspace) +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +`beta.organization.invites.create(**kwargs) -> BetaOrganizationInvite` + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Parameters + +- `email: String` + + Email of the User. + + format: email + +- `role: :billing | :claude_code_user | :developer | 2 more` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `:billing` + + - `:claude_code_user` + + - `:developer` + + - `:managed` + + - `:user` + +- `rbac_group_ids: Array[String]` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `class BetaOrganizationInvite` + + - `id: String` + + ID of the Invite. + + - `accepted_at: Time` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: String` + + Email of the User being invited. + + - `expires_at: Time` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: Time` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: Array[String]` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `:admin` + + - `:billing` + + - `:claude_code_user` + + - `:developer` + + - `:managed` + + - `:membership_admin` + + - `:owner` + + - `:primary_owner` + + - `:user` + + - `status: :accepted | :deleted | :expired | :pending` + + Status of the Invite. + + - `:accepted` + + - `:deleted` + + - `:expired` + + - `:pending` + + - `type: :invite` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_organization_invite = anthropic.beta.organization.invites.create(email: "user@emaildomain.com", role: :user) + +puts(beta_organization_invite) +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +`beta.organization.invites.list(**kwargs) -> Page` + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Parameters + +- `after_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: String` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + +- `limit: Integer` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +- `roles: Array[String]` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +- `statuses: Array[:accepted | :expired | :pending]` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `:accepted` + + - `:expired` + + - `:pending` + +#### Returns + +- `class BetaOrganizationInvite` + + - `id: String` + + ID of the Invite. + + - `accepted_at: Time` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: String` + + Email of the User being invited. + + - `expires_at: Time` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: Time` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: Array[String]` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `:admin` + + - `:billing` + + - `:claude_code_user` + + - `:developer` + + - `:managed` + + - `:membership_admin` + + - `:owner` + + - `:primary_owner` + + - `:user` + + - `status: :accepted | :deleted | :expired | :pending` + + Status of the Invite. + + - `:accepted` + + - `:deleted` + + - `:expired` + + - `:pending` + + - `type: :invite` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.invites.list + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +`beta.organization.invites.retrieve(invite_id) -> BetaOrganizationInvite` + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Parameters + +- `invite_id: String` + + ID of the Invite. + +#### Returns + +- `class BetaOrganizationInvite` + + - `id: String` + + ID of the Invite. + + - `accepted_at: Time` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: String` + + Email of the User being invited. + + - `expires_at: Time` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: Time` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: Array[String]` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `:admin` + + - `:billing` + + - `:claude_code_user` + + - `:developer` + + - `:managed` + + - `:membership_admin` + + - `:owner` + + - `:primary_owner` + + - `:user` + + - `status: :accepted | :deleted | :expired | :pending` + + Status of the Invite. + + - `:accepted` + + - `:deleted` + + - `:expired` + + - `:pending` + + - `type: :invite` + + Object type. + + For Invites, this is always `"invite"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_organization_invite = anthropic.beta.organization.invites.retrieve("invite_id") + +puts(beta_organization_invite) +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +`beta.organization.invites.delete(invite_id) -> InviteDeleteResponse` + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Parameters + +- `invite_id: String` + + ID of the Invite. + +#### Returns + +- `class InviteDeleteResponse` + + - `id: String` + + ID of the Invite. + + - `type: :invite_deleted` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +invite = anthropic.beta.organization.invites.delete("invite_id") + +puts(invite) +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +`beta.organization.service_accounts.create(**kwargs) -> BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Parameters + +- `name: String` + + Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + +- `description: String` + + Optional free-text description. + + maxLength: 2000 + +- `organization_role: :admin | :developer` + + Org-level role. Defaults to `developer`. + + - `:admin` + + - `:developer` + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: String` + + Tagged ID of the service account. + + - `archived_at: Time` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: Time` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: String` + + Optional free-text description. + + - `name: String` + + Admin-chosen slug identifier. + + - `organization_role: :admin | :developer` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `:admin` + + - `:developer` + + - `type: :service_account` + + - `updated_at: Time` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_service_account = anthropic.beta.organization.service_accounts.create(name: "ci-deploy-bot") + +puts(beta_service_account) +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +`beta.organization.service_accounts.list(**kwargs) -> PageCursor` + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Parameters + +- `include_archived: bool` + + Include archived resources. Defaults to false. + +- `limit: Integer` + + Number of results per page. + + maximum: 100, minimum: 1 + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: String` + + Tagged ID of the service account. + + - `archived_at: Time` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: Time` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: String` + + Optional free-text description. + + - `name: String` + + Admin-chosen slug identifier. + + - `organization_role: :admin | :developer` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `:admin` + + - `:developer` + + - `type: :service_account` + + - `updated_at: Time` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.service_accounts.list + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +`beta.organization.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccount` + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Parameters + +- `service_account_id: String` + + ID of the service account. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: String` + + Tagged ID of the service account. + + - `archived_at: Time` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: Time` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: String` + + Optional free-text description. + + - `name: String` + + Admin-chosen slug identifier. + + - `organization_role: :admin | :developer` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `:admin` + + - `:developer` + + - `type: :service_account` + + - `updated_at: Time` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_service_account = anthropic.beta.organization.service_accounts.retrieve("service_account_id") + +puts(beta_service_account) +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +`beta.organization.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Parameters + +- `service_account_id: String` + + ID of the service account to update. + +- `description: String` + + Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + +- `organization_role: :admin | :developer` + + Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `:admin` + + - `:developer` + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: String` + + Tagged ID of the service account. + + - `archived_at: Time` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: Time` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: String` + + Optional free-text description. + + - `name: String` + + Admin-chosen slug identifier. + + - `organization_role: :admin | :developer` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `:admin` + + - `:developer` + + - `type: :service_account` + + - `updated_at: Time` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_service_account = anthropic.beta.organization.service_accounts.update("service_account_id") + +puts(beta_service_account) +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +`beta.organization.service_accounts.archive(service_account_id, **kwargs) -> BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Parameters + +- `service_account_id: String` + + ID of the service account to archive. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: String` + + Tagged ID of the service account. + + - `archived_at: Time` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: Time` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: String` + + Optional free-text description. + + - `name: String` + + Admin-chosen slug identifier. + + - `organization_role: :admin | :developer` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `:admin` + + - `:developer` + + - `type: :service_account` + + - `updated_at: Time` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: String` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_service_account = anthropic.beta.organization.service_accounts.archive("service_account_id") + +puts(beta_service_account) +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +`beta.organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Parameters + +- `service_account_id: String` + + ID of the service account. + +- `workspace_id: String` + + Tagged workspace ID to add the service account to. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `:workspace_admin` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: String` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: bool` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: String` + + Tagged service account ID (`svac_...`). + + - `type: :service_account_workspace_member` + + - `workspace_id: String` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_service_account_workspace_member = anthropic.beta.organization.service_accounts.workspaces.add( + "service_account_id", + workspace_id: "workspace_id", + workspace_role: :workspace_admin +) + +puts(beta_service_account_workspace_member) +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +`beta.organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> PageCursor` + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Parameters + +- `service_account_id: String` + + ID of the service account. + +- `limit: Integer` + + Number of results per page. + + maximum: 100, minimum: 1 + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: String` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: bool` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: String` + + Tagged service account ID (`svac_...`). + + - `type: :service_account_workspace_member` + + - `workspace_id: String` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.service_accounts.workspaces.list("service_account_id") + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +`beta.organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse` + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Parameters + +- `service_account_id: String` + + ID of the service account. + +- `workspace_id: String` + + ID of the workspace. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class WorkspaceRemoveResponse` + + - `service_account_id: String` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: :service_account_workspace_member_deleted` + + - `workspace_id: String` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +workspace = anthropic.beta.organization.service_accounts.workspaces.remove( + "workspace_id", + service_account_id: "service_account_id" +) + +puts(workspace) +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +`beta.organization.users.list(**kwargs) -> Page` + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Parameters + +- `after_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `email: String` + + Filter by user email. + + format: email + +- `limit: Integer` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +- `roles: Array[String]` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `class BetaOrganizationUser` + + - `id: String` + + ID of the User. + + - `added_at: Time` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: String` + + Email of the User. + + - `name: String` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `:admin` + + - `:billing` + + - `:claude_code_user` + + - `:developer` + + - `:managed` + + - `:membership_admin` + + - `:owner` + + - `:primary_owner` + + - `:user` + + - `type: :user` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.users.list + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +`beta.organization.users.retrieve(user_id) -> BetaOrganizationUser` + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Parameters + +- `user_id: String` + + ID of the User. + +#### Returns + +- `class BetaOrganizationUser` + + - `id: String` + + ID of the User. + + - `added_at: Time` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: String` + + Email of the User. + + - `name: String` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `:admin` + + - `:billing` + + - `:claude_code_user` + + - `:developer` + + - `:managed` + + - `:membership_admin` + + - `:owner` + + - `:primary_owner` + + - `:user` + + - `type: :user` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_organization_user = anthropic.beta.organization.users.retrieve("user_id") + +puts(beta_organization_user) +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +`beta.organization.users.update(user_id, **kwargs) -> BetaOrganizationUser` + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Parameters + +- `user_id: String` + + ID of the User. + +- `role: :billing | :claude_code_user | :developer | 2 more` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `:billing` + + - `:claude_code_user` + + - `:developer` + + - `:managed` + + - `:user` + +#### Returns + +- `class BetaOrganizationUser` + + - `id: String` + + ID of the User. + + - `added_at: Time` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: String` + + Email of the User. + + - `name: String` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `:admin` + + - `:billing` + + - `:claude_code_user` + + - `:developer` + + - `:managed` + + - `:membership_admin` + + - `:owner` + + - `:primary_owner` + + - `:user` + + - `type: :user` + + Object type. + + For Users, this is always `"user"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_organization_user = anthropic.beta.organization.users.update("user_id", role: :user) + +puts(beta_organization_user) +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +`beta.organization.users.remove(user_id) -> UserRemoveResponse` + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Parameters + +- `user_id: String` + + ID of the User. + +#### Returns + +- `class UserRemoveResponse` + + - `id: String` + + ID of the User. + + - `type: :user_deleted` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +user = anthropic.beta.organization.users.remove("user_id") + +puts(user) +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +`beta.organization.workspaces.list(**kwargs) -> Page` + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Parameters + +- `after_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `include_archived: bool` + + Whether to include Workspaces that have been archived in the response + +- `limit: Integer` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `class BetaWorkspace` + + - `id: String` + + ID of the Workspace. + + - `archived_at: Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: String` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array[String] | :unrestricted` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = Array[String]` + + - `AllowedInferenceGeos = :unrestricted` + + - `default_inference_geo: String` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: String` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: String` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: String` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: String` + + Name of the Workspace. + + - `tags: Hash[Symbol, String]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: :workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.workspaces.list + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +`beta.organization.workspaces.create(**kwargs) -> BetaWorkspace` + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Parameters + +- `name: String` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `data_residency: BetaDataResidencyCreateConfig` + + Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `allowed_inference_geos: Array[BetaAllowedInferenceGeo] | :unrestricted` + + Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = Array[BetaAllowedInferenceGeo]` + + - `:global` + + - `:us` + + - `AllowedInferenceGeos = :unrestricted` + + - `default_inference_geo: :global | :us` + + Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `:global` + + - `:us` + + - `workspace_geo: :us` + + Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. + +- `display_color: String` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: String` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `tags: Hash[Symbol, String]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` + + - `:"message-batches-2024-09-24"` + + - `:"prompt-caching-2024-07-31"` + + - `:"computer-use-2024-10-22"` + + - `:"computer-use-2025-01-24"` + + - `:"pdfs-2024-09-25"` + + - `:"token-counting-2024-11-01"` + + - `:"token-efficient-tools-2025-02-19"` + + - `:"output-128k-2025-02-19"` + + - `:"files-api-2025-04-14"` + + - `:"mcp-client-2025-04-04"` + + - `:"mcp-client-2025-11-20"` + + - `:"dev-full-thinking-2025-05-14"` + + - `:"interleaved-thinking-2025-05-14"` + + - `:"code-execution-2025-05-22"` + + - `:"extended-cache-ttl-2025-04-11"` + + - `:"context-1m-2025-08-07"` + + - `:"context-management-2025-06-27"` + + - `:"model-context-window-exceeded-2025-08-26"` + + - `:"skills-2025-10-02"` + + - `:"fast-mode-2026-02-01"` + + - `:"output-300k-2026-03-24"` + + - `:"user-profiles-2026-03-24"` + + - `:"user-profiles-2026-08-18"` + + - `:"advisor-tool-2026-03-01"` + + - `:"managed-agents-2026-04-01"` + + - `:"cache-diagnosis-2026-04-07"` + + - `:"dreaming-2026-04-21"` + + - `:"thinking-token-count-2026-05-13"` + + - `:"server-side-fallback-2026-06-01"` + + - `:"server-side-fallback-2026-07-01"` + + - `:"fallback-credit-2026-06-01"` + + - `:"fallback-credit-2026-07-01"` + + - `:"agent-memory-2026-07-22"` + + - `:"mid-conversation-tool-changes-2026-07-01"` + + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + +#### Returns + +- `class BetaWorkspace` + + - `id: String` + + ID of the Workspace. + + - `archived_at: Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: String` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array[String] | :unrestricted` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = Array[String]` + + - `AllowedInferenceGeos = :unrestricted` + + - `default_inference_geo: String` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: String` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: String` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: String` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: String` + + Name of the Workspace. + + - `tags: Hash[Symbol, String]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: :workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_workspace = anthropic.beta.organization.workspaces.create(name: "x") + +puts(beta_workspace) +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +`beta.organization.workspaces.retrieve(workspace_id) -> BetaWorkspace` + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Parameters + +- `workspace_id: String` + + ID of the Workspace. + +#### Returns + +- `class BetaWorkspace` + + - `id: String` + + ID of the Workspace. + + - `archived_at: Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: String` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array[String] | :unrestricted` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = Array[String]` + + - `AllowedInferenceGeos = :unrestricted` + + - `default_inference_geo: String` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: String` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: String` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: String` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: String` + + Name of the Workspace. + + - `tags: Hash[Symbol, String]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: :workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_workspace = anthropic.beta.organization.workspaces.retrieve("workspace_id") + +puts(beta_workspace) +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +`beta.organization.workspaces.update(workspace_id, **kwargs) -> BetaWorkspace` + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Parameters + +- `workspace_id: String` + +- `data_residency: BetaDataResidencyUpdateConfig` + + Data residency configuration for the workspace. + + - `allowed_inference_geos: Array[BetaAllowedInferenceGeo] | :unrestricted` + + Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. + + - `Geos = Array[BetaAllowedInferenceGeo]` + + - `:global` + + - `:us` + + - `AllowedInferenceGeos = :unrestricted` + + - `default_inference_geo: :global | :us` + + Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `:global` + + - `:us` + +- `display_color: String` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + +- `external_key_id: String` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + +- `name: String` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + +- `tags: Hash[Symbol, String]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `class BetaWorkspace` + + - `id: String` + + ID of the Workspace. + + - `archived_at: Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: String` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array[String] | :unrestricted` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = Array[String]` + + - `AllowedInferenceGeos = :unrestricted` + + - `default_inference_geo: String` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: String` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: String` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: String` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: String` + + Name of the Workspace. + + - `tags: Hash[Symbol, String]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: :workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_workspace = anthropic.beta.organization.workspaces.update("workspace_id") + +puts(beta_workspace) +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +`beta.organization.workspaces.archive(workspace_id) -> BetaWorkspace` + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Parameters + +- `workspace_id: String` + +#### Returns + +- `class BetaWorkspace` + + - `id: String` + + ID of the Workspace. + + - `archived_at: Time` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: String` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: Time` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array[String] | :unrestricted` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Geos = Array[String]` + + - `AllowedInferenceGeos = :unrestricted` + + - `default_inference_geo: String` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: String` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: String` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: String` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: String` + + Name of the Workspace. + + - `tags: Hash[Symbol, String]` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: :workspace` + + Object type. + + For Workspaces, this is always `"workspace"`. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_workspace = anthropic.beta.organization.workspaces.archive("workspace_id") + +puts(beta_workspace) +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +`beta.organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> PageCursor` + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `workspace_id: String` + + The ID of the workspace. + +- `group_type: :batch | :files | :model_group | 3 more` + + Filter by group type. + + - `:batch` + + - `:files` + + - `:model_group` + + - `:skills` + + - `:token_count` + + - `:web_search` + +- `limit: Integer` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaWorkspaceRateLimit` + + - `group_type: :batch | :files | :model_group | 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `:batch` + + - `:files` + + - `:model_group` + + - `:skills` + + - `:token_count` + + - `:web_search` + + - `limits: Array[BetaWorkspaceRateLimitValue]` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: Integer` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: String` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: Integer` + + The workspace-level override value for this limiter type. + + - `models: Array[String]` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: String` + + The `id` of the RateLimit group this override applies to. + + - `type: :workspace_rate_limit` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + - `workspace_id: String` + + ID of the Workspace this override applies to. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.workspaces.rate_limits.list("workspace_id") + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +`beta.organization.workspaces.members.list(workspace_id, **kwargs) -> Page` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Parameters + +- `workspace_id: String` + + ID of the Workspace. + +- `after_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + +- `before_id: String` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + +- `limit: Integer` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `class BetaWorkspaceMember` + + - `type: :workspace_member` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `user_id: String` + + ID of the User. + + - `workspace_id: String` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +page = anthropic.beta.organization.workspaces.members.list("workspace_id") + +puts(page) +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +`beta.organization.workspaces.members.add(workspace_id, **kwargs) -> BetaWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Parameters + +- `workspace_id: String` + + ID of the Workspace. + +- `user_id: String` + + ID of the User. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + + - `:workspace_admin` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +#### Returns + +- `class BetaWorkspaceMember` + + - `type: :workspace_member` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `user_id: String` + + ID of the User. + + - `workspace_id: String` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_workspace_member = anthropic.beta.organization.workspaces.members.add( + "workspace_id", + user_id: "user_01WCz1FkmYMm4gnmykNKUu3Q", + workspace_role: :workspace_admin +) + +puts(beta_workspace_member) +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +`beta.organization.workspaces.members.retrieve(user_id, **kwargs) -> BetaWorkspaceMember` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Parameters + +- `workspace_id: String` + + ID of the Workspace. + +- `user_id: String` + + ID of the User. + +#### Returns + +- `class BetaWorkspaceMember` + + - `type: :workspace_member` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `user_id: String` + + ID of the User. + + - `workspace_id: String` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_workspace_member = anthropic.beta.organization.workspaces.members.retrieve("user_id", workspace_id: "workspace_id") + +puts(beta_workspace_member) +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +`beta.organization.workspaces.members.update(user_id, **kwargs) -> BetaWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Parameters + +- `workspace_id: String` + + ID of the Workspace. + +- `user_id: String` + + ID of the User. + +- `workspace_role: BetaWorkspaceRole` + + New workspace role for the User. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +#### Returns + +- `class BetaWorkspaceMember` + + - `type: :workspace_member` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + - `user_id: String` + + ID of the User. + + - `workspace_id: String` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +beta_workspace_member = anthropic.beta.organization.workspaces.members.update( + "user_id", + workspace_id: "workspace_id", + workspace_role: :workspace_admin +) + +puts(beta_workspace_member) +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +`beta.organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Parameters + +- `workspace_id: String` + + ID of the Workspace. + +- `user_id: String` + + ID of the User. + +#### Returns + +- `class MemberRemoveResponse` + + - `type: :workspace_member_deleted` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + - `user_id: String` + + ID of the User. + + - `workspace_id: String` + + ID of the Workspace. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +member = anthropic.beta.organization.workspaces.members.remove("user_id", workspace_id: "workspace_id") + +puts(member) +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +`beta.organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> PageCursor` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Parameters + +- `workspace_id: String` + + ID of the workspace. + +- `limit: Integer` + + Number of results per page. + + maximum: 100, minimum: 1 + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +- `betas: Array[AnthropicBeta]` + + Optional header to specify the beta version(s) you want to use. + + - `String = String` + + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -64865,21 +76481,55 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns -- `class BetaTunnelToken` +- `class BetaServiceAccountWorkspaceMember` - A tunnel's connector token. + - `created_by_actor_id: String` - - `id: String` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Stable identifier for the current token value. Changes when the token is rotated. + - `implicit: bool` - - `tunnel_token: String` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - The connector token used to run the tunnel. Treat as a credential. + - `service_account_id: String` - - `type: :tunnel_token` + Tagged service account ID (`svac_...`). + + - `type: :service_account_workspace_member` + + - `workspace_id: String` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` #### Example @@ -64888,42 +76538,69 @@ require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") -beta_tunnel_token = anthropic.beta.tunnels.rotate_token("tunnel_id") +page = anthropic.beta.organization.workspaces.service_accounts.list("workspace_id") -puts(beta_tunnel_token) +puts(page) ``` ##### Response (200) ```json { - "id": "id", - "tunnel_token": "tunnel_token", - "type": "tunnel_token" + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" } ``` -## Beta › Tunnels › Certificates +### Create Service Account Workspace Member -### Create Tunnel Certificate +`beta.organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> BetaServiceAccountWorkspaceMember` -`beta.tunnels.certificates.create(tunnel_id, **kwargs) -> BetaTunnelCertificate` +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` -**POST** `/v1/tunnels/{tunnel_id}/certificates` +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +Add a service account to a workspace with the given `workspace_role`. -Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. A tunnel holds at most two non-archived certificates. +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. #### Parameters -- `tunnel_id: String` +- `workspace_id: String` -- `ca_certificate_pem: String` + ID of the workspace. - PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. +- `service_account_id: String` - maxLength: 8192 + Tagged service account ID to add. + +- `workspace_role: BetaNoBillingWorkspaceRole` + + Role to assign to the service account in this workspace. + + - `:workspace_admin` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` - `betas: Array[AnthropicBeta]` @@ -64931,7 +76608,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -65001,43 +76678,55 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `:"mid-conversation-tool-changes-2026-07-01"` -#### Returns + - `:"compact-2026-01-12"` -- `class BetaTunnelCertificate` + - `:"computer-use-2025-11-24"` - A CA certificate attached to a tunnel. + - `:"mcp-tunnels-2026-06-22"` - - `id: String` + - `:"structured-outputs-2025-11-13"` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `:"task-budgets-2026-03-13"` - - `archived_at: Time` + - `:"thinking-display-updates-2026-08-18"` - A timestamp in RFC 3339 format + - `:"ce-user-management-2026-07-13"` - format: date-time +#### Returns - - `created_at: Time` +- `class BetaServiceAccountWorkspaceMember` - A timestamp in RFC 3339 format + - `created_by_actor_id: String` - format: date-time + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - - `expires_at: Time` + - `implicit: bool` - A timestamp in RFC 3339 format + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - format: date-time + - `service_account_id: String` - - `fingerprint: String` + Tagged service account ID (`svac_...`). - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `type: :service_account_workspace_member` - - `tunnel_id: String` + - `workspace_id: String` - ID of the tunnel the certificate is registered against. + Tagged workspace ID (`wrkspc_...`). - - `type: :tunnel_certificate` + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` #### Example @@ -65046,40 +76735,54 @@ require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") -beta_tunnel_certificate = anthropic.beta.tunnels.certificates.create("tunnel_id", ca_certificate_pem: "ca_certificate_pem") +beta_service_account_workspace_member = anthropic.beta.organization.workspaces.service_accounts.add( + "workspace_id", + service_account_id: "service_account_id", + workspace_role: :workspace_admin +) -puts(beta_tunnel_certificate) +puts(beta_service_account_workspace_member) ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Get Tunnel Certificate +### Get Service Account Workspace Member -`beta.tunnels.certificates.retrieve(certificate_id, **kwargs) -> BetaTunnelCertificate` +`beta.organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember` -**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Fetches a tunnel certificate by ID. +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. #### Parameters -- `tunnel_id: String` +- `workspace_id: String` -- `certificate_id: String` + ID of the workspace. + +- `service_account_id: String` + + ID of the service account. - `betas: Array[AnthropicBeta]` @@ -65087,7 +76790,7 @@ Fetches a tunnel certificate by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -65157,43 +76860,55 @@ Fetches a tunnel certificate by ID. - `:"mid-conversation-tool-changes-2026-07-01"` -#### Returns + - `:"compact-2026-01-12"` -- `class BetaTunnelCertificate` + - `:"computer-use-2025-11-24"` - A CA certificate attached to a tunnel. + - `:"mcp-tunnels-2026-06-22"` - - `id: String` + - `:"structured-outputs-2025-11-13"` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `:"task-budgets-2026-03-13"` - - `archived_at: Time` + - `:"thinking-display-updates-2026-08-18"` - A timestamp in RFC 3339 format + - `:"ce-user-management-2026-07-13"` - format: date-time +#### Returns - - `created_at: Time` +- `class BetaServiceAccountWorkspaceMember` - A timestamp in RFC 3339 format + - `created_by_actor_id: String` - format: date-time + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - - `expires_at: Time` + - `implicit: bool` - A timestamp in RFC 3339 format + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - format: date-time + - `service_account_id: String` - - `fingerprint: String` + Tagged service account ID (`svac_...`). - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `type: :service_account_workspace_member` - - `tunnel_id: String` + - `workspace_id: String` - ID of the tunnel the certificate is registered against. + Tagged workspace ID (`wrkspc_...`). - - `type: :tunnel_certificate` + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` #### Example @@ -65202,52 +76917,65 @@ require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") -beta_tunnel_certificate = anthropic.beta.tunnels.certificates.retrieve("certificate_id", tunnel_id: "tunnel_id") +beta_service_account_workspace_member = anthropic.beta.organization.workspaces.service_accounts.retrieve( + "service_account_id", + workspace_id: "workspace_id" +) -puts(beta_tunnel_certificate) +puts(beta_service_account_workspace_member) ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### List Tunnel Certificates +### Update Service Account Workspace Member -`beta.tunnels.certificates.list(tunnel_id, **kwargs) -> PageCursor` +`beta.organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember` -**GET** `/v1/tunnels/{tunnel_id}/certificates` +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. #### Parameters -- `tunnel_id: String` +- `workspace_id: String` -- `include_archived: bool` + ID of the workspace. - Whether to include archived certificates in the results. Defaults to false. +- `service_account_id: String` -- `limit: Integer` + ID of the service account. - Maximum number of certificates to return per page. Defaults to 20, maximum 1000. +- `workspace_role: BetaNoBillingWorkspaceRole` - format: int32 + New role for the service account in this workspace. -- `page: String` + - `:workspace_admin` - Opaque pagination cursor from a previous `list_tunnel_certificates` response. + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` - `betas: Array[AnthropicBeta]` @@ -65255,7 +76983,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -65325,43 +77053,55 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `:"mid-conversation-tool-changes-2026-07-01"` -#### Returns + - `:"compact-2026-01-12"` -- `class BetaTunnelCertificate` + - `:"computer-use-2025-11-24"` - A CA certificate attached to a tunnel. + - `:"mcp-tunnels-2026-06-22"` - - `id: String` + - `:"structured-outputs-2025-11-13"` - Unique identifier for the certificate, prefixed with `tcrt_`. + - `:"task-budgets-2026-03-13"` - - `archived_at: Time` + - `:"thinking-display-updates-2026-08-18"` - A timestamp in RFC 3339 format + - `:"ce-user-management-2026-07-13"` - format: date-time +#### Returns - - `created_at: Time` +- `class BetaServiceAccountWorkspaceMember` - A timestamp in RFC 3339 format + - `created_by_actor_id: String` - format: date-time + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - - `expires_at: Time` + - `implicit: bool` - A timestamp in RFC 3339 format + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - format: date-time + - `service_account_id: String` - - `fingerprint: String` + Tagged service account ID (`svac_...`). - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `type: :service_account_workspace_member` - - `tunnel_id: String` + - `workspace_id: String` - ID of the tunnel the certificate is registered against. + Tagged workspace ID (`wrkspc_...`). - - `type: :tunnel_certificate` + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `:workspace_admin` + + - `:workspace_billing` + + - `:workspace_developer` + + - `:workspace_restricted_developer` + + - `:workspace_user` #### Example @@ -65370,45 +77110,53 @@ require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") -page = anthropic.beta.tunnels.certificates.list("tunnel_id") +beta_service_account_workspace_member = anthropic.beta.organization.workspaces.service_accounts.update( + "service_account_id", + workspace_id: "workspace_id", + workspace_role: :workspace_admin +) -puts(page) +puts(beta_service_account_workspace_member) ``` ##### Response (200) ```json { - "data": [ - { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" - } - ], - "next_page": "next_page" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Archive Tunnel Certificate +### Delete Service Account Workspace Member -`beta.tunnels.certificates.archive(certificate_id, **kwargs) -> BetaTunnelCertificate` +`beta.organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse` -**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. #### Parameters -- `tunnel_id: String` +- `workspace_id: String` -- `certificate_id: String` + ID of the workspace. + +- `service_account_id: String` + + ID of the service account. - `betas: Array[AnthropicBeta]` @@ -65416,7 +77164,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -65486,43 +77234,154 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns -- `class BetaTunnelCertificate` +- `class ServiceAccountRemoveResponse` - A CA certificate attached to a tunnel. + - `service_account_id: String` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: :service_account_workspace_member_deleted` + + - `workspace_id: String` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```ruby +require "anthropic" + +anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") + +service_account = anthropic.beta.organization.workspaces.service_accounts.remove( + "service_account_id", + workspace_id: "workspace_id" +) + +puts(service_account) +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Rate Limits + +### List Organization Rate Limits + +`beta.organization.rate_limits.list(**kwargs) -> PageCursor` + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `group_type: :batch | :files | :model_group | 3 more` + + Filter by group type. + + - `:batch` + + - `:files` + + - `:model_group` + + - `:skills` + + - `:token_count` + + - `:web_search` + +- `limit: Integer` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + +- `model: String` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + +- `page: String` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `class BetaOrganizationRateLimit` - `id: String` - Unique identifier for the certificate, prefixed with `tcrt_`. + Stable identifier for this rate-limit group within the organization. - - `archived_at: Time` + - `group_type: :batch | :files | :model_group | 3 more` - A timestamp in RFC 3339 format + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. - format: date-time + - `:batch` - - `created_at: Time` + - `:files` - A timestamp in RFC 3339 format + - `:model_group` - format: date-time + - `:skills` - - `expires_at: Time` + - `:token_count` - A timestamp in RFC 3339 format + - `:web_search` - format: date-time + - `limits: Array[BetaOrganizationRateLimitValue]` - - `fingerprint: String` + The limiter values that apply to this group. - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `type: String` - - `tunnel_id: String` + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - ID of the tunnel the certificate is registered against. + - `value: Integer` - - `type: :tunnel_certificate` + The configured limit value for this limiter type. + + - `models: Array[String]` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: :rate_limit` + + Object type. Always `rate_limit` for organization rate-limit entries. #### Example @@ -65531,21 +77390,31 @@ require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") -beta_tunnel_certificate = anthropic.beta.tunnels.certificates.archive("certificate_id", tunnel_id: "tunnel_id") +page = anthropic.beta.organization.rate_limits.list -puts(beta_tunnel_certificate) +puts(page) ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" } ``` diff --git a/content/en/api/ruby/beta/agents.md b/content/en/api/ruby/beta/agents.md index 52c16f7d2..5a730602f 100644 --- a/content/en/api/ruby/beta/agents.md +++ b/content/en/api/ruby/beta/agents.md @@ -668,7 +668,7 @@ Create Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -738,6 +738,20 @@ Create Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent` @@ -1402,7 +1416,7 @@ List Agents - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1472,6 +1486,20 @@ List Agents - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent` @@ -2120,7 +2148,7 @@ Get Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2190,6 +2218,20 @@ Get Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent` @@ -3485,7 +3527,7 @@ Update Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3555,6 +3597,20 @@ Update Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent` @@ -4192,7 +4248,7 @@ Archive Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4262,6 +4318,20 @@ Archive Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent` @@ -8651,7 +8721,7 @@ List Agent Versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -8721,6 +8791,20 @@ List Agent Versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsAgent` diff --git a/content/en/api/ruby/beta/agents/archive.md b/content/en/api/ruby/beta/agents/archive.md index e0c363a52..28fd2cd0b 100644 --- a/content/en/api/ruby/beta/agents/archive.md +++ b/content/en/api/ruby/beta/agents/archive.md @@ -16,7 +16,7 @@ Archive Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent` diff --git a/content/en/api/ruby/beta/agents/create.md b/content/en/api/ruby/beta/agents/create.md index d7663b352..fbd753668 100644 --- a/content/en/api/ruby/beta/agents/create.md +++ b/content/en/api/ruby/beta/agents/create.md @@ -666,7 +666,7 @@ Create Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -736,6 +736,20 @@ Create Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent` diff --git a/content/en/api/ruby/beta/agents/list.md b/content/en/api/ruby/beta/agents/list.md index 25b10d685..a42f90981 100644 --- a/content/en/api/ruby/beta/agents/list.md +++ b/content/en/api/ruby/beta/agents/list.md @@ -40,7 +40,7 @@ List Agents - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -110,6 +110,20 @@ List Agents - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent` diff --git a/content/en/api/ruby/beta/agents/retrieve.md b/content/en/api/ruby/beta/agents/retrieve.md index 4f90d95c3..cdbcd9c0a 100644 --- a/content/en/api/ruby/beta/agents/retrieve.md +++ b/content/en/api/ruby/beta/agents/retrieve.md @@ -22,7 +22,7 @@ Get Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Get Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent` diff --git a/content/en/api/ruby/beta/agents/update.md b/content/en/api/ruby/beta/agents/update.md index e3f9bf0f8..944564895 100644 --- a/content/en/api/ruby/beta/agents/update.md +++ b/content/en/api/ruby/beta/agents/update.md @@ -674,7 +674,7 @@ Update Agent - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -744,6 +744,20 @@ Update Agent - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent` diff --git a/content/en/api/ruby/beta/agents/versions.md b/content/en/api/ruby/beta/agents/versions.md index 90e843fdb..523749fa4 100644 --- a/content/en/api/ruby/beta/agents/versions.md +++ b/content/en/api/ruby/beta/agents/versions.md @@ -28,7 +28,7 @@ List Agent Versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Agent Versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsAgent` diff --git a/content/en/api/ruby/beta/agents/versions/list.md b/content/en/api/ruby/beta/agents/versions/list.md index b366ac797..62e8e4d1d 100644 --- a/content/en/api/ruby/beta/agents/versions/list.md +++ b/content/en/api/ruby/beta/agents/versions/list.md @@ -26,7 +26,7 @@ List Agent Versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ List Agent Versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsAgent` diff --git a/content/en/api/ruby/beta/deployment_runs.md b/content/en/api/ruby/beta/deployment_runs.md index 9b1232bad..626b6ee54 100644 --- a/content/en/api/ruby/beta/deployment_runs.md +++ b/content/en/api/ruby/beta/deployment_runs.md @@ -66,7 +66,7 @@ List Deployment Runs - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -136,6 +136,20 @@ List Deployment Runs - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeploymentRun` @@ -420,7 +434,7 @@ Get Deployment Run - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -490,6 +504,20 @@ Get Deployment Run - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/ruby/beta/deployment_runs/list.md b/content/en/api/ruby/beta/deployment_runs/list.md index ced0a525d..3673735c3 100644 --- a/content/en/api/ruby/beta/deployment_runs/list.md +++ b/content/en/api/ruby/beta/deployment_runs/list.md @@ -64,7 +64,7 @@ List Deployment Runs - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -134,6 +134,20 @@ List Deployment Runs - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/ruby/beta/deployment_runs/retrieve.md b/content/en/api/ruby/beta/deployment_runs/retrieve.md index 53dfdc2e1..2082c505b 100644 --- a/content/en/api/ruby/beta/deployment_runs/retrieve.md +++ b/content/en/api/ruby/beta/deployment_runs/retrieve.md @@ -16,7 +16,7 @@ Get Deployment Run - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Deployment Run - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/ruby/beta/deployments.md b/content/en/api/ruby/beta/deployments.md index cfbdaf1be..0c9d51b43 100644 --- a/content/en/api/ruby/beta/deployments.md +++ b/content/en/api/ruby/beta/deployments.md @@ -416,7 +416,7 @@ Create Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -486,6 +486,20 @@ Create Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment` @@ -1140,7 +1154,7 @@ List Deployments - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1210,6 +1224,20 @@ List Deployments - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment` @@ -1828,7 +1856,7 @@ Get Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1898,6 +1926,20 @@ Get Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment` @@ -2911,7 +2953,7 @@ Update Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2981,6 +3023,20 @@ Update Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment` @@ -3594,7 +3650,7 @@ Archive Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3664,6 +3720,20 @@ Archive Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment` @@ -4277,7 +4347,7 @@ Run Deployment Now - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4347,6 +4417,20 @@ Run Deployment Now - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeploymentRun` @@ -4626,7 +4710,7 @@ Pause Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4696,6 +4780,20 @@ Pause Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment` @@ -5309,7 +5407,7 @@ Unpause Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -5379,6 +5477,20 @@ Unpause Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeployment` diff --git a/content/en/api/ruby/beta/deployments/archive.md b/content/en/api/ruby/beta/deployments/archive.md index 41d040f73..3c501e9f8 100644 --- a/content/en/api/ruby/beta/deployments/archive.md +++ b/content/en/api/ruby/beta/deployments/archive.md @@ -16,7 +16,7 @@ Archive Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment` diff --git a/content/en/api/ruby/beta/deployments/create.md b/content/en/api/ruby/beta/deployments/create.md index 08cd981b2..f4f806745 100644 --- a/content/en/api/ruby/beta/deployments/create.md +++ b/content/en/api/ruby/beta/deployments/create.md @@ -414,7 +414,7 @@ Create Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -484,6 +484,20 @@ Create Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment` diff --git a/content/en/api/ruby/beta/deployments/list.md b/content/en/api/ruby/beta/deployments/list.md index 8edf55218..6b8f7adda 100644 --- a/content/en/api/ruby/beta/deployments/list.md +++ b/content/en/api/ruby/beta/deployments/list.md @@ -52,7 +52,7 @@ List Deployments - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -122,6 +122,20 @@ List Deployments - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment` diff --git a/content/en/api/ruby/beta/deployments/pause.md b/content/en/api/ruby/beta/deployments/pause.md index bccd9033d..5e25e43e3 100644 --- a/content/en/api/ruby/beta/deployments/pause.md +++ b/content/en/api/ruby/beta/deployments/pause.md @@ -16,7 +16,7 @@ Pause Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Pause Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment` diff --git a/content/en/api/ruby/beta/deployments/retrieve.md b/content/en/api/ruby/beta/deployments/retrieve.md index c937fa7db..b4997eb08 100644 --- a/content/en/api/ruby/beta/deployments/retrieve.md +++ b/content/en/api/ruby/beta/deployments/retrieve.md @@ -16,7 +16,7 @@ Get Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment` diff --git a/content/en/api/ruby/beta/deployments/run.md b/content/en/api/ruby/beta/deployments/run.md index 32c01925e..c31896224 100644 --- a/content/en/api/ruby/beta/deployments/run.md +++ b/content/en/api/ruby/beta/deployments/run.md @@ -16,7 +16,7 @@ Run Deployment Now - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Run Deployment Now - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/ruby/beta/deployments/unpause.md b/content/en/api/ruby/beta/deployments/unpause.md index 620078e8e..5606ff479 100644 --- a/content/en/api/ruby/beta/deployments/unpause.md +++ b/content/en/api/ruby/beta/deployments/unpause.md @@ -16,7 +16,7 @@ Unpause Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Unpause Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment` diff --git a/content/en/api/ruby/beta/deployments/update.md b/content/en/api/ruby/beta/deployments/update.md index b8c86b4f6..170341d2b 100644 --- a/content/en/api/ruby/beta/deployments/update.md +++ b/content/en/api/ruby/beta/deployments/update.md @@ -416,7 +416,7 @@ Update Deployment - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -486,6 +486,20 @@ Update Deployment - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeployment` diff --git a/content/en/api/ruby/beta/environments.md b/content/en/api/ruby/beta/environments.md index 0b5acc803..d2ed0049a 100644 --- a/content/en/api/ruby/beta/environments.md +++ b/content/en/api/ruby/beta/environments.md @@ -60,7 +60,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: bool` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Array[String]` @@ -72,6 +72,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Array[String]` Ubuntu/Debian packages to install @@ -132,7 +134,7 @@ Create a new environment with the specified configuration. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -202,6 +204,20 @@ Create a new environment with the specified configuration. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment` @@ -423,7 +439,7 @@ List environments with pagination support. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -493,6 +509,20 @@ List environments with pagination support. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment` @@ -707,7 +737,7 @@ Retrieve a specific environment by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -777,6 +807,20 @@ Retrieve a specific environment by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment` @@ -1024,7 +1068,7 @@ Update an existing environment's configuration. - `allow_package_managers: bool` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Array[String]` @@ -1036,6 +1080,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Array[String]` Ubuntu/Debian packages to install @@ -1102,7 +1148,7 @@ Update an existing environment's configuration. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1172,6 +1218,20 @@ Update an existing environment's configuration. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment` @@ -1381,7 +1441,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1451,6 +1511,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironmentDeleteResponse` @@ -1504,7 +1578,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1574,6 +1648,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaEnvironment` @@ -1883,7 +1971,7 @@ puts(beta_environment) - `allow_package_managers: bool` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Array[String]` @@ -1895,6 +1983,8 @@ puts(beta_environment) When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Array[String]` Ubuntu/Debian packages to install @@ -2108,7 +2198,7 @@ puts(beta_environment) - `allow_package_managers: bool` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Array[String]` @@ -2156,6 +2246,8 @@ puts(beta_environment) When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Array[String]` Ubuntu/Debian packages to install @@ -2238,7 +2330,7 @@ Retrieve detailed information about a specific work item. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2308,6 +2400,20 @@ Retrieve detailed information about a specific work item. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -2457,7 +2563,7 @@ Long poll for work items in the queue. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2527,6 +2633,20 @@ Long poll for work items in the queue. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `anthropic_worker_id: String` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -2670,7 +2790,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2740,6 +2860,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -2887,7 +3021,7 @@ Record a heartbeat for a work item to maintain the lease. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2957,6 +3091,20 @@ Record a heartbeat for a work item to maintain the lease. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWorkHeartbeatResponse` @@ -3043,7 +3191,7 @@ Stop a work item, initiating graceful or forced shutdown. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3113,6 +3261,20 @@ Stop a work item, initiating graceful or forced shutdown. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -3260,7 +3422,7 @@ List work items in an environment. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3330,6 +3492,20 @@ List work items in an environment. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -3478,7 +3654,7 @@ Update work item metadata with merge semantics. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3548,6 +3724,20 @@ Update work item metadata with merge semantics. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWork` @@ -3687,7 +3877,7 @@ Get statistics about the work queue for an environment. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3757,6 +3947,20 @@ Get statistics about the work queue for an environment. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaSelfHostedWorkQueueStats` diff --git a/content/en/api/ruby/beta/environments/archive.md b/content/en/api/ruby/beta/environments/archive.md index e9de1cd47..7094d6aec 100644 --- a/content/en/api/ruby/beta/environments/archive.md +++ b/content/en/api/ruby/beta/environments/archive.md @@ -16,7 +16,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment` diff --git a/content/en/api/ruby/beta/environments/create.md b/content/en/api/ruby/beta/environments/create.md index d23c0039c..8d7183cbf 100644 --- a/content/en/api/ruby/beta/environments/create.md +++ b/content/en/api/ruby/beta/environments/create.md @@ -58,7 +58,7 @@ Create a new environment with the specified configuration. - `allow_package_managers: bool` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Array[String]` @@ -70,6 +70,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Array[String]` Ubuntu/Debian packages to install @@ -130,7 +132,7 @@ Create a new environment with the specified configuration. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -200,6 +202,20 @@ Create a new environment with the specified configuration. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment` diff --git a/content/en/api/ruby/beta/environments/delete.md b/content/en/api/ruby/beta/environments/delete.md index 438bf97b0..796f86956 100644 --- a/content/en/api/ruby/beta/environments/delete.md +++ b/content/en/api/ruby/beta/environments/delete.md @@ -16,7 +16,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironmentDeleteResponse` diff --git a/content/en/api/ruby/beta/environments/list.md b/content/en/api/ruby/beta/environments/list.md index 3fa0faa2c..4798191e5 100644 --- a/content/en/api/ruby/beta/environments/list.md +++ b/content/en/api/ruby/beta/environments/list.md @@ -28,7 +28,7 @@ List environments with pagination support. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List environments with pagination support. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment` diff --git a/content/en/api/ruby/beta/environments/retrieve.md b/content/en/api/ruby/beta/environments/retrieve.md index 5283b738a..656cde092 100644 --- a/content/en/api/ruby/beta/environments/retrieve.md +++ b/content/en/api/ruby/beta/environments/retrieve.md @@ -16,7 +16,7 @@ Retrieve a specific environment by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Retrieve a specific environment by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment` diff --git a/content/en/api/ruby/beta/environments/update.md b/content/en/api/ruby/beta/environments/update.md index 8bd92cb36..092a6adc1 100644 --- a/content/en/api/ruby/beta/environments/update.md +++ b/content/en/api/ruby/beta/environments/update.md @@ -54,7 +54,7 @@ Update an existing environment's configuration. - `allow_package_managers: bool` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: Array[String]` @@ -66,6 +66,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt: Array[String]` Ubuntu/Debian packages to install @@ -132,7 +134,7 @@ Update an existing environment's configuration. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -202,6 +204,20 @@ Update an existing environment's configuration. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaEnvironment` diff --git a/content/en/api/ruby/beta/environments/work.md b/content/en/api/ruby/beta/environments/work.md index ac4a349a1..cc3d99b23 100644 --- a/content/en/api/ruby/beta/environments/work.md +++ b/content/en/api/ruby/beta/environments/work.md @@ -22,7 +22,7 @@ Retrieve detailed information about a specific work item. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Retrieve detailed information about a specific work item. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork` @@ -241,7 +255,7 @@ Long poll for work items in the queue. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -311,6 +325,20 @@ Long poll for work items in the queue. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `anthropic_worker_id: String` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -454,7 +482,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -524,6 +552,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork` @@ -671,7 +713,7 @@ Record a heartbeat for a work item to maintain the lease. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -741,6 +783,20 @@ Record a heartbeat for a work item to maintain the lease. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWorkHeartbeatResponse` @@ -827,7 +883,7 @@ Stop a work item, initiating graceful or forced shutdown. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -897,6 +953,20 @@ Stop a work item, initiating graceful or forced shutdown. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork` @@ -1044,7 +1114,7 @@ List work items in an environment. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1114,6 +1184,20 @@ List work items in an environment. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork` @@ -1262,7 +1346,7 @@ Update work item metadata with merge semantics. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1332,6 +1416,20 @@ Update work item metadata with merge semantics. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWork` @@ -1471,7 +1569,7 @@ Get statistics about the work queue for an environment. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1541,6 +1639,20 @@ Get statistics about the work queue for an environment. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaSelfHostedWorkQueueStats` diff --git a/content/en/api/ruby/beta/environments/work/ack.md b/content/en/api/ruby/beta/environments/work/ack.md index 94c369741..56fd39d98 100644 --- a/content/en/api/ruby/beta/environments/work/ack.md +++ b/content/en/api/ruby/beta/environments/work/ack.md @@ -20,7 +20,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork` diff --git a/content/en/api/ruby/beta/environments/work/heartbeat.md b/content/en/api/ruby/beta/environments/work/heartbeat.md index bd5189580..b0740bbd3 100644 --- a/content/en/api/ruby/beta/environments/work/heartbeat.md +++ b/content/en/api/ruby/beta/environments/work/heartbeat.md @@ -28,7 +28,7 @@ Record a heartbeat for a work item to maintain the lease. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Record a heartbeat for a work item to maintain the lease. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWorkHeartbeatResponse` diff --git a/content/en/api/ruby/beta/environments/work/list.md b/content/en/api/ruby/beta/environments/work/list.md index dd5148105..48838f97e 100644 --- a/content/en/api/ruby/beta/environments/work/list.md +++ b/content/en/api/ruby/beta/environments/work/list.md @@ -28,7 +28,7 @@ List work items in an environment. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List work items in an environment. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork` diff --git a/content/en/api/ruby/beta/environments/work/poll.md b/content/en/api/ruby/beta/environments/work/poll.md index 17604fd3a..8969c1a2c 100644 --- a/content/en/api/ruby/beta/environments/work/poll.md +++ b/content/en/api/ruby/beta/environments/work/poll.md @@ -30,7 +30,7 @@ Long poll for work items in the queue. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Long poll for work items in the queue. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `anthropic_worker_id: String` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console diff --git a/content/en/api/ruby/beta/environments/work/retrieve.md b/content/en/api/ruby/beta/environments/work/retrieve.md index 1e7aee5a0..6bb3a906f 100644 --- a/content/en/api/ruby/beta/environments/work/retrieve.md +++ b/content/en/api/ruby/beta/environments/work/retrieve.md @@ -20,7 +20,7 @@ Retrieve detailed information about a specific work item. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Retrieve detailed information about a specific work item. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork` diff --git a/content/en/api/ruby/beta/environments/work/stats.md b/content/en/api/ruby/beta/environments/work/stats.md index ace1df03a..024fa94cf 100644 --- a/content/en/api/ruby/beta/environments/work/stats.md +++ b/content/en/api/ruby/beta/environments/work/stats.md @@ -16,7 +16,7 @@ Get statistics about the work queue for an environment. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get statistics about the work queue for an environment. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWorkQueueStats` diff --git a/content/en/api/ruby/beta/environments/work/stop.md b/content/en/api/ruby/beta/environments/work/stop.md index 5de3c912d..8e1d15df5 100644 --- a/content/en/api/ruby/beta/environments/work/stop.md +++ b/content/en/api/ruby/beta/environments/work/stop.md @@ -24,7 +24,7 @@ Stop a work item, initiating graceful or forced shutdown. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Stop a work item, initiating graceful or forced shutdown. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork` diff --git a/content/en/api/ruby/beta/environments/work/update.md b/content/en/api/ruby/beta/environments/work/update.md index 11d417e38..ccc1a0009 100644 --- a/content/en/api/ruby/beta/environments/work/update.md +++ b/content/en/api/ruby/beta/environments/work/update.md @@ -24,7 +24,7 @@ Update work item metadata with merge semantics. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Update work item metadata with merge semantics. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaSelfHostedWork` diff --git a/content/en/api/ruby/beta/files.md b/content/en/api/ruby/beta/files.md index f173a3aed..2a971ce21 100644 --- a/content/en/api/ruby/beta/files.md +++ b/content/en/api/ruby/beta/files.md @@ -22,7 +22,7 @@ Upload File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Upload File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaFileMetadata` @@ -214,7 +228,7 @@ List Files - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -284,6 +298,20 @@ List Files - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaFileMetadata` @@ -397,7 +425,7 @@ Download File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -467,6 +495,20 @@ Download File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `StringIO` @@ -503,7 +545,7 @@ Get File Metadata - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -573,6 +615,20 @@ Get File Metadata - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaFileMetadata` @@ -679,7 +735,7 @@ Delete File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -749,6 +805,20 @@ Delete File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaDeletedFile` diff --git a/content/en/api/ruby/beta/files/delete.md b/content/en/api/ruby/beta/files/delete.md index 98cec5c1f..abc45f738 100644 --- a/content/en/api/ruby/beta/files/delete.md +++ b/content/en/api/ruby/beta/files/delete.md @@ -18,7 +18,7 @@ Delete File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaDeletedFile` diff --git a/content/en/api/ruby/beta/files/download.md b/content/en/api/ruby/beta/files/download.md index 5af48a6de..86e2255bc 100644 --- a/content/en/api/ruby/beta/files/download.md +++ b/content/en/api/ruby/beta/files/download.md @@ -18,7 +18,7 @@ Download File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Download File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `StringIO` diff --git a/content/en/api/ruby/beta/files/list.md b/content/en/api/ruby/beta/files/list.md index e89655c85..6ba23d933 100644 --- a/content/en/api/ruby/beta/files/list.md +++ b/content/en/api/ruby/beta/files/list.md @@ -34,7 +34,7 @@ List Files - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ List Files - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaFileMetadata` diff --git a/content/en/api/ruby/beta/files/retrieve_metadata.md b/content/en/api/ruby/beta/files/retrieve_metadata.md index 5c18e3a51..1ffe8f759 100644 --- a/content/en/api/ruby/beta/files/retrieve_metadata.md +++ b/content/en/api/ruby/beta/files/retrieve_metadata.md @@ -18,7 +18,7 @@ Get File Metadata - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get File Metadata - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaFileMetadata` diff --git a/content/en/api/ruby/beta/files/upload.md b/content/en/api/ruby/beta/files/upload.md index 35021ffed..6ba88db1d 100644 --- a/content/en/api/ruby/beta/files/upload.md +++ b/content/en/api/ruby/beta/files/upload.md @@ -20,7 +20,7 @@ Upload File - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Upload File - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaFileMetadata` diff --git a/content/en/api/ruby/beta/memory_stores.md b/content/en/api/ruby/beta/memory_stores.md index c42235ff7..152f42cab 100644 --- a/content/en/api/ruby/beta/memory_stores.md +++ b/content/en/api/ruby/beta/memory_stores.md @@ -32,7 +32,7 @@ Create a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Create a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore` @@ -215,7 +229,7 @@ List memory stores - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -285,6 +299,20 @@ List memory stores - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore` @@ -379,7 +407,7 @@ Retrieve a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -449,6 +477,20 @@ Retrieve a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore` @@ -554,7 +596,7 @@ Update a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -624,6 +666,20 @@ Update a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore` @@ -713,7 +769,7 @@ Delete a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -783,6 +839,20 @@ Delete a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedMemoryStore` @@ -834,7 +904,7 @@ Archive a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -904,6 +974,20 @@ Archive a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryStore` @@ -1069,7 +1153,7 @@ Create a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1139,6 +1223,20 @@ Create a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory` @@ -1171,7 +1269,7 @@ Create a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -1264,7 +1362,7 @@ List memories - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1334,6 +1432,20 @@ List memories - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryListItem = BetaManagedAgentsMemory | BetaManagedAgentsMemoryPrefix` @@ -1370,7 +1482,7 @@ List memories - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -1460,7 +1572,7 @@ Retrieve a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1530,6 +1642,20 @@ Retrieve a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory` @@ -1562,7 +1688,7 @@ Retrieve a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -1657,7 +1783,7 @@ Update a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1727,6 +1853,20 @@ Update a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemory` @@ -1759,7 +1899,7 @@ Update a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -1830,7 +1970,7 @@ Delete a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1900,11 +2040,25 @@ Delete a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: String` @@ -2009,7 +2163,7 @@ List memory versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2079,11 +2233,25 @@ List memory versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -2097,7 +2265,7 @@ List memory versions - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` @@ -2266,7 +2434,7 @@ Retrieve a memory version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2336,11 +2504,25 @@ Retrieve a memory version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -2354,7 +2536,7 @@ Retrieve a memory version - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` @@ -2513,7 +2695,7 @@ Redact a memory version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2583,11 +2765,25 @@ Redact a memory version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -2601,7 +2797,7 @@ Redact a memory version - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` diff --git a/content/en/api/ruby/beta/memory_stores/archive.md b/content/en/api/ruby/beta/memory_stores/archive.md index 411ca852b..30e6c43ee 100644 --- a/content/en/api/ruby/beta/memory_stores/archive.md +++ b/content/en/api/ruby/beta/memory_stores/archive.md @@ -16,7 +16,7 @@ Archive a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore` diff --git a/content/en/api/ruby/beta/memory_stores/create.md b/content/en/api/ruby/beta/memory_stores/create.md index 5c8a2d63f..e5f7a52bd 100644 --- a/content/en/api/ruby/beta/memory_stores/create.md +++ b/content/en/api/ruby/beta/memory_stores/create.md @@ -30,7 +30,7 @@ Create a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Create a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore` diff --git a/content/en/api/ruby/beta/memory_stores/delete.md b/content/en/api/ruby/beta/memory_stores/delete.md index 2a65f9a1b..d4cd1a523 100644 --- a/content/en/api/ruby/beta/memory_stores/delete.md +++ b/content/en/api/ruby/beta/memory_stores/delete.md @@ -16,7 +16,7 @@ Delete a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedMemoryStore` diff --git a/content/en/api/ruby/beta/memory_stores/list.md b/content/en/api/ruby/beta/memory_stores/list.md index d13bb5c4f..994aa8c62 100644 --- a/content/en/api/ruby/beta/memory_stores/list.md +++ b/content/en/api/ruby/beta/memory_stores/list.md @@ -40,7 +40,7 @@ List memory stores - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -110,6 +110,20 @@ List memory stores - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore` diff --git a/content/en/api/ruby/beta/memory_stores/memories.md b/content/en/api/ruby/beta/memory_stores/memories.md index 0c474d82f..c084611d3 100644 --- a/content/en/api/ruby/beta/memory_stores/memories.md +++ b/content/en/api/ruby/beta/memory_stores/memories.md @@ -36,7 +36,7 @@ Create a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -106,6 +106,20 @@ Create a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemory` @@ -138,7 +152,7 @@ Create a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -231,7 +245,7 @@ List memories - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -301,6 +315,20 @@ List memories - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryListItem = BetaManagedAgentsMemory | BetaManagedAgentsMemoryPrefix` @@ -337,7 +365,7 @@ List memories - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -427,7 +455,7 @@ Retrieve a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -497,6 +525,20 @@ Retrieve a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemory` @@ -529,7 +571,7 @@ Retrieve a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -624,7 +666,7 @@ Update a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -694,6 +736,20 @@ Update a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemory` @@ -726,7 +782,7 @@ Update a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -797,7 +853,7 @@ Delete a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -867,11 +923,25 @@ Delete a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: String` @@ -926,7 +996,7 @@ puts(beta_managed_agents_deleted_memory) - `class BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: String` @@ -1046,7 +1116,7 @@ puts(beta_managed_agents_deleted_memory) - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` @@ -1100,7 +1170,7 @@ puts(beta_managed_agents_deleted_memory) - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` diff --git a/content/en/api/ruby/beta/memory_stores/memories/create.md b/content/en/api/ruby/beta/memory_stores/memories/create.md index c8f3c116c..f7a0d7208 100644 --- a/content/en/api/ruby/beta/memory_stores/memories/create.md +++ b/content/en/api/ruby/beta/memory_stores/memories/create.md @@ -34,7 +34,7 @@ Create a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ Create a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemory` @@ -136,7 +150,7 @@ Create a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` diff --git a/content/en/api/ruby/beta/memory_stores/memories/delete.md b/content/en/api/ruby/beta/memory_stores/memories/delete.md index 4a05e2364..6007584c1 100644 --- a/content/en/api/ruby/beta/memory_stores/memories/delete.md +++ b/content/en/api/ruby/beta/memory_stores/memories/delete.md @@ -22,7 +22,7 @@ Delete a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -92,11 +92,25 @@ Delete a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: String` diff --git a/content/en/api/ruby/beta/memory_stores/memories/list.md b/content/en/api/ruby/beta/memory_stores/memories/list.md index 93957cb57..793825252 100644 --- a/content/en/api/ruby/beta/memory_stores/memories/list.md +++ b/content/en/api/ruby/beta/memory_stores/memories/list.md @@ -44,7 +44,7 @@ List memories - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -114,6 +114,20 @@ List memories - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryListItem = BetaManagedAgentsMemory | BetaManagedAgentsMemoryPrefix` @@ -150,7 +164,7 @@ List memories - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` diff --git a/content/en/api/ruby/beta/memory_stores/memories/retrieve.md b/content/en/api/ruby/beta/memory_stores/memories/retrieve.md index 903ace928..83b23362f 100644 --- a/content/en/api/ruby/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/ruby/beta/memory_stores/memories/retrieve.md @@ -26,7 +26,7 @@ Retrieve a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Retrieve a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemory` @@ -128,7 +142,7 @@ Retrieve a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` diff --git a/content/en/api/ruby/beta/memory_stores/memories/update.md b/content/en/api/ruby/beta/memory_stores/memories/update.md index ed95acba6..ae8ec41b8 100644 --- a/content/en/api/ruby/beta/memory_stores/memories/update.md +++ b/content/en/api/ruby/beta/memory_stores/memories/update.md @@ -46,7 +46,7 @@ Update a memory - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -116,6 +116,20 @@ Update a memory - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemory` @@ -148,7 +162,7 @@ Update a memory - `memory_version_id: String` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: String` diff --git a/content/en/api/ruby/beta/memory_stores/memory_versions.md b/content/en/api/ruby/beta/memory_stores/memory_versions.md index 2ba575ef6..482a2956c 100644 --- a/content/en/api/ruby/beta/memory_stores/memory_versions.md +++ b/content/en/api/ruby/beta/memory_stores/memory_versions.md @@ -74,7 +74,7 @@ List memory versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -144,11 +144,25 @@ List memory versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -162,7 +176,7 @@ List memory versions - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` @@ -331,7 +345,7 @@ Retrieve a memory version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -401,11 +415,25 @@ Retrieve a memory version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -419,7 +447,7 @@ Retrieve a memory version - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` @@ -578,7 +606,7 @@ Redact a memory version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -648,11 +676,25 @@ Redact a memory version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -666,7 +708,7 @@ Redact a memory version - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` @@ -879,7 +921,7 @@ puts(beta_managed_agents_memory_version) - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -893,7 +935,7 @@ puts(beta_managed_agents_memory_version) - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` diff --git a/content/en/api/ruby/beta/memory_stores/memory_versions/list.md b/content/en/api/ruby/beta/memory_stores/memory_versions/list.md index 300a28380..1b19dc0f8 100644 --- a/content/en/api/ruby/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/ruby/beta/memory_stores/memory_versions/list.md @@ -72,7 +72,7 @@ List memory versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -142,11 +142,25 @@ List memory versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -160,7 +174,7 @@ List memory versions - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` diff --git a/content/en/api/ruby/beta/memory_stores/memory_versions/redact.md b/content/en/api/ruby/beta/memory_stores/memory_versions/redact.md index 6df8e3134..62821f1a6 100644 --- a/content/en/api/ruby/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/ruby/beta/memory_stores/memory_versions/redact.md @@ -18,7 +18,7 @@ Redact a memory version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,11 +88,25 @@ Redact a memory version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -106,7 +120,7 @@ Redact a memory version - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` diff --git a/content/en/api/ruby/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/ruby/beta/memory_stores/memory_versions/retrieve.md index 45b3653c5..52f5ddb62 100644 --- a/content/en/api/ruby/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/ruby/beta/memory_stores/memory_versions/retrieve.md @@ -26,7 +26,7 @@ Retrieve a memory version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,11 +96,25 @@ Retrieve a memory version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: String` @@ -114,7 +128,7 @@ Retrieve a memory version - `memory_id: String` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: String` diff --git a/content/en/api/ruby/beta/memory_stores/retrieve.md b/content/en/api/ruby/beta/memory_stores/retrieve.md index 0fab88128..f14b32ed1 100644 --- a/content/en/api/ruby/beta/memory_stores/retrieve.md +++ b/content/en/api/ruby/beta/memory_stores/retrieve.md @@ -16,7 +16,7 @@ Retrieve a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Retrieve a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore` diff --git a/content/en/api/ruby/beta/memory_stores/update.md b/content/en/api/ruby/beta/memory_stores/update.md index 9ef5a5098..07dd22b1f 100644 --- a/content/en/api/ruby/beta/memory_stores/update.md +++ b/content/en/api/ruby/beta/memory_stores/update.md @@ -32,7 +32,7 @@ Update a memory store - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Update a memory store - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsMemoryStore` diff --git a/content/en/api/ruby/beta/messages.md b/content/en/api/ruby/beta/messages.md index 8e1ec4d11..d6fce4efb 100644 --- a/content/en/api/ruby/beta/messages.md +++ b/content/en/api/ruby/beta/messages.md @@ -1688,7 +1688,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1696,6 +1696,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -1704,7 +1706,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1712,6 +1714,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:omitted` + - `:updates` + - `BetaFallbacksParam = :default` - `inference_geo: String` @@ -3767,7 +3771,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3837,6 +3841,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5178,12 +5196,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -5481,12 +5501,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: Integer` The cumulative number of output tokens which were used. @@ -7375,7 +7397,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -7383,6 +7405,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -7391,7 +7415,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -7399,6 +7423,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:omitted` + - `:updates` + - `tool_choice: BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -9344,7 +9370,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -9414,6 +9440,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -17705,7 +17745,7 @@ puts(beta_message_tokens_count) - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -17713,6 +17753,8 @@ puts(beta_message_tokens_count) - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -17721,7 +17763,7 @@ puts(beta_message_tokens_count) - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -17729,6 +17771,8 @@ puts(beta_message_tokens_count) - `:omitted` + - `:updates` + ### Beta Fallback Refusal Trigger - `class BetaFallbackRefusalTrigger` @@ -17915,7 +17959,7 @@ puts(beta_message_tokens_count) - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -17923,6 +17967,8 @@ puts(beta_message_tokens_count) - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -17931,7 +17977,7 @@ puts(beta_message_tokens_count) - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -17939,6 +17985,8 @@ puts(beta_message_tokens_count) - `:omitted` + - `:updates` + - `BetaFallbacksParam = :default` ### Beta File Document Source @@ -18076,12 +18124,14 @@ puts(beta_message_tokens_count) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -20166,12 +20216,14 @@ puts(beta_message_tokens_count) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -20495,12 +20547,14 @@ puts(beta_message_tokens_count) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -23851,12 +23905,14 @@ puts(beta_message_tokens_count) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -25441,12 +25497,14 @@ puts(beta_message_tokens_count) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -26981,12 +27039,14 @@ puts(beta_message_tokens_count) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -27278,12 +27338,14 @@ puts(beta_message_tokens_count) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: Integer` The cumulative number of output tokens which were used. @@ -29460,7 +29522,7 @@ puts(beta_message_tokens_count) - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -29468,6 +29530,8 @@ puts(beta_message_tokens_count) - `:omitted` + - `:updates` + ### Beta Thinking Config Disabled - `class BetaThinkingConfigDisabled` @@ -29490,7 +29554,7 @@ puts(beta_message_tokens_count) - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -29498,6 +29562,8 @@ puts(beta_message_tokens_count) - `:omitted` + - `:updates` + ### Beta Thinking Config Param - `BetaThinkingConfigParam = BetaThinkingConfigEnabled | BetaThinkingConfigDisabled | BetaThinkingConfigAdaptive` @@ -29522,7 +29588,7 @@ puts(beta_message_tokens_count) - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -29530,6 +29596,8 @@ puts(beta_message_tokens_count) - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -29538,7 +29606,7 @@ puts(beta_message_tokens_count) - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -29546,6 +29614,8 @@ puts(beta_message_tokens_count) - `:omitted` + - `:updates` + ### Beta Thinking Delta - `class BetaThinkingDelta` @@ -33368,12 +33438,14 @@ puts(beta_message_tokens_count) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -37199,7 +37271,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -37207,6 +37279,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -37215,7 +37289,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -37223,6 +37297,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:omitted` + - `:updates` + - `BetaFallbacksParam = :default` - `inference_geo: String` @@ -39322,7 +39398,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -39392,6 +39468,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -39558,7 +39648,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -39628,6 +39718,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch` @@ -39795,7 +39899,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -39865,6 +39969,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch` @@ -40029,7 +40147,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -40099,6 +40217,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatch` @@ -40256,7 +40388,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -40326,6 +40458,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaDeletedMessageBatch` @@ -40385,7 +40531,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -40455,6 +40601,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaMessageBatchIndividualResponse` @@ -41766,12 +41926,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. diff --git a/content/en/api/ruby/beta/messages/batches.md b/content/en/api/ruby/beta/messages/batches.md index a434772ad..d7980f1da 100644 --- a/content/en/api/ruby/beta/messages/batches.md +++ b/content/en/api/ruby/beta/messages/batches.md @@ -1708,7 +1708,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1716,6 +1716,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -1724,7 +1726,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1732,6 +1734,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:omitted` + - `:updates` + - `BetaFallbacksParam = :default` - `inference_geo: String` @@ -3831,7 +3835,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3901,6 +3905,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -4067,7 +4085,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4137,6 +4155,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaMessageBatch` @@ -4304,7 +4336,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4374,6 +4406,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaMessageBatch` @@ -4538,7 +4584,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4608,6 +4654,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaMessageBatch` @@ -4765,7 +4825,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4835,6 +4895,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaDeletedMessageBatch` @@ -4894,7 +4968,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4964,6 +5038,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaMessageBatchIndividualResponse` @@ -6275,12 +6363,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -8103,12 +8193,14 @@ puts(beta_message_batch_individual_response) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -9747,12 +9839,14 @@ puts(beta_message_batch_individual_response) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -11353,12 +11447,14 @@ puts(beta_message_batch_individual_response) Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. diff --git a/content/en/api/ruby/beta/messages/batches/cancel.md b/content/en/api/ruby/beta/messages/batches/cancel.md index 461060f32..da0abc767 100644 --- a/content/en/api/ruby/beta/messages/batches/cancel.md +++ b/content/en/api/ruby/beta/messages/batches/cancel.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaMessageBatch` diff --git a/content/en/api/ruby/beta/messages/batches/create.md b/content/en/api/ruby/beta/messages/batches/create.md index 21d25e929..7ba81b77d 100644 --- a/content/en/api/ruby/beta/messages/batches/create.md +++ b/content/en/api/ruby/beta/messages/batches/create.md @@ -1706,7 +1706,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1714,6 +1714,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -1722,7 +1724,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1730,6 +1732,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:omitted` + - `:updates` + - `BetaFallbacksParam = :default` - `inference_geo: String` @@ -3829,7 +3833,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3899,6 +3903,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. diff --git a/content/en/api/ruby/beta/messages/batches/delete.md b/content/en/api/ruby/beta/messages/batches/delete.md index 28925c32c..c71d0d57e 100644 --- a/content/en/api/ruby/beta/messages/batches/delete.md +++ b/content/en/api/ruby/beta/messages/batches/delete.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaDeletedMessageBatch` diff --git a/content/en/api/ruby/beta/messages/batches/list.md b/content/en/api/ruby/beta/messages/batches/list.md index 6fa4f0797..3d9ee9ba0 100644 --- a/content/en/api/ruby/beta/messages/batches/list.md +++ b/content/en/api/ruby/beta/messages/batches/list.md @@ -32,7 +32,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaMessageBatch` diff --git a/content/en/api/ruby/beta/messages/batches/results.md b/content/en/api/ruby/beta/messages/batches/results.md index ff993e361..08a1da489 100644 --- a/content/en/api/ruby/beta/messages/batches/results.md +++ b/content/en/api/ruby/beta/messages/batches/results.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaMessageBatchIndividualResponse` @@ -1403,12 +1417,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. diff --git a/content/en/api/ruby/beta/messages/batches/retrieve.md b/content/en/api/ruby/beta/messages/batches/retrieve.md index 70c0ef40a..94ceb01f2 100644 --- a/content/en/api/ruby/beta/messages/batches/retrieve.md +++ b/content/en/api/ruby/beta/messages/batches/retrieve.md @@ -20,7 +20,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaMessageBatch` diff --git a/content/en/api/ruby/beta/messages/count_tokens.md b/content/en/api/ruby/beta/messages/count_tokens.md index 34c529de8..d624de95a 100644 --- a/content/en/api/ruby/beta/messages/count_tokens.md +++ b/content/en/api/ruby/beta/messages/count_tokens.md @@ -1610,7 +1610,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1618,6 +1618,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -1626,7 +1628,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1634,6 +1636,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:omitted` + - `:updates` + - `tool_choice: BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -3579,7 +3583,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3649,6 +3653,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. diff --git a/content/en/api/ruby/beta/messages/create.md b/content/en/api/ruby/beta/messages/create.md index 9159040c9..2ec2f318a 100644 --- a/content/en/api/ruby/beta/messages/create.md +++ b/content/en/api/ruby/beta/messages/create.md @@ -1686,7 +1686,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: :enabled` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1694,6 +1694,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:omitted` + - `:updates` + - `class BetaThinkingConfigDisabled` - `type: :disabled` @@ -1702,7 +1704,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: :adaptive` - - `display_: :summarized | :omitted` + - `display_: :summarized | :omitted | :updates` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1710,6 +1712,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:omitted` + - `:updates` + - `BetaFallbacksParam = :default` - `inference_geo: String` @@ -3765,7 +3769,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3835,6 +3839,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `user_profile_id: String` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5176,12 +5194,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `class BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -5479,12 +5499,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: Integer` The cumulative number of output tokens which were used. diff --git a/content/en/api/ruby/beta/models.md b/content/en/api/ruby/beta/models.md index c33bb52d5..08c5dd3ab 100644 --- a/content/en/api/ruby/beta/models.md +++ b/content/en/api/ruby/beta/models.md @@ -34,7 +34,7 @@ The Models API response can be used to determine which models are available for - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaModelInfo` @@ -358,7 +372,7 @@ The Models API response can be used to determine information about a specific mo - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -428,6 +442,20 @@ The Models API response can be used to determine information about a specific mo - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaModelInfo` diff --git a/content/en/api/ruby/beta/models/list.md b/content/en/api/ruby/beta/models/list.md index 4ac9733d3..9fcbb9ccd 100644 --- a/content/en/api/ruby/beta/models/list.md +++ b/content/en/api/ruby/beta/models/list.md @@ -32,7 +32,7 @@ The Models API response can be used to determine which models are available for - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaModelInfo` diff --git a/content/en/api/ruby/beta/models/retrieve.md b/content/en/api/ruby/beta/models/retrieve.md index 6ac816acc..8489c899e 100644 --- a/content/en/api/ruby/beta/models/retrieve.md +++ b/content/en/api/ruby/beta/models/retrieve.md @@ -20,7 +20,7 @@ The Models API response can be used to determine information about a specific mo - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ The Models API response can be used to determine information about a specific mo - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaModelInfo` diff --git a/content/en/api/ruby/beta/sessions.md b/content/en/api/ruby/beta/sessions.md index ded158294..5dd87ea3f 100644 --- a/content/en/api/ruby/beta/sessions.md +++ b/content/en/api/ruby/beta/sessions.md @@ -980,7 +980,7 @@ Create Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1050,6 +1050,20 @@ Create Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession` @@ -2185,7 +2199,7 @@ List Sessions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2255,6 +2269,20 @@ List Sessions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession` @@ -3319,7 +3347,7 @@ Get Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3389,6 +3417,20 @@ Get Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession` @@ -4885,7 +4927,7 @@ Update Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -4955,6 +4997,20 @@ Update Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession` @@ -6013,7 +6069,7 @@ Delete Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -6083,6 +6139,20 @@ Delete Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedSession` @@ -6132,7 +6202,7 @@ Archive Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -6202,6 +6272,20 @@ Archive Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSession` @@ -11760,7 +11844,7 @@ List Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -11830,6 +11914,20 @@ List Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -14382,7 +14480,7 @@ Send Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -14452,6 +14550,20 @@ Send Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSendSessionEvents` @@ -14959,7 +15071,7 @@ Stream Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -15029,6 +15141,20 @@ Stream Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` @@ -17275,7 +17401,7 @@ Add Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -17345,6 +17471,20 @@ Add Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsFileResource` @@ -17426,7 +17566,7 @@ List Session Resources - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -17496,6 +17636,20 @@ List Session Resources - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionResource = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -17666,7 +17820,7 @@ Get Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -17736,6 +17890,20 @@ Get Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `ResourceRetrieveResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -17902,7 +18070,7 @@ Update Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -17972,6 +18140,20 @@ Update Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `ResourceUpdateResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -18133,7 +18315,7 @@ Delete Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -18203,6 +18385,20 @@ Delete Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeleteSessionResource` @@ -18267,7 +18463,7 @@ List Session Threads - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -18337,6 +18533,20 @@ List Session Threads - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread` @@ -18349,7 +18559,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -19095,7 +19305,7 @@ Get Session Thread - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -19165,6 +19375,20 @@ Get Session Thread - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread` @@ -19177,7 +19401,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -19921,7 +20145,7 @@ Archive Session Thread - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -19991,6 +20215,20 @@ Archive Session Thread - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsSessionThread` @@ -20003,7 +20241,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -20759,7 +20997,7 @@ List Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -20829,6 +21067,20 @@ List Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -23021,7 +23273,7 @@ Stream Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -23091,6 +23343,20 @@ Stream Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/ruby/beta/sessions/archive.md b/content/en/api/ruby/beta/sessions/archive.md index 6e4ce384d..df71e8088 100644 --- a/content/en/api/ruby/beta/sessions/archive.md +++ b/content/en/api/ruby/beta/sessions/archive.md @@ -16,7 +16,7 @@ Archive Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession` diff --git a/content/en/api/ruby/beta/sessions/create.md b/content/en/api/ruby/beta/sessions/create.md index 51cf9ae1e..ad9e84e9e 100644 --- a/content/en/api/ruby/beta/sessions/create.md +++ b/content/en/api/ruby/beta/sessions/create.md @@ -978,7 +978,7 @@ Create Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1048,6 +1048,20 @@ Create Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession` diff --git a/content/en/api/ruby/beta/sessions/delete.md b/content/en/api/ruby/beta/sessions/delete.md index 1095a04ae..b7b358e73 100644 --- a/content/en/api/ruby/beta/sessions/delete.md +++ b/content/en/api/ruby/beta/sessions/delete.md @@ -16,7 +16,7 @@ Delete Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedSession` diff --git a/content/en/api/ruby/beta/sessions/events.md b/content/en/api/ruby/beta/sessions/events.md index 723ffe69a..1ee34e171 100644 --- a/content/en/api/ruby/beta/sessions/events.md +++ b/content/en/api/ruby/beta/sessions/events.md @@ -64,7 +64,7 @@ List Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -134,6 +134,20 @@ List Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -2686,7 +2700,7 @@ Send Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2756,6 +2770,20 @@ Send Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSendSessionEvents` @@ -3263,7 +3291,7 @@ Stream Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -3333,6 +3361,20 @@ Stream Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/ruby/beta/sessions/events/list.md b/content/en/api/ruby/beta/sessions/events/list.md index 02d268c8c..ba9a6d1e7 100644 --- a/content/en/api/ruby/beta/sessions/events/list.md +++ b/content/en/api/ruby/beta/sessions/events/list.md @@ -62,7 +62,7 @@ List Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -132,6 +132,20 @@ List Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` diff --git a/content/en/api/ruby/beta/sessions/events/send.md b/content/en/api/ruby/beta/sessions/events/send.md index 36ca7dd86..b89638f09 100644 --- a/content/en/api/ruby/beta/sessions/events/send.md +++ b/content/en/api/ruby/beta/sessions/events/send.md @@ -378,7 +378,7 @@ Send Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -448,6 +448,20 @@ Send Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSendSessionEvents` diff --git a/content/en/api/ruby/beta/sessions/events/stream.md b/content/en/api/ruby/beta/sessions/events/stream.md index aed4ed754..88ab44d16 100644 --- a/content/en/api/ruby/beta/sessions/events/stream.md +++ b/content/en/api/ruby/beta/sessions/events/stream.md @@ -24,7 +24,7 @@ Stream Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Stream Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/ruby/beta/sessions/list.md b/content/en/api/ruby/beta/sessions/list.md index e7f179c5e..afc101c25 100644 --- a/content/en/api/ruby/beta/sessions/list.md +++ b/content/en/api/ruby/beta/sessions/list.md @@ -90,7 +90,7 @@ List Sessions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -160,6 +160,20 @@ List Sessions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession` diff --git a/content/en/api/ruby/beta/sessions/resources.md b/content/en/api/ruby/beta/sessions/resources.md index 738951745..5b2e9a2b5 100644 --- a/content/en/api/ruby/beta/sessions/resources.md +++ b/content/en/api/ruby/beta/sessions/resources.md @@ -32,7 +32,7 @@ Add Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Add Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsFileResource` @@ -183,7 +197,7 @@ List Session Resources - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -253,6 +267,20 @@ List Session Resources - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionResource = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -423,7 +451,7 @@ Get Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -493,6 +521,20 @@ Get Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `ResourceRetrieveResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -659,7 +701,7 @@ Update Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -729,6 +771,20 @@ Update Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `ResourceUpdateResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -890,7 +946,7 @@ Delete Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -960,6 +1016,20 @@ Delete Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeleteSessionResource` diff --git a/content/en/api/ruby/beta/sessions/resources/add.md b/content/en/api/ruby/beta/sessions/resources/add.md index 8c9bf0b5f..31714a396 100644 --- a/content/en/api/ruby/beta/sessions/resources/add.md +++ b/content/en/api/ruby/beta/sessions/resources/add.md @@ -30,7 +30,7 @@ Add Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Add Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsFileResource` diff --git a/content/en/api/ruby/beta/sessions/resources/delete.md b/content/en/api/ruby/beta/sessions/resources/delete.md index 0f06361e1..ca990b3ef 100644 --- a/content/en/api/ruby/beta/sessions/resources/delete.md +++ b/content/en/api/ruby/beta/sessions/resources/delete.md @@ -18,7 +18,7 @@ Delete Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeleteSessionResource` diff --git a/content/en/api/ruby/beta/sessions/resources/list.md b/content/en/api/ruby/beta/sessions/resources/list.md index be344818f..befdd9f13 100644 --- a/content/en/api/ruby/beta/sessions/resources/list.md +++ b/content/en/api/ruby/beta/sessions/resources/list.md @@ -26,7 +26,7 @@ List Session Resources - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ List Session Resources - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionResource = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` diff --git a/content/en/api/ruby/beta/sessions/resources/retrieve.md b/content/en/api/ruby/beta/sessions/resources/retrieve.md index 04632ee7f..78d43863e 100644 --- a/content/en/api/ruby/beta/sessions/resources/retrieve.md +++ b/content/en/api/ruby/beta/sessions/resources/retrieve.md @@ -18,7 +18,7 @@ Get Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `ResourceRetrieveResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` diff --git a/content/en/api/ruby/beta/sessions/resources/update.md b/content/en/api/ruby/beta/sessions/resources/update.md index d09a2b1a2..43f85f27a 100644 --- a/content/en/api/ruby/beta/sessions/resources/update.md +++ b/content/en/api/ruby/beta/sessions/resources/update.md @@ -24,7 +24,7 @@ Update Session Resource - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Update Session Resource - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `ResourceUpdateResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` diff --git a/content/en/api/ruby/beta/sessions/retrieve.md b/content/en/api/ruby/beta/sessions/retrieve.md index 46f6817f6..d788af408 100644 --- a/content/en/api/ruby/beta/sessions/retrieve.md +++ b/content/en/api/ruby/beta/sessions/retrieve.md @@ -16,7 +16,7 @@ Get Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession` diff --git a/content/en/api/ruby/beta/sessions/threads.md b/content/en/api/ruby/beta/sessions/threads.md index f7d3553eb..bc73f15e0 100644 --- a/content/en/api/ruby/beta/sessions/threads.md +++ b/content/en/api/ruby/beta/sessions/threads.md @@ -28,7 +28,7 @@ List Session Threads - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Session Threads - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSessionThread` @@ -110,7 +124,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -856,7 +870,7 @@ Get Session Thread - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -926,6 +940,20 @@ Get Session Thread - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSessionThread` @@ -938,7 +966,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -1682,7 +1710,7 @@ Archive Session Thread - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1752,6 +1780,20 @@ Archive Session Thread - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsSessionThread` @@ -1764,7 +1806,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -2502,7 +2544,7 @@ puts(beta_managed_agents_session_thread) - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` @@ -5446,7 +5488,7 @@ List Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -5516,6 +5558,20 @@ List Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -7708,7 +7764,7 @@ Stream Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -7778,6 +7834,20 @@ Stream Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/ruby/beta/sessions/threads/archive.md b/content/en/api/ruby/beta/sessions/threads/archive.md index b490a0acf..a55914a8e 100644 --- a/content/en/api/ruby/beta/sessions/threads/archive.md +++ b/content/en/api/ruby/beta/sessions/threads/archive.md @@ -18,7 +18,7 @@ Archive Session Thread - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Session Thread - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSessionThread` @@ -100,7 +114,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` diff --git a/content/en/api/ruby/beta/sessions/threads/events.md b/content/en/api/ruby/beta/sessions/threads/events.md index e6822e3f4..acd4d760a 100644 --- a/content/en/api/ruby/beta/sessions/threads/events.md +++ b/content/en/api/ruby/beta/sessions/threads/events.md @@ -30,7 +30,7 @@ List Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -2292,7 +2306,7 @@ Stream Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2362,6 +2376,20 @@ Stream Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/ruby/beta/sessions/threads/events/list.md b/content/en/api/ruby/beta/sessions/threads/events/list.md index bb6189a05..0a37e609c 100644 --- a/content/en/api/ruby/beta/sessions/threads/events/list.md +++ b/content/en/api/ruby/beta/sessions/threads/events/list.md @@ -28,7 +28,7 @@ List Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` diff --git a/content/en/api/ruby/beta/sessions/threads/events/stream.md b/content/en/api/ruby/beta/sessions/threads/events/stream.md index 34cabff84..4469aa953 100644 --- a/content/en/api/ruby/beta/sessions/threads/events/stream.md +++ b/content/en/api/ruby/beta/sessions/threads/events/stream.md @@ -26,7 +26,7 @@ Stream Session Thread Events - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Stream Session Thread Events - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/ruby/beta/sessions/threads/list.md b/content/en/api/ruby/beta/sessions/threads/list.md index 5168660e8..45a264c69 100644 --- a/content/en/api/ruby/beta/sessions/threads/list.md +++ b/content/en/api/ruby/beta/sessions/threads/list.md @@ -26,7 +26,7 @@ List Session Threads - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ List Session Threads - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSessionThread` @@ -108,7 +122,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` diff --git a/content/en/api/ruby/beta/sessions/threads/retrieve.md b/content/en/api/ruby/beta/sessions/threads/retrieve.md index 04e75eb18..6af1bde98 100644 --- a/content/en/api/ruby/beta/sessions/threads/retrieve.md +++ b/content/en/api/ruby/beta/sessions/threads/retrieve.md @@ -18,7 +18,7 @@ Get Session Thread - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Session Thread - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSessionThread` @@ -100,7 +114,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `class BetaManagedAgentsSessionThreadAgent` diff --git a/content/en/api/ruby/beta/sessions/update.md b/content/en/api/ruby/beta/sessions/update.md index 0290cedba..3d931b7c6 100644 --- a/content/en/api/ruby/beta/sessions/update.md +++ b/content/en/api/ruby/beta/sessions/update.md @@ -454,7 +454,7 @@ Update Session - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -524,6 +524,20 @@ Update Session - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsSession` diff --git a/content/en/api/ruby/beta/skills.md b/content/en/api/ruby/beta/skills.md index 273f6579e..c0600fd46 100644 --- a/content/en/api/ruby/beta/skills.md +++ b/content/en/api/ruby/beta/skills.md @@ -28,7 +28,7 @@ Create Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Create Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class SkillCreateResponse` @@ -206,7 +220,7 @@ List Skills - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -276,6 +290,20 @@ List Skills - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class SkillListResponse` @@ -375,7 +403,7 @@ Get Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -445,6 +473,20 @@ Get Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class SkillRetrieveResponse` @@ -538,7 +580,7 @@ Delete Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -608,6 +650,20 @@ Delete Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class SkillDeleteResponse` @@ -828,7 +884,7 @@ Create Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -898,6 +954,20 @@ Create Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class VersionCreateResponse` @@ -1005,7 +1075,7 @@ List Skill Versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1075,6 +1145,20 @@ List Skill Versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class VersionListResponse` @@ -1184,7 +1268,7 @@ Download a skill version's content as a zip archive. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1254,6 +1338,20 @@ Download a skill version's content as a zip archive. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `StringIO` @@ -1298,7 +1396,7 @@ Get Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1368,6 +1466,20 @@ Get Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class VersionRetrieveResponse` @@ -1471,7 +1583,7 @@ Delete Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1541,6 +1653,20 @@ Delete Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class VersionDeleteResponse` diff --git a/content/en/api/ruby/beta/skills/create.md b/content/en/api/ruby/beta/skills/create.md index 8932d345b..3465914e5 100644 --- a/content/en/api/ruby/beta/skills/create.md +++ b/content/en/api/ruby/beta/skills/create.md @@ -26,7 +26,7 @@ Create Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Create Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class SkillCreateResponse` diff --git a/content/en/api/ruby/beta/skills/delete.md b/content/en/api/ruby/beta/skills/delete.md index 5631ff3e8..bfe5af8d6 100644 --- a/content/en/api/ruby/beta/skills/delete.md +++ b/content/en/api/ruby/beta/skills/delete.md @@ -20,7 +20,7 @@ Delete Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Delete Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class SkillDeleteResponse` diff --git a/content/en/api/ruby/beta/skills/list.md b/content/en/api/ruby/beta/skills/list.md index e9331cae8..660b7d50d 100644 --- a/content/en/api/ruby/beta/skills/list.md +++ b/content/en/api/ruby/beta/skills/list.md @@ -35,7 +35,7 @@ List Skills - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -105,6 +105,20 @@ List Skills - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class SkillListResponse` diff --git a/content/en/api/ruby/beta/skills/retrieve.md b/content/en/api/ruby/beta/skills/retrieve.md index d60e57355..c7e8d285e 100644 --- a/content/en/api/ruby/beta/skills/retrieve.md +++ b/content/en/api/ruby/beta/skills/retrieve.md @@ -20,7 +20,7 @@ Get Skill - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Get Skill - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class SkillRetrieveResponse` diff --git a/content/en/api/ruby/beta/skills/versions.md b/content/en/api/ruby/beta/skills/versions.md index e46c12d53..5d1d38522 100644 --- a/content/en/api/ruby/beta/skills/versions.md +++ b/content/en/api/ruby/beta/skills/versions.md @@ -28,7 +28,7 @@ Create Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Create Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class VersionCreateResponse` @@ -205,7 +219,7 @@ List Skill Versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -275,6 +289,20 @@ List Skill Versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class VersionListResponse` @@ -384,7 +412,7 @@ Download a skill version's content as a zip archive. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -454,6 +482,20 @@ Download a skill version's content as a zip archive. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `StringIO` @@ -498,7 +540,7 @@ Get Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -568,6 +610,20 @@ Get Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class VersionRetrieveResponse` @@ -671,7 +727,7 @@ Delete Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -741,6 +797,20 @@ Delete Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class VersionDeleteResponse` diff --git a/content/en/api/ruby/beta/skills/versions/create.md b/content/en/api/ruby/beta/skills/versions/create.md index 6dec2b5a0..5661a0a48 100644 --- a/content/en/api/ruby/beta/skills/versions/create.md +++ b/content/en/api/ruby/beta/skills/versions/create.md @@ -26,7 +26,7 @@ Create Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Create Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class VersionCreateResponse` diff --git a/content/en/api/ruby/beta/skills/versions/delete.md b/content/en/api/ruby/beta/skills/versions/delete.md index 10dc7b529..4dbe16746 100644 --- a/content/en/api/ruby/beta/skills/versions/delete.md +++ b/content/en/api/ruby/beta/skills/versions/delete.md @@ -26,7 +26,7 @@ Delete Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Delete Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class VersionDeleteResponse` diff --git a/content/en/api/ruby/beta/skills/versions/download.md b/content/en/api/ruby/beta/skills/versions/download.md index 5311c59eb..a2d601f83 100644 --- a/content/en/api/ruby/beta/skills/versions/download.md +++ b/content/en/api/ruby/beta/skills/versions/download.md @@ -26,7 +26,7 @@ Download a skill version's content as a zip archive. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Download a skill version's content as a zip archive. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `StringIO` diff --git a/content/en/api/ruby/beta/skills/versions/list.md b/content/en/api/ruby/beta/skills/versions/list.md index 566cc3a29..a24c2963c 100644 --- a/content/en/api/ruby/beta/skills/versions/list.md +++ b/content/en/api/ruby/beta/skills/versions/list.md @@ -30,7 +30,7 @@ List Skill Versions - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Skill Versions - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class VersionListResponse` diff --git a/content/en/api/ruby/beta/skills/versions/retrieve.md b/content/en/api/ruby/beta/skills/versions/retrieve.md index f181d65e7..5f274363d 100644 --- a/content/en/api/ruby/beta/skills/versions/retrieve.md +++ b/content/en/api/ruby/beta/skills/versions/retrieve.md @@ -26,7 +26,7 @@ Get Skill Version - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Get Skill Version - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class VersionRetrieveResponse` diff --git a/content/en/api/ruby/beta/tunnels.md b/content/en/api/ruby/beta/tunnels.md index 06d6c7d49..4ab2a9f6a 100644 --- a/content/en/api/ruby/beta/tunnels.md +++ b/content/en/api/ruby/beta/tunnels.md @@ -24,7 +24,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnel` @@ -171,7 +185,7 @@ Fetches a tunnel by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -241,6 +255,20 @@ Fetches a tunnel by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnel` @@ -330,7 +358,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -400,6 +428,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnel` @@ -482,7 +524,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -552,6 +594,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnel` @@ -629,7 +685,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -699,6 +755,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelToken` @@ -763,7 +833,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -833,6 +903,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelToken` @@ -949,7 +1033,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1019,6 +1103,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelCertificate` @@ -1105,7 +1203,7 @@ Fetches a tunnel certificate by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1175,6 +1273,20 @@ Fetches a tunnel certificate by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelCertificate` @@ -1273,7 +1385,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1343,6 +1455,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelCertificate` @@ -1434,7 +1560,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1504,6 +1630,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaTunnelCertificate` diff --git a/content/en/api/ruby/beta/tunnels/archive.md b/content/en/api/ruby/beta/tunnels/archive.md index f4e47abde..6b30ad6d2 100644 --- a/content/en/api/ruby/beta/tunnels/archive.md +++ b/content/en/api/ruby/beta/tunnels/archive.md @@ -18,7 +18,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnel` diff --git a/content/en/api/ruby/beta/tunnels/certificates.md b/content/en/api/ruby/beta/tunnels/certificates.md index 99301e3b6..37b731b07 100644 --- a/content/en/api/ruby/beta/tunnels/certificates.md +++ b/content/en/api/ruby/beta/tunnels/certificates.md @@ -26,7 +26,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelCertificate` @@ -182,7 +196,7 @@ Fetches a tunnel certificate by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -252,6 +266,20 @@ Fetches a tunnel certificate by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelCertificate` @@ -350,7 +378,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -420,6 +448,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelCertificate` @@ -511,7 +553,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -581,6 +623,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaTunnelCertificate` diff --git a/content/en/api/ruby/beta/tunnels/certificates/archive.md b/content/en/api/ruby/beta/tunnels/certificates/archive.md index 218b748d6..71e23b2a5 100644 --- a/content/en/api/ruby/beta/tunnels/certificates/archive.md +++ b/content/en/api/ruby/beta/tunnels/certificates/archive.md @@ -20,7 +20,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelCertificate` diff --git a/content/en/api/ruby/beta/tunnels/certificates/create.md b/content/en/api/ruby/beta/tunnels/certificates/create.md index 75e5c3568..b5b6eb008 100644 --- a/content/en/api/ruby/beta/tunnels/certificates/create.md +++ b/content/en/api/ruby/beta/tunnels/certificates/create.md @@ -24,7 +24,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelCertificate` diff --git a/content/en/api/ruby/beta/tunnels/certificates/list.md b/content/en/api/ruby/beta/tunnels/certificates/list.md index 4e5bd7336..d37c7989d 100644 --- a/content/en/api/ruby/beta/tunnels/certificates/list.md +++ b/content/en/api/ruby/beta/tunnels/certificates/list.md @@ -32,7 +32,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelCertificate` diff --git a/content/en/api/ruby/beta/tunnels/certificates/retrieve.md b/content/en/api/ruby/beta/tunnels/certificates/retrieve.md index a51e0ff87..6c2a269c2 100644 --- a/content/en/api/ruby/beta/tunnels/certificates/retrieve.md +++ b/content/en/api/ruby/beta/tunnels/certificates/retrieve.md @@ -20,7 +20,7 @@ Fetches a tunnel certificate by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Fetches a tunnel certificate by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelCertificate` diff --git a/content/en/api/ruby/beta/tunnels/create.md b/content/en/api/ruby/beta/tunnels/create.md index c12225911..3a5f33229 100644 --- a/content/en/api/ruby/beta/tunnels/create.md +++ b/content/en/api/ruby/beta/tunnels/create.md @@ -22,7 +22,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnel` diff --git a/content/en/api/ruby/beta/tunnels/list.md b/content/en/api/ruby/beta/tunnels/list.md index 4c660feca..32df37b0d 100644 --- a/content/en/api/ruby/beta/tunnels/list.md +++ b/content/en/api/ruby/beta/tunnels/list.md @@ -30,7 +30,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnel` diff --git a/content/en/api/ruby/beta/tunnels/retrieve.md b/content/en/api/ruby/beta/tunnels/retrieve.md index ccdac905e..f317e4cca 100644 --- a/content/en/api/ruby/beta/tunnels/retrieve.md +++ b/content/en/api/ruby/beta/tunnels/retrieve.md @@ -18,7 +18,7 @@ Fetches a tunnel by ID. - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Fetches a tunnel by ID. - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnel` diff --git a/content/en/api/ruby/beta/tunnels/reveal_token.md b/content/en/api/ruby/beta/tunnels/reveal_token.md index f1f159d3b..6749217ab 100644 --- a/content/en/api/ruby/beta/tunnels/reveal_token.md +++ b/content/en/api/ruby/beta/tunnels/reveal_token.md @@ -18,7 +18,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelToken` diff --git a/content/en/api/ruby/beta/tunnels/rotate_token.md b/content/en/api/ruby/beta/tunnels/rotate_token.md index 50b65604d..99fa25e9f 100644 --- a/content/en/api/ruby/beta/tunnels/rotate_token.md +++ b/content/en/api/ruby/beta/tunnels/rotate_token.md @@ -24,7 +24,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaTunnelToken` diff --git a/content/en/api/ruby/beta/user_profiles.md b/content/en/api/ruby/beta/user_profiles.md index e0d838f75..aa277b960 100644 --- a/content/en/api/ruby/beta/user_profiles.md +++ b/content/en/api/ruby/beta/user_profiles.md @@ -50,7 +50,7 @@ Create User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -120,6 +120,20 @@ Create User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfile` @@ -255,7 +269,7 @@ List User Profiles - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -325,6 +339,20 @@ List User Profiles - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfile` @@ -449,7 +477,7 @@ Get User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -519,6 +547,20 @@ Get User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfile` @@ -672,7 +714,7 @@ Update User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -742,6 +784,20 @@ Update User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfile` @@ -861,7 +917,7 @@ Create Enrollment URL - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -931,6 +987,20 @@ Create Enrollment URL - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaUserProfileEnrollmentURL` diff --git a/content/en/api/ruby/beta/user_profiles/create.md b/content/en/api/ruby/beta/user_profiles/create.md index d0993fb5d..6a39eaf29 100644 --- a/content/en/api/ruby/beta/user_profiles/create.md +++ b/content/en/api/ruby/beta/user_profiles/create.md @@ -48,7 +48,7 @@ Create User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -118,6 +118,20 @@ Create User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfile` diff --git a/content/en/api/ruby/beta/user_profiles/create_enrollment_url.md b/content/en/api/ruby/beta/user_profiles/create_enrollment_url.md index d8b0ca54e..a917e0d77 100644 --- a/content/en/api/ruby/beta/user_profiles/create_enrollment_url.md +++ b/content/en/api/ruby/beta/user_profiles/create_enrollment_url.md @@ -16,7 +16,7 @@ Create Enrollment URL - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Create Enrollment URL - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfileEnrollmentURL` diff --git a/content/en/api/ruby/beta/user_profiles/list.md b/content/en/api/ruby/beta/user_profiles/list.md index 8b8ee6e46..9c47f5f3e 100644 --- a/content/en/api/ruby/beta/user_profiles/list.md +++ b/content/en/api/ruby/beta/user_profiles/list.md @@ -32,7 +32,7 @@ List User Profiles - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List User Profiles - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfile` diff --git a/content/en/api/ruby/beta/user_profiles/retrieve.md b/content/en/api/ruby/beta/user_profiles/retrieve.md index 48d129305..38850ed45 100644 --- a/content/en/api/ruby/beta/user_profiles/retrieve.md +++ b/content/en/api/ruby/beta/user_profiles/retrieve.md @@ -16,7 +16,7 @@ Get User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfile` diff --git a/content/en/api/ruby/beta/user_profiles/update.md b/content/en/api/ruby/beta/user_profiles/update.md index 91f46d2e2..ac55f47e9 100644 --- a/content/en/api/ruby/beta/user_profiles/update.md +++ b/content/en/api/ruby/beta/user_profiles/update.md @@ -50,7 +50,7 @@ Update User Profile - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -120,6 +120,20 @@ Update User Profile - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaUserProfile` diff --git a/content/en/api/ruby/beta/vaults.md b/content/en/api/ruby/beta/vaults.md index 596ac0c39..4e97bbfaf 100644 --- a/content/en/api/ruby/beta/vaults.md +++ b/content/en/api/ruby/beta/vaults.md @@ -26,7 +26,7 @@ Create Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Create Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault` @@ -192,7 +206,7 @@ List Vaults - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -262,6 +276,20 @@ List Vaults - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault` @@ -351,7 +379,7 @@ Get Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -421,6 +449,20 @@ Get Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault` @@ -515,7 +557,7 @@ Update Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -585,6 +627,20 @@ Update Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault` @@ -669,7 +725,7 @@ Delete Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -739,6 +795,20 @@ Delete Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedVault` @@ -790,7 +860,7 @@ Archive Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -860,6 +930,20 @@ Archive Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsVault` @@ -1172,7 +1256,7 @@ Create Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1242,6 +1326,20 @@ Create Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -1470,7 +1568,7 @@ List Credentials - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1540,6 +1638,20 @@ List Credentials - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -1754,7 +1866,7 @@ Get Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1824,6 +1936,20 @@ Get Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -2168,7 +2294,7 @@ Update Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2238,6 +2364,20 @@ Update Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -2450,7 +2590,7 @@ Delete Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2520,6 +2660,20 @@ Delete Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsDeletedCredential` @@ -2576,7 +2730,7 @@ Archive Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2646,6 +2800,20 @@ Archive Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredential` @@ -2858,7 +3026,7 @@ Validate Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -2928,6 +3096,20 @@ Validate Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + #### Returns - `class BetaManagedAgentsCredentialValidation` diff --git a/content/en/api/ruby/beta/vaults/archive.md b/content/en/api/ruby/beta/vaults/archive.md index 6cfd9427b..56b7f585f 100644 --- a/content/en/api/ruby/beta/vaults/archive.md +++ b/content/en/api/ruby/beta/vaults/archive.md @@ -16,7 +16,7 @@ Archive Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Archive Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault` diff --git a/content/en/api/ruby/beta/vaults/create.md b/content/en/api/ruby/beta/vaults/create.md index d38523c7d..3cf191791 100644 --- a/content/en/api/ruby/beta/vaults/create.md +++ b/content/en/api/ruby/beta/vaults/create.md @@ -24,7 +24,7 @@ Create Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Create Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault` diff --git a/content/en/api/ruby/beta/vaults/credentials.md b/content/en/api/ruby/beta/vaults/credentials.md index ea5d19c5b..82482c2c7 100644 --- a/content/en/api/ruby/beta/vaults/credentials.md +++ b/content/en/api/ruby/beta/vaults/credentials.md @@ -192,7 +192,7 @@ Create Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -262,6 +262,20 @@ Create Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential` @@ -490,7 +504,7 @@ List Credentials - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -560,6 +574,20 @@ List Credentials - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential` @@ -774,7 +802,7 @@ Get Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -844,6 +872,20 @@ Get Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential` @@ -1188,7 +1230,7 @@ Update Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1258,6 +1300,20 @@ Update Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential` @@ -1470,7 +1526,7 @@ Delete Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1540,6 +1596,20 @@ Delete Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsDeletedCredential` @@ -1596,7 +1666,7 @@ Archive Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1666,6 +1736,20 @@ Archive Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredential` @@ -1878,7 +1962,7 @@ Validate Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -1948,6 +2032,20 @@ Validate Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class BetaManagedAgentsCredentialValidation` diff --git a/content/en/api/ruby/beta/vaults/credentials/archive.md b/content/en/api/ruby/beta/vaults/credentials/archive.md index 2a9359c4a..75808e73c 100644 --- a/content/en/api/ruby/beta/vaults/credentials/archive.md +++ b/content/en/api/ruby/beta/vaults/credentials/archive.md @@ -18,7 +18,7 @@ Archive Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential` diff --git a/content/en/api/ruby/beta/vaults/credentials/create.md b/content/en/api/ruby/beta/vaults/credentials/create.md index bb71b67fb..fc9044880 100644 --- a/content/en/api/ruby/beta/vaults/credentials/create.md +++ b/content/en/api/ruby/beta/vaults/credentials/create.md @@ -190,7 +190,7 @@ Create Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -260,6 +260,20 @@ Create Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential` diff --git a/content/en/api/ruby/beta/vaults/credentials/delete.md b/content/en/api/ruby/beta/vaults/credentials/delete.md index b10708fa1..d562c64af 100644 --- a/content/en/api/ruby/beta/vaults/credentials/delete.md +++ b/content/en/api/ruby/beta/vaults/credentials/delete.md @@ -18,7 +18,7 @@ Delete Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedCredential` diff --git a/content/en/api/ruby/beta/vaults/credentials/list.md b/content/en/api/ruby/beta/vaults/credentials/list.md index 9f97887f8..d7df7474f 100644 --- a/content/en/api/ruby/beta/vaults/credentials/list.md +++ b/content/en/api/ruby/beta/vaults/credentials/list.md @@ -30,7 +30,7 @@ List Credentials - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Credentials - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential` diff --git a/content/en/api/ruby/beta/vaults/credentials/mcp_oauth_validate.md b/content/en/api/ruby/beta/vaults/credentials/mcp_oauth_validate.md index ff3a1f69b..5b5a0f703 100644 --- a/content/en/api/ruby/beta/vaults/credentials/mcp_oauth_validate.md +++ b/content/en/api/ruby/beta/vaults/credentials/mcp_oauth_validate.md @@ -18,7 +18,7 @@ Validate Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Validate Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredentialValidation` diff --git a/content/en/api/ruby/beta/vaults/credentials/retrieve.md b/content/en/api/ruby/beta/vaults/credentials/retrieve.md index 3dac72fb2..5582dbb1a 100644 --- a/content/en/api/ruby/beta/vaults/credentials/retrieve.md +++ b/content/en/api/ruby/beta/vaults/credentials/retrieve.md @@ -18,7 +18,7 @@ Get Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential` diff --git a/content/en/api/ruby/beta/vaults/credentials/update.md b/content/en/api/ruby/beta/vaults/credentials/update.md index d67a509f4..da9292e29 100644 --- a/content/en/api/ruby/beta/vaults/credentials/update.md +++ b/content/en/api/ruby/beta/vaults/credentials/update.md @@ -150,7 +150,7 @@ Update Credential - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -220,6 +220,20 @@ Update Credential - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsCredential` diff --git a/content/en/api/ruby/beta/vaults/delete.md b/content/en/api/ruby/beta/vaults/delete.md index 16b3592fa..1e5fcf74e 100644 --- a/content/en/api/ruby/beta/vaults/delete.md +++ b/content/en/api/ruby/beta/vaults/delete.md @@ -16,7 +16,7 @@ Delete Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Delete Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsDeletedVault` diff --git a/content/en/api/ruby/beta/vaults/list.md b/content/en/api/ruby/beta/vaults/list.md index b03fd141e..be902b47c 100644 --- a/content/en/api/ruby/beta/vaults/list.md +++ b/content/en/api/ruby/beta/vaults/list.md @@ -28,7 +28,7 @@ List Vaults - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Vaults - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault` diff --git a/content/en/api/ruby/beta/vaults/retrieve.md b/content/en/api/ruby/beta/vaults/retrieve.md index a120a39e2..77b397649 100644 --- a/content/en/api/ruby/beta/vaults/retrieve.md +++ b/content/en/api/ruby/beta/vaults/retrieve.md @@ -16,7 +16,7 @@ Get Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -86,6 +86,20 @@ Get Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault` diff --git a/content/en/api/ruby/beta/vaults/update.md b/content/en/api/ruby/beta/vaults/update.md index bac07c242..b421a8bd6 100644 --- a/content/en/api/ruby/beta/vaults/update.md +++ b/content/en/api/ruby/beta/vaults/update.md @@ -26,7 +26,7 @@ Update Vault - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Update Vault - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class BetaManagedAgentsVault` diff --git a/content/en/api/ruby/completions.md b/content/en/api/ruby/completions.md index dd5de00d9..268f01c2d 100644 --- a/content/en/api/ruby/completions.md +++ b/content/en/api/ruby/completions.md @@ -150,7 +150,7 @@ Future models and features will not be compatible with Text Completions. See our - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -220,6 +220,20 @@ Future models and features will not be compatible with Text Completions. See our - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `temperature: Float` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error. diff --git a/content/en/api/ruby/completions/create.md b/content/en/api/ruby/completions/create.md index 85d72cf9b..e0add23bb 100644 --- a/content/en/api/ruby/completions/create.md +++ b/content/en/api/ruby/completions/create.md @@ -148,7 +148,7 @@ Future models and features will not be compatible with Text Completions. See our - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -218,6 +218,20 @@ Future models and features will not be compatible with Text Completions. See our - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + - `temperature: Float` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error. diff --git a/content/en/api/ruby/models.md b/content/en/api/ruby/models.md index 610a4c49b..480971838 100644 --- a/content/en/api/ruby/models.md +++ b/content/en/api/ruby/models.md @@ -34,7 +34,7 @@ The Models API response can be used to determine which models are available for - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class ModelInfo` @@ -351,7 +365,7 @@ The Models API response can be used to determine information about a specific mo - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -421,6 +435,20 @@ The Models API response can be used to determine information about a specific mo - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ### Returns - `class ModelInfo` diff --git a/content/en/api/ruby/models/list.md b/content/en/api/ruby/models/list.md index 65b082c43..ede55f777 100644 --- a/content/en/api/ruby/models/list.md +++ b/content/en/api/ruby/models/list.md @@ -32,7 +32,7 @@ The Models API response can be used to determine which models are available for - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ The Models API response can be used to determine which models are available for - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class ModelInfo` diff --git a/content/en/api/ruby/models/retrieve.md b/content/en/api/ruby/models/retrieve.md index e55834248..1d423cb86 100644 --- a/content/en/api/ruby/models/retrieve.md +++ b/content/en/api/ruby/models/retrieve.md @@ -20,7 +20,7 @@ The Models API response can be used to determine information about a specific mo - `String = String` - - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 31 more` + - `AnthropicBeta = :"message-batches-2024-09-24" | :"prompt-caching-2024-07-31" | :"computer-use-2024-10-22" | 38 more` - `:"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ The Models API response can be used to determine information about a specific mo - `:"mid-conversation-tool-changes-2026-07-01"` + - `:"compact-2026-01-12"` + + - `:"computer-use-2025-11-24"` + + - `:"mcp-tunnels-2026-06-22"` + + - `:"structured-outputs-2025-11-13"` + + - `:"task-budgets-2026-03-13"` + + - `:"thinking-display-updates-2026-08-18"` + + - `:"ce-user-management-2026-07-13"` + ## Returns - `class ModelInfo` diff --git a/content/en/api/skills.md b/content/en/api/skills.md index 74e392e8a..8b59738d8 100644 --- a/content/en/api/skills.md +++ b/content/en/api/skills.md @@ -734,7 +734,7 @@ Get Skill Version - `version: string` - Identifies the skill version: a version ID, or — where the endpoint accepts it — the literal `latest` for the skill's most recent version. + Identifies the skill version: a version ID, or the literal `latest` for the skill's most recent version. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). @@ -817,7 +817,7 @@ Delete Skill Version - `version: string` - Identifies the skill version: a version ID, or — where the endpoint accepts it — the literal `latest` for the skill's most recent version. + Identifies the skill version by its version ID. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). diff --git a/content/en/api/skills/versions.md b/content/en/api/skills/versions.md index 78d810547..14816a3f5 100644 --- a/content/en/api/skills/versions.md +++ b/content/en/api/skills/versions.md @@ -207,7 +207,7 @@ Get Skill Version - `version: string` - Identifies the skill version: a version ID, or — where the endpoint accepts it — the literal `latest` for the skill's most recent version. + Identifies the skill version: a version ID, or the literal `latest` for the skill's most recent version. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). @@ -290,7 +290,7 @@ Delete Skill Version - `version: string` - Identifies the skill version: a version ID, or — where the endpoint accepts it — the literal `latest` for the skill's most recent version. + Identifies the skill version by its version ID. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). diff --git a/content/en/api/skills/versions/delete.md b/content/en/api/skills/versions/delete.md index 37c8cac98..3a1fd873c 100644 --- a/content/en/api/skills/versions/delete.md +++ b/content/en/api/skills/versions/delete.md @@ -14,7 +14,7 @@ Delete Skill Version - `version: string` - Identifies the skill version: a version ID, or — where the endpoint accepts it — the literal `latest` for the skill's most recent version. + Identifies the skill version by its version ID. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). diff --git a/content/en/api/skills/versions/retrieve.md b/content/en/api/skills/versions/retrieve.md index fae3b0bcf..488b44b84 100644 --- a/content/en/api/skills/versions/retrieve.md +++ b/content/en/api/skills/versions/retrieve.md @@ -14,7 +14,7 @@ Get Skill Version - `version: string` - Identifies the skill version: a version ID, or — where the endpoint accepts it — the literal `latest` for the skill's most recent version. + Identifies the skill version: a version ID, or the literal `latest` for the skill's most recent version. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). diff --git a/content/en/api/typescript/beta.md b/content/en/api/typescript/beta.md index da930c59a..4b78ca721 100644 --- a/content/en/api/typescript/beta.md +++ b/content/en/api/typescript/beta.md @@ -4,11 +4,11 @@ ### Anthropic Beta -- `AnthropicBeta = (string & {}) | "message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` +- `AnthropicBeta = (string & {}) | "message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -78,6 +78,20 @@ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Beta API Error - `BetaAPIError` @@ -438,7 +452,7 @@ The Models API response can be used to determine which models are available for - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -508,6 +522,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaModelInfo` @@ -769,7 +797,7 @@ The Models API response can be used to determine information about a specific mo - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -839,6 +867,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaModelInfo` @@ -2760,7 +2802,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -2768,6 +2810,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -2776,7 +2820,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -2784,6 +2828,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `"default"` - `"default"` @@ -4841,7 +4887,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4911,6 +4957,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -6388,12 +6448,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -6703,12 +6765,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: number` The cumulative number of output tokens which were used. @@ -8619,7 +8683,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -8627,6 +8691,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -8635,7 +8701,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -8643,6 +8709,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice?: BetaToolChoice` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -10588,7 +10656,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -10658,6 +10726,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -12424,7 +12506,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12432,6 +12514,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -12440,7 +12524,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -12448,6 +12532,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `"default"` - `"default"` @@ -14549,7 +14635,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -14619,6 +14705,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -14805,7 +14905,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -14875,6 +14975,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch` @@ -15058,7 +15172,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -15128,6 +15242,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch` @@ -15309,7 +15437,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -15379,6 +15507,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch` @@ -15552,7 +15694,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -15622,6 +15764,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDeletedMessageBatch` @@ -15687,7 +15843,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -15757,6 +15913,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatchIndividualResponse` @@ -17188,12 +17358,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -18235,7 +18407,7 @@ Create Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -18305,6 +18477,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent` @@ -18969,7 +19155,7 @@ List Agents - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -19039,6 +19225,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent` @@ -19688,7 +19888,7 @@ Get Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -19758,6 +19958,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent` @@ -21049,7 +21263,7 @@ Update Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -21119,6 +21333,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent` @@ -21759,7 +21987,7 @@ Archive Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -21829,6 +22057,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent` @@ -22480,7 +22722,7 @@ List Agent Versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -22550,6 +22792,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent` @@ -23239,7 +23495,7 @@ Create a new environment with the specified configuration. - `allow_package_managers?: boolean | null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts?: Array | null` @@ -23251,6 +23507,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt?: Array | null` Ubuntu/Debian packages to install @@ -23313,7 +23571,7 @@ Create a new environment with the specified configuration. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -23383,6 +23641,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironment` @@ -23614,7 +23886,7 @@ List environments with pagination support. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -23684,6 +23956,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironment` @@ -23907,7 +24193,7 @@ Retrieve a specific environment by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -23977,6 +24263,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironment` @@ -24234,7 +24534,7 @@ Update an existing environment's configuration. - `allow_package_managers?: boolean | null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts?: Array | null` @@ -24246,6 +24546,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt?: Array | null` Ubuntu/Debian packages to install @@ -24314,7 +24616,7 @@ Update an existing environment's configuration. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -24384,6 +24686,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironment` @@ -24601,7 +24917,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -24671,6 +24987,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironmentDeleteResponse` @@ -24732,7 +25062,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -24802,6 +25132,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaEnvironment` @@ -25027,7 +25371,7 @@ Retrieve detailed information about a specific work item. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -25097,6 +25441,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -25254,7 +25612,7 @@ Long poll for work items in the queue. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -25324,6 +25682,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"Anthropic-Worker-ID"?: string` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -25471,7 +25843,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -25541,6 +25913,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -25698,7 +26084,7 @@ Record a heartbeat for a work item to maintain the lease. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -25768,6 +26154,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkHeartbeatResponse` @@ -25865,7 +26265,7 @@ Stop a work item, initiating graceful or forced shutdown. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -25935,6 +26335,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -26090,7 +26504,7 @@ List work items in an environment. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -26160,6 +26574,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -26319,7 +26747,7 @@ Update work item metadata with merge semantics. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -26389,6 +26817,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -26533,7 +26975,7 @@ Get statistics about the work queue for an environment. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -26603,6 +27045,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkQueueStats` @@ -27641,7 +28097,7 @@ Create Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -27711,6 +28167,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSession` @@ -28846,7 +29316,7 @@ List Sessions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -28916,6 +29386,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSession` @@ -29981,7 +30465,7 @@ Get Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -30051,6 +30535,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSession` @@ -31549,7 +32047,7 @@ Update Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -31619,6 +32117,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSession` @@ -32679,7 +33191,7 @@ Delete Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -32749,6 +33261,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedSession` @@ -32804,7 +33330,7 @@ Archive Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -32874,6 +33400,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSession` @@ -33982,7 +34522,7 @@ List Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -34052,6 +34592,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -36607,7 +37161,7 @@ Send Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -36677,6 +37231,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSendSessionEvents` @@ -37192,7 +37760,7 @@ Stream Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -37262,6 +37830,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` @@ -39512,7 +40094,7 @@ Add Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -39582,6 +40164,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsFileResource` @@ -39666,7 +40262,7 @@ List Session Resources - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -39736,6 +40332,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionResource = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -39915,7 +40525,7 @@ Get Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -39985,6 +40595,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `ResourceRetrieveResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -40157,7 +40781,7 @@ Update Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -40227,6 +40851,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `ResourceUpdateResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -40393,7 +41031,7 @@ Delete Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -40463,6 +41101,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeleteSessionResource` @@ -40531,7 +41183,7 @@ List Session Threads - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -40601,6 +41253,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread` @@ -40613,7 +41279,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -41364,7 +42030,7 @@ Get Session Thread - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -41434,6 +42100,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread` @@ -41446,7 +42126,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -42192,7 +42872,7 @@ Archive Session Thread - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -42262,6 +42942,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread` @@ -42274,7 +42968,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -43032,7 +43726,7 @@ List Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -43102,6 +43796,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -45297,7 +46005,7 @@ Stream Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -45367,6 +46075,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` @@ -48000,7 +48722,7 @@ Create Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -48070,6 +48792,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment` @@ -48730,7 +49466,7 @@ List Deployments - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -48800,6 +49536,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment` @@ -49423,7 +50173,7 @@ Get Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -49493,6 +50243,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment` @@ -50512,7 +51276,7 @@ Update Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -50582,6 +51346,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment` @@ -51201,7 +51979,7 @@ Archive Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -51271,6 +52049,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment` @@ -51890,7 +52682,7 @@ Run Deployment Now - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -51960,6 +52752,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeploymentRun` @@ -52245,7 +53051,7 @@ Pause Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -52315,6 +53121,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment` @@ -52934,7 +53754,7 @@ Unpause Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -53004,6 +53824,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeployment` @@ -53673,7 +54507,7 @@ List Deployment Runs - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -53743,6 +54577,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeploymentRun` @@ -54032,7 +54880,7 @@ Get Deployment Run - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -54102,6 +54950,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeploymentRun` @@ -54397,7 +55259,7 @@ Create Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -54467,6 +55329,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsVault` @@ -54569,7 +55445,7 @@ List Vaults - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -54639,6 +55515,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsVault` @@ -54733,7 +55623,7 @@ Get Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -54803,6 +55693,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsVault` @@ -54903,7 +55807,7 @@ Update Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -54973,6 +55877,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsVault` @@ -55061,7 +55979,7 @@ Delete Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -55131,6 +56049,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedVault` @@ -55188,7 +56120,7 @@ Archive Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -55258,6 +56190,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsVault` @@ -55524,7 +56470,7 @@ Create Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -55594,6 +56540,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -55828,7 +56788,7 @@ List Credentials - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -55898,6 +56858,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -56121,7 +57095,7 @@ Get Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -56191,6 +57165,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -56541,7 +57529,7 @@ Update Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -56611,6 +57599,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -56829,7 +57831,7 @@ Delete Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -56899,6 +57901,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedCredential` @@ -56961,7 +57977,7 @@ Archive Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -57031,6 +58047,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -57249,7 +58279,7 @@ Validate Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -57319,6 +58349,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredentialValidation` @@ -57489,7 +58533,7 @@ Create a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -57559,6 +58603,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryStore` @@ -57676,7 +58734,7 @@ List memory stores - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -57746,6 +58804,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryStore` @@ -57845,7 +58917,7 @@ Retrieve a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -57915,6 +58987,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryStore` @@ -58026,7 +59112,7 @@ Update a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -58096,6 +59182,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryStore` @@ -58189,7 +59289,7 @@ Delete a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -58259,6 +59359,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedMemoryStore` @@ -58316,7 +59430,7 @@ Archive a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -58386,6 +59500,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryStore` @@ -58499,7 +59627,7 @@ Create a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -58569,6 +59697,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemory` @@ -58601,7 +59743,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -58701,7 +59843,7 @@ List memories - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -58771,6 +59913,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryListItem = BetaManagedAgentsMemory | BetaManagedAgentsMemoryPrefix` @@ -58807,7 +59963,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -58906,7 +60062,7 @@ Retrieve a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -58976,6 +60132,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemory` @@ -59008,7 +60178,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -59111,7 +60281,7 @@ Update a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -59181,6 +60351,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemory` @@ -59213,7 +60397,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -59292,7 +60476,7 @@ Delete a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -59362,11 +60546,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -59478,7 +60676,7 @@ List memory versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -59548,11 +60746,25 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -59566,7 +60778,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -59744,7 +60956,7 @@ Retrieve a memory version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -59814,11 +61026,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -59832,7 +61058,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -59997,7 +61223,7 @@ Redact a memory version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -60067,11 +61293,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -60085,7 +61325,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -60252,7 +61492,7 @@ Upload File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -60322,6 +61562,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaFileMetadata` @@ -60453,7 +61707,7 @@ List Files - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -60523,6 +61777,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaFileMetadata` @@ -60643,7 +61911,7 @@ Download File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -60713,6 +61981,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `unnamed_schema_1 = Response` @@ -60756,7 +62038,7 @@ Get File Metadata - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -60826,6 +62108,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaFileMetadata` @@ -60938,7 +62234,7 @@ Delete File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -61008,6 +62304,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDeletedFile` @@ -61079,7 +62389,7 @@ Create Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -61149,6 +62459,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `SkillCreateResponse` @@ -61265,7 +62589,7 @@ List Skills - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -61335,6 +62659,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `SkillListResponse` @@ -61441,7 +62779,7 @@ Get Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -61511,6 +62849,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `SkillRetrieveResponse` @@ -61610,7 +62962,7 @@ Delete Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -61680,6 +63032,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `SkillDeleteResponse` @@ -61753,7 +63119,7 @@ Create Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -61823,6 +63189,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `VersionCreateResponse` @@ -61938,7 +63318,7 @@ List Skill Versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -62008,6 +63388,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `VersionListResponse` @@ -62124,7 +63518,7 @@ Download a skill version's content as a zip archive. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -62194,6 +63588,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `unnamed_schema_2 = Response` @@ -62247,7 +63655,7 @@ Get Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -62317,6 +63725,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `VersionRetrieveResponse` @@ -62428,7 +63850,7 @@ Delete Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -62498,6 +63920,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `VersionDeleteResponse` @@ -62611,7 +64047,7 @@ Create User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -62681,6 +64117,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaUserProfile` @@ -62820,7 +64270,7 @@ List User Profiles - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -62890,6 +64340,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaUserProfile` @@ -63019,7 +64483,7 @@ Get User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -63089,6 +64553,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaUserProfile` @@ -63248,7 +64726,7 @@ Update User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -63318,6 +64796,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaUserProfile` @@ -63443,7 +64935,7 @@ Create Enrollment URL - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -63513,6 +65005,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaUserProfileEnrollmentURL` @@ -63649,7 +65155,7 @@ Create a Dream - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -63719,6 +65225,20 @@ Create a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDream` @@ -63984,7 +65504,7 @@ List Dreams - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -64054,6 +65574,20 @@ List Dreams - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDream` @@ -64284,7 +65818,7 @@ Get a Dream - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -64354,6 +65888,20 @@ Get a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDream` @@ -64578,7 +66126,7 @@ Cancel a Dream - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -64648,6 +66196,20 @@ Cancel a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDream` @@ -64872,7 +66434,7 @@ Archive a Dream - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -64942,6 +66504,20 @@ Archive a Dream - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDream` @@ -65174,7 +66750,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -65244,6 +66820,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnel` @@ -65325,7 +66915,7 @@ Fetches a tunnel by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -65395,6 +66985,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnel` @@ -65488,7 +67092,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -65558,6 +67162,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnel` @@ -65645,7 +67263,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -65715,6 +67333,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnel` @@ -65796,7 +67428,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -65866,6 +67498,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelToken` @@ -65934,7 +67580,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -66004,6 +67650,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelToken` @@ -66074,7 +67734,10450 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaTunnelCertificate` + + A CA certificate attached to a tunnel. + + - `id: string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: string | null` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: string` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: string | null` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: string` + + ID of the tunnel the certificate is registered against. + + - `type: "tunnel_certificate"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaTunnelCertificate = await client.beta.tunnels.certificates.create("tunnel_id", { + ca_certificate_pem: "ca_certificate_pem" +}); + +console.log(betaTunnelCertificate.id); +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### Get Tunnel Certificate + +`client.beta.tunnels.certificates.retrieve(certificateID, params, options?): BetaTunnelCertificate` + +**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Fetches a tunnel certificate by ID. + +#### Parameters + +- `certificateID: string` + +- `params: CertificateRetrieveParams` + + - `tunnel_id: string` + + Path param: Path parameter tunnel_id + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaTunnelCertificate` + + A CA certificate attached to a tunnel. + + - `id: string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: string | null` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: string` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: string | null` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: string` + + ID of the tunnel the certificate is registered against. + + - `type: "tunnel_certificate"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaTunnelCertificate = await client.beta.tunnels.certificates.retrieve( + "certificate_id", + { tunnel_id: "tunnel_id" } +); + +console.log(betaTunnelCertificate.id); +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +### List Tunnel Certificates + +`client.beta.tunnels.certificates.list(tunnelID, params?, options?): PageCursor` + +**GET** `/v1/tunnels/{tunnel_id}/certificates` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. + +#### Parameters + +- `tunnelID: string` + +- `params: CertificateListParams` + + - `include_archived?: boolean` + + Query param: Whether to include archived certificates in the results. Defaults to false. + + - `limit?: number` + + Query param: Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + + format: int32 + + - `page?: string` + + Query param: Opaque pagination cursor from a previous `list_tunnel_certificates` response. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaTunnelCertificate` + + A CA certificate attached to a tunnel. + + - `id: string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: string | null` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: string` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: string | null` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: string` + + ID of the tunnel the certificate is registered against. + + - `type: "tunnel_certificate"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaTunnelCertificate of client.beta.tunnels.certificates.list("tunnel_id")) { + console.log(betaTunnelCertificate.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" + } + ], + "next_page": "next_page" +} +``` + +### Archive Tunnel Certificate + +`client.beta.tunnels.certificates.archive(certificateID, params, options?): BetaTunnelCertificate` + +**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` + +The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. + +Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. + +#### Parameters + +- `certificateID: string` + +- `params: CertificateArchiveParams` + + - `tunnel_id: string` + + Path param: Path parameter tunnel_id + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaTunnelCertificate` + + A CA certificate attached to a tunnel. + + - `id: string` + + Unique identifier for the certificate, prefixed with `tcrt_`. + + - `archived_at: string | null` + + A timestamp in RFC 3339 format + + format: date-time + + - `created_at: string` + + A timestamp in RFC 3339 format + + format: date-time + + - `expires_at: string | null` + + A timestamp in RFC 3339 format + + format: date-time + + - `fingerprint: string` + + Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + + - `tunnel_id: string` + + ID of the tunnel the certificate is registered against. + + - `type: "tunnel_certificate"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaTunnelCertificate = await client.beta.tunnels.certificates.archive( + "certificate_id", + { tunnel_id: "tunnel_id" } +); + +console.log(betaTunnelCertificate.id); +``` + +##### Response (200) + +```json +{ + "id": "id", + "archived_at": "2019-12-27T18:11:19.117Z", + "created_at": "2019-12-27T18:11:19.117Z", + "expires_at": "2019-12-27T18:11:19.117Z", + "fingerprint": "fingerprint", + "tunnel_id": "tunnel_id", + "type": "tunnel_certificate" +} +``` + +## Beta › Organization + +### Get Current Organization + +`client.beta.organization.retrieve(options?): BetaOrganization` + +**GET** `/v1/organizations/me` + +Retrieve information about the organization associated with the authenticated API key. + +#### Returns + +- `BetaOrganization` + + - `id: string` + + ID of the Organization. + + format: uuid + + - `name: string` + + Name of the Organization. + + - `type: "organization"` + + Object type. + + For Organizations, this is always `"organization"`. + + default: organization + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaOrganization = await client.beta.organization.retrieve(); + +console.log(betaOrganization.id); +``` + +##### Response (200) + +```json +{ + "id": "12345678-1234-5678-1234-567812345678", + "name": "Organization Name", + "type": "organization" +} +``` + +## Beta › Organization › API Keys + +### List API Keys + +`client.beta.organization.apiKeys.list(query?, options?): Page` + +**GET** `/v1/organizations/api_keys` + +List API Keys + +#### Parameters + +- `query: APIKeyListParams` + + - `after_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `before_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `created_by_user_id?: string | null` + + Filter by the ID of the User who created the object. + + - `limit?: number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `status?: "active" | "archived" | "expired" | "inactive" | null` + + Filter by API key status. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `workspace_id?: string | null` + + Filter by Workspace ID. + +#### Returns + +- `BetaAPIKey` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy | null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" | "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string | null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string | null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor | BetaAPIKeyServiceAccountActor | null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope | BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" | "archived" | "expired" | "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string | null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaAPIKey of client.beta.organization.apiKeys.list()) { + console.log(betaAPIKey.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get API Key + +`client.beta.organization.apiKeys.retrieve(apiKeyID, options?): BetaAPIKey` + +**GET** `/v1/organizations/api_keys/{api_key_id}` + +Get API Key + +#### Parameters + +- `apiKeyID: string` + + ID of the API key. + +#### Returns + +- `BetaAPIKey` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy | null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" | "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string | null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string | null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor | BetaAPIKeyServiceAccountActor | null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope | BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" | "archived" | "expired" | "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string | null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaAPIKey = await client.beta.organization.apiKeys.retrieve("api_key_id"); + +console.log(betaAPIKey.id); +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +### Update API Key + +`client.beta.organization.apiKeys.update(apiKeyID, body, options?): BetaAPIKey` + +**POST** `/v1/organizations/api_keys/{api_key_id}` + +Update API Key + +#### Parameters + +- `apiKeyID: string` + + ID of the API key. + +- `body: APIKeyUpdateParams` + + - `name?: string | null` + + Name of the API key. + + maxLength: 500, minLength: 1 + + - `status?: "active" | "archived" | "inactive" | null` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"inactive"` + +#### Returns + +- `BetaAPIKey` + + - `id: string` + + ID of the API key. + + - `created_at: string` + + RFC 3339 datetime string indicating when the API Key was created. + + format: date-time + + - `created_by: BetaAPIKeyCreatedBy | null` + + The ID and type of the actor that created the API key, or `null` when the + creator is not recorded (legacy, workload-identity-federated, or + system-created keys). + + - `id: string` + + ID of the actor that created the object. + + - `type: "service_account" | "user"` + + Type of the actor that created the object. + + - `"service_account"` + + - `"user"` + + - `expires_at: string | null` + + RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. + + format: date-time + + - `name: string` + + Name of the API key. + + - `partial_key_hint: string | null` + + Partially redacted hint for the API key. + + - `principal: BetaAPIKeyUserActor | BetaAPIKeyServiceAccountActor | null` + + The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. + + - `BetaAPIKeyUserActor` + + - `type: "user_actor"` + + Principal type. Always `"user_actor"` for a User. + + default: user_actor + + - `user_id: string` + + ID of the User the API key acts as. + + - `BetaAPIKeyServiceAccountActor` + + - `service_account_id: string` + + ID of the Service Account the API key acts as. + + - `type: "service_account_actor"` + + Principal type. Always `"service_account_actor"` for a Service Account. + + default: service_account_actor + + - `scope: BetaAPIKeyOrganizationScope | BetaAPIKeyWorkspaceScope` + + Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. + + - `BetaAPIKeyOrganizationScope` + + - `type: "organization"` + + Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. + + default: organization + + - `BetaAPIKeyWorkspaceScope` + + - `type: "workspace"` + + Scope type. Always `"workspace"`: the API key belongs to one Workspace. + + default: workspace + + - `workspace_id: string` + + ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. + + - `status: "active" | "archived" | "expired" | "inactive"` + + Status of the API key. + + - `"active"` + + - `"archived"` + + - `"expired"` + + - `"inactive"` + + - `type: "api_key"` + + Object type. + + For API Keys, this is always `"api_key"`. + + default: api_key + + - `workspace_id: string | null` + + **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. + + Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaAPIKey = await client.beta.organization.apiKeys.update("api_key_id"); + +console.log(betaAPIKey.id); +``` + +##### Response (200) + +```json +{ + "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by": { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user" + }, + "expires_at": "2024-10-30T23:58:27.427722Z", + "name": "Developer Key", + "partial_key_hint": "sk-ant-api03-R2D...igAA", + "principal": { + "type": "user_actor", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" + }, + "scope": { + "type": "workspace", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }, + "status": "active", + "type": "api_key", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › External Keys + +### Create External Key + +`client.beta.organization.externalKeys.create(body, options?): BetaExternalKey` + +**POST** `/v1/organizations/external_keys` + +Create an external key config owned by the caller's organization. + +#### Parameters + +- `body: ExternalKeyCreateParams` + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfigParam` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region?: string | null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn?: string | null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id?: string | null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `display_name?: string | null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + + - `geo?: "us"` + + Data residency geo. Only `us` is supported. + +#### Returns + +- `BetaExternalKey` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string | null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region?: string | null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn?: string | null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id?: string | null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaExternalKey = await client.beta.organization.externalKeys.create({ + provider_config: { + kms_arn: "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + type: "aws" + } +}); + +console.log(betaExternalKey.id); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### List External Keys + +`client.beta.organization.externalKeys.list(query?, options?): PageCursor` + +**GET** `/v1/organizations/external_keys` + +List external key configs in the caller's organization. + +Results are ordered by creation time (newest first). Use the +`next_page` cursor from the response to fetch subsequent pages. + +#### Parameters + +- `query: ExternalKeyListParams` + + - `limit?: number` + + Number of results per page. + + maximum: 100, minimum: 1 + + - `page?: string | null` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `BetaExternalKey` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string | null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region?: string | null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn?: string | null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id?: string | null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaExternalKey of client.beta.organization.externalKeys.list()) { + console.log(betaExternalKey.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" + } + ], + "next_page": "next_page" +} +``` + +### Get External Key + +`client.beta.organization.externalKeys.retrieve(externalKeyID, options?): BetaExternalKey` + +**GET** `/v1/organizations/external_keys/{external_key_id}` + +Retrieve a single external key config in the caller's organization by ID. + +#### Parameters + +- `externalKeyID: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `BetaExternalKey` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string | null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region?: string | null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn?: string | null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id?: string | null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaExternalKey = await client.beta.organization.externalKeys.retrieve( + "external_key_id" +); + +console.log(betaExternalKey.id); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Update External Key + +`client.beta.organization.externalKeys.update(externalKeyID, body, options?): BetaExternalKey` + +**POST** `/v1/organizations/external_keys/{external_key_id}` + +Partially update an external key config. Omitted fields are left unchanged. + +`display_name` is always editable. `geo` and `provider_config` cannot +be changed once any workspace references this config, because previously +encrypted data requires the original key identity to decrypt. + +#### Parameters + +- `externalKeyID: string` + + ID of the External Key. + + maxLength: 2048 + +- `body: ExternalKeyUpdateParams` + + - `display_name?: string | null` + + Human-friendly display name. + + maxLength: 255, minLength: 1 + + - `geo?: "us" | null` + + Data residency geo. Only `us` is supported. + + - `provider_config?: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfigParam | null` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region?: string | null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn?: string | null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfigParam` + + Azure Key Vault provider configuration. + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id?: string | null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + +#### Returns + +- `BetaExternalKey` + + CMEK external key config belonging to the caller's organization. + + Configs are organization-scoped. Workspaces attach to a config; once any + workspace references it, the provider fields become effectively immutable + (existing encrypted data needs the config for decrypt). + + - `id: string` + + Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. + + - `attachment: BetaExternalKeyAttachedAttachment | BetaExternalKeyUnattachedAttachment` + + Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. + + - `BetaExternalKeyAttachedAttachment` + + - `type: "attached"` + + default: attached + + - `BetaExternalKeyUnattachedAttachment` + + - `type: "unattached"` + + default: unattached + + - `created_at: string` + + format: date-time + + - `display_name: string | null` + + Human-friendly display name. Null if none was set. + + - `geo: string` + + Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. + + - `provider_config: BetaAWSExternalKeyConfig | BetaGCPExternalKeyConfig | BetaAzureExternalKeyConfig` + + KMS provider identity and auth coordinates. + + - `BetaAWSExternalKeyConfig` + + - `kms_arn: string` + + Full ARN of the AWS KMS key. + + maxLength: 2048 + + - `type: "aws"` + + - `region?: string | null` + + AWS region. Derived from `kms_arn` if omitted. + + - `role_arn?: string | null` + + **Deprecated** + + IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored. + + - `BetaGCPExternalKeyConfig` + + - `key_name: string` + + Full resource name of the Cloud KMS key. + + - `type: "gcp"` + + - `BetaAzureExternalKeyConfig` + + - `key_name: string` + + Name of the key within the vault. + + - `tenant_id: string` + + Azure AD tenant ID. + + - `type: "azure"` + + - `vault_uri: string` + + Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. + + - `client_id?: string | null` + + Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. + + - `type: "external_key"` + + default: external_key + + - `updated_at: string` + + format: date-time + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaExternalKey = await client.beta.organization.externalKeys.update("external_key_id"); + +console.log(betaExternalKey.id); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "attachment": { + "type": "attached" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "display_name": "prod-us-key", + "geo": "us", + "provider_config": { + "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", + "type": "aws", + "region": "us-east-1", + "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" + }, + "type": "external_key", + "updated_at": "2024-10-30T23:58:27.427722Z" +} +``` + +### Delete External Key + +`client.beta.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse` + +**DELETE** `/v1/organizations/external_keys/{external_key_id}` + +Delete an external key config. + +The request is rejected if any workspace still references this config. + +#### Parameters + +- `externalKeyID: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `ExternalKeyDeleteResponse` + + - `id: string` + + ID of the deleted External Key. + + - `type: "external_key_deleted"` + + default: external_key_deleted + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const externalKey = await client.beta.organization.externalKeys.delete("external_key_id"); + +console.log(externalKey.id); +``` + +##### Response (200) + +```json +{ + "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", + "type": "external_key_deleted" +} +``` + +### Validate External Key + +`client.beta.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse` + +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` + +Validate an external key config against the customer's KMS. + +Anthropic performs an encrypt/decrypt roundtrip against the configured +KMS key and waits up to 30 seconds for the result. The response status is +`success` if the roundtrip succeeded, or `failure` with an error +message if it failed or timed out. + +#### Parameters + +- `externalKeyID: string` + + ID of the External Key. + + maxLength: 2048 + +#### Returns + +- `ExternalKeyValidateResponse` + + Result of a validation roundtrip against the customer's KMS. + + HTTP 200 for both outcomes — the operation completed; `status` says + whether the key works. + + - `error: string | null` + + Error message when status is `failure`. Null otherwise. + + - `status: "failure" | "success"` + + `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. + + - `"failure"` + + - `"success"` + + - `type: "external_key_validation"` + + default: external_key_validation + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const response = await client.beta.organization.externalKeys.validate("external_key_id"); + +console.log(response.error); +``` + +##### Response (200) + +```json +{ + "error": "error", + "status": "failure", + "type": "external_key_validation" +} +``` + +## Beta › Organization › Federation › Issuers + +### Create Federation Issuer + +`client.beta.organization.federation.issuers.create(params, options?): BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Register an OIDC issuer that Anthropic will trust for workload identity +federation in your organization. + +The `jwks` field controls how the issuer's signing keys are obtained and +takes one of three shapes selected by `type`: `discovery` (resolve keys +through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS +URL), or `inline` (provide a static key set). When `jwks.type` is +`discovery` and no `discovery_base` is set, the issuer URL must be +publicly reachable over HTTPS so Anthropic can fetch the discovery +document; for `explicit_url` and `inline` modes the issuer URL is only +matched as the JWT's `iss` claim and is not fetched. + +#### Parameters + +- `params: IssuerCreateParams` + + - `issuer_url: string` + + Body param: The `iss` claim value to match against. + + minLength: 1 + + - `name: string` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `check_jti?: boolean | null` + + Body param: Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `jwks?: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + Body param: How signing keys are obtained. Defaults to OIDC discovery. + + - `BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base?: string | null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array>` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `max_jwt_lifetime_seconds?: number | null` + + Body param: Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string | null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base?: string | null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array>` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string | null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus | null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string | null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string | null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationIssuer = await client.beta.organization.federation.issuers.create({ + issuer_url: "x", + name: "x" +}); + +console.log(betaFederationIssuer.id); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Federation Issuers + +`client.beta.organization.federation.issuers.list(params?, options?): PageCursor` + +**GET** `/v1/organizations/federation_issuers` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation issuers in your organization. + +Archived issuers are excluded unless `include_archived=true`. + +#### Parameters + +- `params: IssuerListParams` + + - `include_archived?: boolean` + + Query param: Include archived resources. Defaults to false. + + - `limit?: number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `page?: string | null` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string | null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base?: string | null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array>` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string | null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus | null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string | null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string | null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaFederationIssuer of client.beta.organization.federation.issuers.list()) { + console.log(betaFederationIssuer.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Issuer + +`client.beta.organization.federation.issuers.retrieve(federationIssuerID, params?, options?): BetaFederationIssuer` + +**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation issuer by its ID (`fdis_...`). + +#### Parameters + +- `federationIssuerID: string` + + ID of the federation issuer. + +- `params: IssuerRetrieveParams` + + - `betas?: Array` + + Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string | null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base?: string | null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array>` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string | null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus | null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string | null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string | null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationIssuer = await client.beta.organization.federation.issuers.retrieve( + "federation_issuer_id" +); + +console.log(betaFederationIssuer.id); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Federation Issuer + +`client.beta.organization.federation.issuers.update(federationIssuerID, params, options?): BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation issuer. + +Setting `jwks` replaces the full JWKS shape at once. Archived issuers +cannot be updated; this returns 400. Create a new issuer instead. + +Updating an issuer that backs a rule with a scope outside +`workspace:developer` or `workspace:inference` requires a Console +session. + +#### Parameters + +- `federationIssuerID: string` + + ID of the federation issuer to update. + +- `params: IssuerUpdateParams` + + - `check_jti?: boolean | null` + + Body param: Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `issuer_url?: string | null` + + Body param: Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. + + minLength: 1 + + - `jwks?: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline | null` + + Body param: Replaces the entire JWKS configuration. + + - `BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base?: string | null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array>` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled?: boolean | null` + + Body param: Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. + + - `max_jwt_lifetime_seconds?: number | null` + + Body param: Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + maximum: 176400, exclusiveMinimum: 0 + + - `name?: string | null` + + Body param: Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string | null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base?: string | null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array>` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string | null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus | null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string | null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string | null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationIssuer = await client.beta.organization.federation.issuers.update( + "federation_issuer_id" +); + +console.log(betaFederationIssuer.id); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Federation Issuer + +`client.beta.organization.federation.issuers.archive(federationIssuerID, params?, options?): BetaFederationIssuer` + +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation issuer. + +Idempotent; re-archiving returns the issuer with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still references the issuer; archive those rules first (a rule's +issuer cannot be changed), or recreate them against another issuer. + +#### Parameters + +- `federationIssuerID: string` + + ID of the federation issuer to archive. + +- `params: IssuerArchiveParams` + + - `betas?: Array` + + Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationIssuer` + + Registered external OIDC identity provider. + + Records an external IdP the organization trusts for the RFC 7523 + jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. + + - `id: string` + + Tagged ID of the federation issuer. + + - `archived_at: string | null` + + If set, all rules referencing this issuer reject token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. + + - `check_jti: boolean` + + Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. + + - `created_at: string` + + When this issuer was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this issuer. + + - `issuer_url: string` + + The `iss` claim value. Incoming JWTs must match exactly. + + - `jwks: BetaJWKSDiscovery | BetaJWKSExplicitURL | BetaJWKSInline` + + How signing keys are obtained for signature verification. + + - `BetaJWKSDiscovery` + + JWKS via the issuer's OIDC discovery document. + + - `type: "discovery"` + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `discovery_base?: string | null` + + Set when the discovery URL differs from `issuer_url`. + + - `BetaJWKSExplicitURL` + + JWKS fetched from a fixed endpoint. + + - `type: "explicit_url"` + + - `url: string` + + JWKS endpoint. + + minLength: 1 + + - `ca_cert_pem?: string | null` + + Optional custom CA (PEM) for TLS verification of the JWKS fetch. + + maxLength: 8192 + + - `BetaJWKSInline` + + JWKS supplied directly; no network fetch. + + - `keys: Array>` + + Inline JWK objects. + + minItems: 1 + + - `type: "inline"` + + - `jwks_polling_disabled_at: string | null` + + If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + + format: date-time + + - `max_jwt_lifetime_seconds: number` + + Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. + + - `name: string` + + Admin-chosen slug identifier. + + - `poll_status: BetaFederationIssuerPollStatus | null` + + Status of automatic JWKS polling for a federation issuer. + + Anthropic periodically fetches the issuer's signing keys in the + background. These fields summarize the most recent fetches so the + health of the JWKS endpoint can be monitored. + + - `consecutive_failures: number` + + Consecutive fetch failures since the last success. + + - `last_fetched_at: string | null` + + When the last successful fetch completed. + + format: date-time + + - `next_poll_at: string | null` + + When the next fetch is scheduled. Null if paused. + + format: date-time + + - `type: "federation_issuer"` + + default: federation_issuer + + - `updated_at: string` + + When this issuer was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationIssuer = await client.beta.organization.federation.issuers.archive( + "federation_issuer_id" +); + +console.log(betaFederationIssuer.id); +``` + +##### Response (200) + +```json +{ + "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "check_jti": true, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": { + "type": "discovery", + "ca_cert_pem": "ca_cert_pem", + "discovery_base": "discovery_base" + }, + "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", + "max_jwt_lifetime_seconds": 0, + "name": "github-actions", + "poll_status": { + "consecutive_failures": 0, + "last_fetched_at": "2019-12-27T18:11:19.117Z", + "next_poll_at": "2019-12-27T18:11:19.117Z" + }, + "type": "federation_issuer", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Federation › Rules + +### Create Federation Rule + +`client.beta.organization.federation.rules.create(params, options?): BetaFederationRule` + +**POST** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a federation rule owned by your organization. + +The referenced issuer and the target service account must already exist +in the same organization; invalid references are rejected with a 400 +error. The workspace reference is validated. Membership is not checked +at rule creation: token exchange resolves a single enabled workspace per +call and is rejected unless the target service account is a member of +that workspace (it is implicitly a member of the default workspace). +Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, +Terraform Cloud, Google) must constrain tenant identity via an +identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). OAuth callers may only +manage rules whose `oauth_scope` is `workspace:developer` or +`workspace:inference`; other scopes require a Console session. + +#### Parameters + +- `params: RuleCreateParams` + + - `issuer_id: string` + + Body param: Tagged ID of the federation issuer. + + - `match: BetaFederationRuleMatch` + + Body param: Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. + + - `audience?: string | null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims?: Record | null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition?: string | null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix?: string | null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `oauth_scope: string` + + Body param: Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + + - `target: BetaServiceAccountTarget` + + Body param: Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name?: string | null` + + Service account's display name at read time. Ignored on writes. + + - `applies_to_all_workspaces?: boolean` + + Body param: When true, enable this rule for every workspace in the org (including workspaces created later). + + - `attributes?: Record | null` + + Body param: CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. + + - `description?: string | null` + + Body param: Optional free-text description. + + maxLength: 2000 + + - `token_lifetime_seconds?: number` + + Body param: Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + + - `workspace_id?: string | null` + + Body param: Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string | null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Record | null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string | null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string | null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience?: string | null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims?: Record | null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition?: string | null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix?: string | null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name?: string | null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string | null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationRule = await client.beta.organization.federation.rules.create({ + issuer_id: "issuer_id", + match: {}, + name: "x", + oauth_scope: "x", + target: { service_account_id: "svac_01SDCCSbTxrXDpWc1phhtcfK", type: "service_account" } +}); + +console.log(betaFederationRule.id); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### List Federation Rules + +`client.beta.organization.federation.rules.list(params?, options?): PageCursor` + +**GET** `/v1/organizations/federation_rules` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List federation rules in your organization. + +Optionally filter by issuer with `issuer_id`. Archived rules are excluded +unless `include_archived=true`. + +#### Parameters + +- `params: RuleListParams` + + - `include_archived?: boolean` + + Query param: Include archived resources. Defaults to false. + + - `issuer_id?: string | null` + + Query param: Filter to rules referencing this federation issuer. + + - `limit?: number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `page?: string | null` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string | null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Record | null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string | null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string | null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience?: string | null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims?: Record | null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition?: string | null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix?: string | null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name?: string | null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string | null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaFederationRule of client.beta.organization.federation.rules.list()) { + console.log(betaFederationRule.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] + } + ], + "next_page": "next_page" +} +``` + +### Get Federation Rule + +`client.beta.organization.federation.rules.retrieve(federationRuleID, params?, options?): BetaFederationRule` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a federation rule by its ID (`fdrl_...`). + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule. + +- `params: RuleRetrieveParams` + + - `betas?: Array` + + Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string | null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Record | null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string | null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string | null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience?: string | null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims?: Record | null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition?: string | null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix?: string | null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name?: string | null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string | null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationRule = await client.beta.organization.federation.rules.retrieve( + "federation_rule_id" +); + +console.log(betaFederationRule.id); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Update Federation Rule + +`client.beta.organization.federation.rules.update(federationRuleID, params, options?): BetaFederationRule` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Partially update a federation rule. + +`issuer_id` is immutable. `match` and `target` are replaced as whole +objects when set. Referenced service accounts and workspaces must exist +in your organization; invalid references are rejected with a 400 error. +Archived rules cannot be updated; this returns 400. Create a new rule +instead. Rules on well-known shared issuers (GitHub Actions, GitLab, +Buildkite, Terraform Cloud, Google) must constrain tenant identity via +an identity-bearing claim, a tenant-pinning subject prefix (such as +`repo:YOUR_ORG/...`), or a CEL condition referencing one of those +identity claims (e.g. `claims.repository_owner`). On these issuers the +requirement is re-checked on every update; if an existing rule's stored +match does not yet constrain tenant identity, any update (even a rename +or description change) must also supply a conforming `match` in the same +request. OAuth callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule to update. + +- `params: RuleUpdateParams` + + - `applies_to_all_workspaces?: boolean | null` + + Body param: When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. + + - `attributes?: Record | null` + + Body param: Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. + + - `description?: string | null` + + Body param: Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + + - `match?: BetaFederationRuleMatch | null` + + Body param: Does the incoming JWT qualify? + + All populated fields must pass; omitted fields are skipped. At least one + of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, + or `condition` is required; `audience` alone is not sufficient. + + - `audience?: string | null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims?: Record | null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition?: string | null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix?: string | null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name?: string | null` + + Body param: Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `oauth_scope?: string | null` + + Body param: Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. + + minLength: 1 + + - `target?: BetaServiceAccountTarget | null` + + Body param: Bind to a fixed service account by ID. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name?: string | null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds?: number | null` + + Body param: Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + maximum: 86400, minimum: 60 + + - `workspace_id?: string | null` + + Body param: Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string | null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Record | null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string | null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string | null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience?: string | null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims?: Record | null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition?: string | null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix?: string | null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name?: string | null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string | null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationRule = await client.beta.organization.federation.rules.update( + "federation_rule_id" +); + +console.log(betaFederationRule.id); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +### Archive Federation Rule + +`client.beta.organization.federation.rules.archive(federationRuleID, params?, options?): BetaFederationRule` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a federation rule. + +Token exchange through this rule stops immediately. Idempotent; +re-archiving returns the rule with its original `archived_at`. Archiving +clears the rule's workspace targeting (`workspace_id` and +`workspace_ids` are emptied). Tokens already minted before archive +remain valid until they expire. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule to archive. + +- `params: RuleArchiveParams` + + - `betas?: Array` + + Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRule` + + Authorization rule binding an external OIDC identity to Anthropic. + + Evaluates the match conditions and mints an OAuth access token for the + resolved target, scoped to a single workspace where the rule is enabled + (chosen by the caller at exchange time when the rule is enabled for more + than one). For rules enabled via `workspace_ids` or + `applies_to_all_workspaces`, the target service account must be a member + of that workspace (it is implicitly a member of the default workspace); + rules carrying only the legacy `workspace_id` binding do not enforce + this. + + - `id: string` + + Tagged ID of the federation rule. + + - `applies_to_all_workspaces: boolean` + + When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. + + - `archived_at: string | null` + + If set, this rule is archived and rejects token exchange. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this rule. + + - `attributes: Record | null` + + CEL expressions extracting named values from claims. Not yet supported; always null. + + - `created_at: string` + + When this rule was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this rule. + + - `description: string | null` + + Optional free-text description. + + - `issuer_id: string` + + Tagged ID of the issuer whose tokens this rule accepts. + + - `issuer_name: string | null` + + Issuer's display name at read time. + + - `match: BetaFederationRuleMatch` + + Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. + + - `audience?: string | null` + + Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. + + maxLength: 1024 + + - `claims?: Record | null` + + Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. + + - `condition?: string | null` + + CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. + + maxLength: 4096 + + - `subject_prefix?: string | null` + + Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. + + maxLength: 1024 + + - `name: string` + + Admin-chosen slug identifier. + + - `oauth_scope: string` + + Space-separated OAuth scopes granted on the minted token. + + - `target: BetaServiceAccountTarget` + + Identity that tokens minted via this rule act as. Currently always a `service_account` target. + + - `service_account_id: string` + + Tagged ID of the service account to mint tokens for. + + - `type: "service_account"` + + - `service_account_name?: string | null` + + Service account's display name at read time. Ignored on writes. + + - `token_lifetime_seconds: number` + + Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. + + - `type: "federation_rule"` + + default: federation_rule + + - `updated_at: string` + + When this rule was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. + + - `workspace_id: string | null` + + Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. + + - `workspace_ids: Array` + + Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationRule = await client.beta.organization.federation.rules.archive( + "federation_rule_id" +); + +console.log(betaFederationRule.id); +``` + +##### Response (200) + +```json +{ + "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", + "applies_to_all_workspaces": true, + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "attributes": { + "foo": "string" + }, + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "issuer_id": "issuer_id", + "issuer_name": "issuer_name", + "match": { + "audience": "audience", + "claims": { + "foo": "string" + }, + "condition": "condition", + "subject_prefix": "subject_prefix" + }, + "name": "prod-deploy-pipeline", + "oauth_scope": "oauth_scope", + "target": { + "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "type": "service_account", + "service_account_name": "service_account_name" + }, + "token_lifetime_seconds": 0, + "type": "federation_rule", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id", + "workspace_id": "workspace_id", + "workspace_ids": [ + "string" + ] +} +``` + +## Beta › Organization › Federation › Rules › Workspaces + +### Add Federation Rule Workspace + +`client.beta.organization.federation.rules.workspaces.add(federationRuleID, params, options?): BetaFederationRuleWorkspace` + +**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Enable a federation rule for a workspace. + +Idempotent; re-enabling returns the existing enablement. The rule and +workspace must both belong to your organization. Membership of the +rule's target service account in this workspace is not checked at +enablement: token exchange into this workspace is rejected unless the +target is a member (it is implicitly a member of the default workspace). +Archived rules are rejected with 400. OAuth callers may only manage rules +whose `oauth_scope` is `workspace:developer` or `workspace:inference`; +other scopes require a Console session. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule. + +- `params: WorkspaceAddParams` + + - `workspace_id: string` + + Body param: Tagged ID of the workspace to enable this rule for. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string | null` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaFederationRuleWorkspace = + await client.beta.organization.federation.rules.workspaces.add("federation_rule_id", { + workspace_id: "workspace_id" + }); + +console.log(betaFederationRuleWorkspace.created_by_actor_id); +``` + +##### Response (200) + +```json +{ + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" +} +``` + +### List Federation Rule Workspaces + +`client.beta.organization.federation.rules.workspaces.list(federationRuleID, params?, options?): PageCursor` + +**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List workspaces where this federation rule is enabled. + +Returns all workspace enablements in a single response; the `limit` and +`page` parameters are accepted but have no effect, and `next_page` is +always `null`. Returns explicit per-workspace enablements only; for +rules with `applies_to_all_workspaces` or a legacy single +`workspace_id`, check those fields on the rule itself. + +#### Parameters + +- `federationRuleID: string` + + ID of the federation rule. + +- `params: WorkspaceListParams` + + - `limit?: number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `page?: string | null` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaFederationRuleWorkspace` + + - `created_at: string` + + When this workspace was enabled for the rule. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace"` + + default: federation_rule_workspace + + - `workspace_id: string` + + Tagged ID of the workspace this rule is enabled for. + + - `workspace_name: string | null` + + Workspace display name. Populated when listing; null in the enable response. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaFederationRuleWorkspace of client.beta.organization.federation.rules.workspaces.list( + "federation_rule_id" +)) { + console.log(betaFederationRuleWorkspace.created_by_actor_id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace", + "workspace_id": "workspace_id", + "workspace_name": "workspace_name" + } + ], + "next_page": "next_page" +} +``` + +### Remove Federation Rule Workspace + +`client.beta.organization.federation.rules.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse` + +**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Disable a federation rule for a workspace. + +Idempotent; succeeds even if the enablement was already removed. OAuth +callers may only manage rules whose `oauth_scope` is +`workspace:developer` or `workspace:inference`; other scopes require a +Console session. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace to disable for. + +- `params: WorkspaceRemoveParams` + + - `federation_rule_id: string` + + Path param: ID of the federation rule. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `WorkspaceRemoveResponse` + + - `federation_rule_id: string` + + Tagged ID of the federation rule. + + - `type: "federation_rule_workspace_deleted"` + + default: federation_rule_workspace_deleted + + - `workspace_id: string` + + Tagged ID of the workspace named in the delete request. Removal is idempotent. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const workspace = await client.beta.organization.federation.rules.workspaces.remove( + "workspace_id", + { federation_rule_id: "federation_rule_id" } +); + +console.log(workspace.federation_rule_id); +``` + +##### Response (200) + +```json +{ + "federation_rule_id": "federation_rule_id", + "type": "federation_rule_workspace_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Invites + +### Create Invite + +`client.beta.organization.invites.create(body, options?): BetaOrganizationInvite` + +**POST** `/v1/organizations/invites` + +Invite a user to join the organization by email. + +On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. + +#### Parameters + +- `body: InviteCreateParams` + + - `email: string` + + Email of the User. + + format: email + + - `role: "billing" | "claude_code_user" | "developer" | 2 more` + + Role for the invited User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + + - `rbac_group_ids?: Array` + + RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. + + maxItems: 100 + +#### Returns + +- `BetaOrganizationInvite` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string | null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: Array` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" | "deleted" | "expired" | "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaOrganizationInvite = await client.beta.organization.invites.create({ + email: "user@emaildomain.com", + role: "user" +}); + +console.log(betaOrganizationInvite.id); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### List Invites + +`client.beta.organization.invites.list(query?, options?): Page` + +**GET** `/v1/organizations/invites` + +List the organization's invites. + +#### Parameters + +- `query: InviteListParams` + + - `after_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `before_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `email?: string` + + Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). + + format: email + + - `limit?: number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `roles?: Array` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + + - `statuses?: Array<"accepted" | "expired" | "pending">` + + Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. + + - `"accepted"` + + - `"expired"` + + - `"pending"` + +#### Returns + +- `BetaOrganizationInvite` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string | null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: Array` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" | "deleted" | "expired" | "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaOrganizationInvite of client.beta.organization.invites.list()) { + console.log(betaOrganizationInvite.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get Invite + +`client.beta.organization.invites.retrieve(inviteID, options?): BetaOrganizationInvite` + +**GET** `/v1/organizations/invites/{invite_id}` + +Retrieve an invite by ID. + +#### Parameters + +- `inviteID: string` + + ID of the Invite. + +#### Returns + +- `BetaOrganizationInvite` + + - `id: string` + + ID of the Invite. + + - `accepted_at: string | null` + + RFC 3339 datetime string indicating when the Invite was accepted, or null. + + format: date-time + + - `email: string` + + Email of the User being invited. + + - `expires_at: string` + + RFC 3339 datetime string indicating when the Invite expires. + + format: date-time + + - `invited_at: string` + + RFC 3339 datetime string indicating when the Invite was created. + + format: date-time + + - `rbac_group_ids: Array` + + RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `status: "accepted" | "deleted" | "expired" | "pending"` + + Status of the Invite. + + - `"accepted"` + + - `"deleted"` + + - `"expired"` + + - `"pending"` + + - `type: "invite"` + + Object type. + + For Invites, this is always `"invite"`. + + default: invite + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaOrganizationInvite = await client.beta.organization.invites.retrieve("invite_id"); + +console.log(betaOrganizationInvite.id); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "accepted_at": "2019-12-27T18:11:19.117Z", + "email": "user@emaildomain.com", + "expires_at": "2024-11-20T23:58:27.427722Z", + "invited_at": "2024-10-30T23:58:27.427722Z", + "rbac_group_ids": [ + "string" + ], + "role": "admin", + "status": "pending", + "type": "invite" +} +``` + +### Delete Invite + +`client.beta.organization.invites.delete(inviteID, options?): InviteDeleteResponse` + +**DELETE** `/v1/organizations/invites/{invite_id}` + +Delete a pending invite. + +#### Parameters + +- `inviteID: string` + + ID of the Invite. + +#### Returns + +- `InviteDeleteResponse` + + - `id: string` + + ID of the Invite. + + - `type: "invite_deleted"` + + Deleted object type. + + For Invites, this is always `"invite_deleted"`. + + default: invite_deleted + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const invite = await client.beta.organization.invites.delete("invite_id"); + +console.log(invite.id); +``` + +##### Response (200) + +```json +{ + "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", + "type": "invite_deleted" +} +``` + +## Beta › Organization › Service Accounts + +### Create Service Account + +`client.beta.organization.serviceAccounts.create(params, options?): BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Create a service account. + +A service account is a named workload identity that federation rules +target. `organization_role` is `developer` (default) or `admin`; a rule +may only be created or retargeted to grant `org:admin` scope when the +target's `organization_role` is `admin`. Creating an `admin`-role service +account requires an interactive credential (a user OAuth token or a +Console session) — a workload may only create `developer`-role service +accounts. + +#### Parameters + +- `params: ServiceAccountCreateParams` + + - `name: string` + + Body param: Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. + + maxLength: 255, minLength: 1 + + - `description?: string | null` + + Body param: Optional free-text description. + + maxLength: 2000 + + - `organization_role?: "admin" | "developer"` + + Body param: Org-level role. Defaults to `developer`. + + - `"admin"` + + - `"developer"` + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string | null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string | null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" | "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaServiceAccount = await client.beta.organization.serviceAccounts.create({ + name: "ci-deploy-bot" +}); + +console.log(betaServiceAccount.id); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### List Service Accounts + +`client.beta.organization.serviceAccounts.list(params?, options?): PageCursor` + +**GET** `/v1/organizations/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List service accounts in the caller's organization. + +Results are ordered by creation time, newest first. Use `limit` and the +`next_page` cursor to paginate; set `include_archived=true` to include +archived service accounts. + +#### Parameters + +- `params: ServiceAccountListParams` + + - `include_archived?: boolean` + + Query param: Include archived resources. Defaults to false. + + - `limit?: number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `page?: string | null` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string | null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string | null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" | "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaServiceAccount of client.beta.organization.serviceAccounts.list()) { + console.log(betaServiceAccount.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" + } + ], + "next_page": "next_page" +} +``` + +### Get Service Account + +`client.beta.organization.serviceAccounts.retrieve(serviceAccountID, params?, options?): BetaServiceAccount` + +**GET** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Retrieve a service account by its ID (`svac_...`). + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account. + +- `params: ServiceAccountRetrieveParams` + + - `betas?: Array` + + Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string | null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string | null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" | "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaServiceAccount = await client.beta.organization.serviceAccounts.retrieve( + "service_account_id" +); + +console.log(betaServiceAccount.id); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Update Service Account + +`client.beta.organization.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts/{service_account_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Update a service account. + +Only `description` and `organization_role` are mutable; `name` cannot be +changed. Archived service accounts cannot be updated; this returns 400. +Setting `organization_role` to `admin` (even when unchanged) requires an +interactive credential (a user OAuth token or a Console session). + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account to update. + +- `params: ServiceAccountUpdateParams` + + - `description?: string | null` + + Body param: Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). + + maxLength: 2000 + + - `organization_role?: "admin" | "developer" | null` + + Body param: Replaces the org-level role. Omit or send `null` to leave unchanged. + + - `"admin"` + + - `"developer"` + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string | null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string | null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" | "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaServiceAccount = await client.beta.organization.serviceAccounts.update( + "service_account_id" +); + +console.log(betaServiceAccount.id); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +### Archive Service Account + +`client.beta.organization.serviceAccounts.archive(serviceAccountID, params?, options?): BetaServiceAccount` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/archive` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Archive a service account. + +Idempotent; re-archiving returns the service account with its original +`archived_at`. Rejected with 400 if any live (non-archived) federation +rule still targets this service account, same as issuer archival; archive +those rules first or change their target to another service account. + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account to archive. + +- `params: ServiceAccountArchiveParams` + + - `betas?: Array` + + Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccount` + + Named non-human identity within the caller's organization. + + A service account is a pure identity: name + org. Authorization lives on + whatever references it (federation rules). + + - `id: string` + + Tagged ID of the service account. + + - `archived_at: string | null` + + If set, this service account is archived. + + format: date-time + + - `archived_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that archived this service account. + + - `created_at: string` + + When this service account was created. + + format: date-time + + - `created_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that created this service account. + + - `description: string | null` + + Optional free-text description. + + - `name: string` + + Admin-chosen slug identifier. + + - `organization_role: "admin" | "developer"` + + Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. + + - `"admin"` + + - `"developer"` + + - `type: "service_account"` + + default: service_account + + - `updated_at: string` + + When this service account was last updated. + + format: date-time + + - `updated_by_actor_id: string | null` + + Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaServiceAccount = await client.beta.organization.serviceAccounts.archive( + "service_account_id" +); + +console.log(betaServiceAccount.id); +``` + +##### Response (200) + +```json +{ + "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", + "archived_at": "2019-12-27T18:11:19.117Z", + "archived_by_actor_id": "archived_by_actor_id", + "created_at": "2024-10-30T23:58:27.427722Z", + "created_by_actor_id": "created_by_actor_id", + "description": "description", + "name": "ci-deploy-bot", + "organization_role": "admin", + "type": "service_account", + "updated_at": "2024-10-30T23:58:27.427722Z", + "updated_by_actor_id": "updated_by_actor_id" +} +``` + +## Beta › Organization › Service Accounts › Workspaces + +### Add Workspace To Service Account + +`client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember` + +**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed +from the service-account side; both create the same membership. If the +service account is already an explicit member of the workspace, its +`workspace_role` is replaced with the value supplied here. Archived +workspaces return 400. Archived service accounts cannot be added and are +rejected. + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account. + +- `params: WorkspaceAddParams` + + - `workspace_id: string` + + Body param: Tagged workspace ID to add the service account to. + + - `workspace_role: BetaNoBillingWorkspaceRole` + + Body param: Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string | null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean | null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaServiceAccountWorkspaceMember = + await client.beta.organization.serviceAccounts.workspaces.add("service_account_id", { + workspace_id: "workspace_id", + workspace_role: "workspace_admin" + }); + +console.log(betaServiceAccountWorkspaceMember.created_by_actor_id); +``` + +##### Response (200) + +```json +{ + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" +} +``` + +### List Workspaces For Service Account + +`client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, params?, options?): PageCursor` + +**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the workspaces a service account is a member of. + +Each entry includes the service account's `workspace_role` in that +workspace. Use `limit` and the `next_page` cursor to paginate. When the +service account has no explicit default-workspace membership, the +implicit (`implicit: true`) membership is returned as the first entry on +the first page; with `limit=1` the first page may return up to 2 entries +(the implicit entry plus one explicit membership) so a pagination cursor +can be derived. Memberships are returned only while +the service account is active. Without a `page` cursor, an archived +service account returns an empty list. A `page` cursor that does not +match an active membership returns a 400 invalid-request error. A cursor +stops matching when the membership is removed, the workspace is deleted, +or the service account is archived. Restart pagination from the first +page to recover. + +#### Parameters + +- `serviceAccountID: string` + + ID of the service account. + +- `params: WorkspaceListParams` + + - `limit?: number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `page?: string | null` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string | null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean | null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaServiceAccountWorkspaceMember of client.beta.organization.serviceAccounts.workspaces.list( + "service_account_id" +)) { + console.log(betaServiceAccountWorkspaceMember.created_by_actor_id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Remove Workspace From Service Account + +`client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse` + +**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Remove a service account from a workspace. + +Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, +addressed from the service-account side. Removal is idempotent (returns +200 even if the membership was already removed). A DELETE against the +implicit default-workspace membership returns 200 but is a no-op and the +membership persists; deleting an explicit default-workspace row reverts +to the implicit `workspace_user` membership. Archived workspaces return +400. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace. + +- `params: WorkspaceRemoveParams` + + - `service_account_id: string` + + Path param: ID of the service account. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `WorkspaceRemoveResponse` + + - `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const workspace = await client.beta.organization.serviceAccounts.workspaces.remove( + "workspace_id", + { service_account_id: "service_account_id" } +); + +console.log(workspace.service_account_id); +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Users + +### List Users + +`client.beta.organization.users.list(query?, options?): Page` + +**GET** `/v1/organizations/users` + +List the organization's members. + +#### Parameters + +- `query: UserListParams` + + - `after_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `before_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `email?: string` + + Filter by user email. + + format: email + + - `limit?: number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + + - `roles?: Array` + + Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. + + Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. + +#### Returns + +- `BetaOrganizationUser` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaOrganizationUser of client.beta.organization.users.list()) { + console.log(betaOrganizationUser.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Get User + +`client.beta.organization.users.retrieve(userID, options?): BetaOrganizationUser` + +**GET** `/v1/organizations/users/{user_id}` + +Retrieve a member of the organization by user ID. + +#### Parameters + +- `userID: string` + + ID of the User. + +#### Returns + +- `BetaOrganizationUser` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaOrganizationUser = await client.beta.organization.users.retrieve("user_id"); + +console.log(betaOrganizationUser.id); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Update User + +`client.beta.organization.users.update(userID, body, options?): BetaOrganizationUser` + +**POST** `/v1/organizations/users/{user_id}` + +Update a member's organization role. + +#### Parameters + +- `userID: string` + + ID of the User. + +- `body: UserUpdateParams` + + - `role: "billing" | "claude_code_user" | "developer" | 2 more` + + New role for the User. + + The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`. + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"user"` + +#### Returns + +- `BetaOrganizationUser` + + - `id: string` + + ID of the User. + + - `added_at: string` + + RFC 3339 datetime string indicating when the User joined the Organization. + + format: date-time + + - `email: string` + + Email of the User. + + - `name: string` + + Name of the User. + + - `role: BetaOrganizationRole` + + Organization role of the User. + + - `"admin"` + + - `"billing"` + + - `"claude_code_user"` + + - `"developer"` + + - `"managed"` + + - `"membership_admin"` + + - `"owner"` + + - `"primary_owner"` + + - `"user"` + + - `type: "user"` + + Object type. + + For Users, this is always `"user"`. + + default: user + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaOrganizationUser = await client.beta.organization.users.update("user_id", { + role: "user" +}); + +console.log(betaOrganizationUser.id); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "added_at": "2024-10-30T23:58:27.427722Z", + "email": "user@emaildomain.com", + "name": "Jane Doe", + "role": "admin", + "type": "user" +} +``` + +### Remove User + +`client.beta.organization.users.remove(userID, options?): UserRemoveResponse` + +**DELETE** `/v1/organizations/users/{user_id}` + +Remove a member from the organization. + +#### Parameters + +- `userID: string` + + ID of the User. + +#### Returns + +- `UserRemoveResponse` + + - `id: string` + + ID of the User. + + - `type: "user_deleted"` + + Deleted object type. + + For Users, this is always `"user_deleted"`. + + default: user_deleted + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const user = await client.beta.organization.users.remove("user_id"); + +console.log(user.id); +``` + +##### Response (200) + +```json +{ + "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "type": "user_deleted" +} +``` + +## Beta › Organization › Workspaces + +### List Workspaces + +`client.beta.organization.workspaces.list(query?, options?): Page` + +**GET** `/v1/organizations/workspaces` + +List Workspaces + +#### Parameters + +- `query: WorkspaceListParams` + + - `after_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `before_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `include_archived?: boolean` + + Whether to include Workspaces that have been archived in the response + + - `limit?: number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string | null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array | "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Array` + + - `"unrestricted"` + + - `"unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string | null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: Record` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaWorkspace of client.beta.organization.workspaces.list()) { + console.log(betaWorkspace.id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace + +`client.beta.organization.workspaces.create(params, options?): BetaWorkspace` + +**POST** `/v1/organizations/workspaces` + +Create Workspace + +#### Parameters + +- `params: WorkspaceCreateParams` + + - `name: string` + + Body param: Name of the Workspace. + + maxLength: 40, minLength: 1 + + - `data_residency?: BetaDataResidencyCreateConfig | null` + + Body param: Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. + + - `allowed_inference_geos?: Array | "unrestricted" | null` + + Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. + + - `Array` + + - `"global"` + + - `"us"` + + - `"unrestricted"` + + - `"unrestricted"` + + - `default_inference_geo?: "global" | "us" | null` + + Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + + - `workspace_geo?: "us" | null` + + Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. + + - `display_color?: string | null` + + Body param: Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + + - `external_key_id?: string | null` + + Body param: ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `tags?: Record | null` + + Body param: User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string | null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array | "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Array` + + - `"unrestricted"` + + - `"unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string | null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: Record` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaWorkspace = await client.beta.organization.workspaces.create({ name: "x" }); + +console.log(betaWorkspace.id); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Get Workspace + +`client.beta.organization.workspaces.retrieve(workspaceID, options?): BetaWorkspace` + +**GET** `/v1/organizations/workspaces/{workspace_id}` + +Get Workspace + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +#### Returns + +- `BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string | null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array | "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Array` + + - `"unrestricted"` + + - `"unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string | null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: Record` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaWorkspace = await client.beta.organization.workspaces.retrieve("workspace_id"); + +console.log(betaWorkspace.id); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Update Workspace + +`client.beta.organization.workspaces.update(workspaceID, body, options?): BetaWorkspace` + +**POST** `/v1/organizations/workspaces/{workspace_id}` + +Update Workspace + +#### Parameters + +- `workspaceID: string` + +- `body: WorkspaceUpdateParams` + + - `data_residency?: BetaDataResidencyUpdateConfig | null` + + Data residency configuration for the workspace. + + - `allowed_inference_geos?: Array | "unrestricted" | null` + + Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. + + - `Array` + + - `"global"` + + - `"us"` + + - `"unrestricted"` + + - `"unrestricted"` + + - `default_inference_geo?: "global" | "us" | null` + + Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. + + - `"global"` + + - `"us"` + + - `display_color?: string` + + Hex color code representing the Workspace in the Anthropic Console. + + maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ + + - `external_key_id?: string` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name?: string` + + Name of the Workspace. + + maxLength: 40, minLength: 1 + + - `tags?: Record | null` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + +#### Returns + +- `BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string | null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array | "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Array` + + - `"unrestricted"` + + - `"unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string | null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: Record` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaWorkspace = await client.beta.organization.workspaces.update("workspace_id"); + +console.log(betaWorkspace.id); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +### Archive Workspace + +`client.beta.organization.workspaces.archive(workspaceID, options?): BetaWorkspace` + +**POST** `/v1/organizations/workspaces/{workspace_id}/archive` + +Archive Workspace + +#### Parameters + +- `workspaceID: string` + +#### Returns + +- `BetaWorkspace` + + - `id: string` + + ID of the Workspace. + + - `archived_at: string | null` + + RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + + format: date-time + + - `compartment_id: string` + + Identifier for this Workspace's encryption compartment. When you configure a + customer-managed encryption key (CMEK) on AWS, reference this value in your + KMS key-policy condition so the key is scoped to this compartment. On GCP and + Azure, Anthropic enforces the compartment binding automatically; you do not + need to reference this value in your key configuration. See the CMEK integration guide for the + required key configuration, including the value used during key validation. + + - `created_at: string` + + RFC 3339 datetime string indicating when the Workspace was created. + + format: date-time + + - `data_residency: BetaDataResidency` + + Data residency configuration. + + - `allowed_inference_geos: Array | "unrestricted"` + + Permitted inference geo values. 'unrestricted' means all geos are allowed. + + - `Array` + + - `"unrestricted"` + + - `"unrestricted"` + + - `default_inference_geo: string` + + Default inference geo applied when requests omit the parameter. + + - `workspace_geo: string` + + Geographic region for workspace data storage. Immutable after creation. + + - `display_color: string` + + Hex color code representing the Workspace in the Anthropic Console. + + - `external_key_id: string | null` + + ID of the customer-managed encryption key (CMEK) configuration to use for this + Workspace. Setting this field requires CMEK to be enabled for your + organization. When set, data stored for this Workspace is encrypted with the + referenced key. Create key configurations with the External Keys API. This + field is write-once: once a key is attached to a Workspace it cannot be + detached or replaced. To rotate key material, rotate the underlying key on + your cloud KMS; the `external_key_id` stays the same. + + - `name: string` + + Name of the Workspace. + + - `tags: Record` + + User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. + + - `type: "workspace"` + + Object type. + + For Workspaces, this is always `"workspace"`. + + default: workspace + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaWorkspace = await client.beta.organization.workspaces.archive("workspace_id"); + +console.log(betaWorkspace.id); +``` + +##### Response (200) + +```json +{ + "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "archived_at": "2024-11-01T23:59:27.427722Z", + "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", + "created_at": "2024-10-30T23:58:27.427722Z", + "data_residency": { + "allowed_inference_geos": "unrestricted", + "default_inference_geo": "default_inference_geo", + "workspace_geo": "workspace_geo" + }, + "display_color": "#6C5BB9", + "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", + "name": "Workspace Name", + "tags": { + "env": "prod", + "team": "platform" + }, + "type": "workspace" +} +``` + +## Beta › Organization › Workspaces › Rate Limits + +### List Workspace Rate Limits + +`client.beta.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor` + +**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` + +List rate-limit overrides configured for a workspace. + +Returns only the groups and limiter types that have a workspace-level +override. Groups without overrides inherit the organization limits and +are not listed; use `GET /v1/organizations/rate_limits` to see those. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `workspaceID: string` + + The ID of the workspace. + +- `query: RateLimitListParams` + + - `group_type?: "batch" | "files" | "model_group" | 3 more | null` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limit?: number | null` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + + - `page?: string | null` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `BetaWorkspaceRateLimit` + + - `group_type: "batch" | "files" | "model_group" | 3 more` + + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limits: Array` + + The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value. + + - `org_limit: number | null` + + The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. + + - `type: string` + + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). + + - `value: number` + + The workspace-level override value for this limiter type. + + - `models: Array | null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `rate_limit_id: string` + + The `id` of the RateLimit group this override applies to. + + - `type: "workspace_rate_limit"` + + Object type. Always `workspace_rate_limit` for workspace rate-limit entries. + + default: workspace_rate_limit + + - `workspace_id: string` + + ID of the Workspace this override applies to. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaWorkspaceRateLimit of client.beta.organization.workspaces.rateLimits.list( + "workspace_id" +)) { + console.log(betaWorkspaceRateLimit.rate_limit_id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "group_type": "batch", + "limits": [ + { + "org_limit": 0, + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "rate_limit_id": "rate_limit_id", + "type": "workspace_rate_limit", + "workspace_id": "workspace_id" + } + ], + "next_page": "next_page" +} +``` + +## Beta › Organization › Workspaces › Members + +### List Workspace Members + +`client.beta.organization.workspaces.members.list(workspaceID, query?, options?): Page` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members` + +List Workspace Members + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +- `query: MemberListParams` + + - `after_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + + - `before_id?: string` + + ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. + + - `limit?: number` + + Number of items to return per page. + + Defaults to `20`. Ranges from `1` to `1000`. + + maximum: 1000, minimum: 1 + +#### Returns + +- `BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaWorkspaceMember of client.beta.organization.workspaces.members.list( + "workspace_id" +)) { + console.log(betaWorkspaceMember.user_id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" + } + ], + "first_id": "first_id", + "has_more": true, + "last_id": "last_id" +} +``` + +### Create Workspace Member + +`client.beta.organization.workspaces.members.add(workspaceID, body, options?): BetaWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members` + +Create Workspace Member + +#### Parameters + +- `workspaceID: string` + + ID of the Workspace. + +- `body: MemberAddParams` + + - `user_id: string` + + ID of the User. + + - `workspace_role: BetaNoBillingWorkspaceRole` + + Role of the new Workspace Member. Cannot be `workspace_billing`. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaWorkspaceMember = await client.beta.organization.workspaces.members.add( + "workspace_id", + { user_id: "user_01WCz1FkmYMm4gnmykNKUu3Q", workspace_role: "workspace_admin" } +); + +console.log(betaWorkspaceMember.user_id); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Get Workspace Member + +`client.beta.organization.workspaces.members.retrieve(userID, params, options?): BetaWorkspaceMember` + +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Get Workspace Member + +#### Parameters + +- `userID: string` + + ID of the User. + +- `params: MemberRetrieveParams` + + - `workspace_id: string` + + ID of the Workspace. + +#### Returns + +- `BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaWorkspaceMember = await client.beta.organization.workspaces.members.retrieve( + "user_id", + { workspace_id: "workspace_id" } +); + +console.log(betaWorkspaceMember.user_id); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Update Workspace Member + +`client.beta.organization.workspaces.members.update(userID, params, options?): BetaWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Update Workspace Member + +#### Parameters + +- `userID: string` + + ID of the User. + +- `params: MemberUpdateParams` + + - `workspace_id: string` + + Path param: ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Body param: New workspace role for the User. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Returns + +- `BetaWorkspaceMember` + + - `type: "workspace_member"` + + Object type. + + For Workspace Members, this is always `"workspace_member"`. + + default: workspace_member + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + + - `workspace_role: BetaWorkspaceRole` + + Role of the Workspace Member. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const betaWorkspaceMember = await client.beta.organization.workspaces.members.update( + "user_id", + { workspace_id: "workspace_id", workspace_role: "workspace_admin" } +); + +console.log(betaWorkspaceMember.user_id); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "workspace_role": "workspace_admin" +} +``` + +### Delete Workspace Member + +`client.beta.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse` + +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` + +Delete Workspace Member + +#### Parameters + +- `userID: string` + + ID of the User. + +- `params: MemberRemoveParams` + + - `workspace_id: string` + + ID of the Workspace. + +#### Returns + +- `MemberRemoveResponse` + + - `type: "workspace_member_deleted"` + + Deleted object type. + + For Workspace Members, this is always `"workspace_member_deleted"`. + + default: workspace_member_deleted + + - `user_id: string` + + ID of the User. + + - `workspace_id: string` + + ID of the Workspace. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const member = await client.beta.organization.workspaces.members.remove("user_id", { + workspace_id: "workspace_id" +}); + +console.log(member.user_id); +``` + +##### Response (200) + +```json +{ + "type": "workspace_member_deleted", + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" +} +``` + +## Beta › Organization › Workspaces › Service Accounts + +### List Service Account Workspace Members + +`client.beta.organization.workspaces.serviceAccounts.list(workspaceID, params?, options?): PageCursor` + +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +List the service accounts that are members of a workspace. + +Each entry includes the service account's `workspace_role`. Use `limit` +and the `next_page` cursor to paginate. Archived workspaces return 400; +use `GET /service_accounts/{id}/workspaces` to audit memberships of an +archived workspace. The implicit default-workspace membership is not +included in this list. Memberships of archived service accounts are +omitted from the results. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace. + +- `params: ServiceAccountListParams` + + - `limit?: number` + + Query param: Number of results per page. + + maximum: 100, minimum: 1 + + - `page?: string | null` + + Query param: Opaque cursor from a previous response's `next_page`. + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + + - `"output-300k-2026-03-24"` + + - `"user-profiles-2026-03-24"` + + - `"user-profiles-2026-08-18"` + + - `"advisor-tool-2026-03-01"` + + - `"managed-agents-2026-04-01"` + + - `"cache-diagnosis-2026-04-07"` + + - `"dreaming-2026-04-21"` + + - `"thinking-token-count-2026-05-13"` + + - `"server-side-fallback-2026-06-01"` + + - `"server-side-fallback-2026-07-01"` + + - `"fallback-credit-2026-06-01"` + + - `"fallback-credit-2026-07-01"` + + - `"agent-memory-2026-07-22"` + + - `"mid-conversation-tool-changes-2026-07-01"` + + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + +#### Returns + +- `BetaServiceAccountWorkspaceMember` + + - `created_by_actor_id: string | null` + + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. + + - `implicit: boolean | null` + + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. + + - `service_account_id: string` + + Tagged service account ID (`svac_...`). + + - `type: "service_account_workspace_member"` + + default: service_account_workspace_member + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`). + + - `workspace_role: BetaWorkspaceRole` + + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. + + - `"workspace_admin"` + + - `"workspace_billing"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +// Automatically fetches more pages as needed. +for await (const betaServiceAccountWorkspaceMember of client.beta.organization.workspaces.serviceAccounts.list( + "workspace_id" +)) { + console.log(betaServiceAccountWorkspaceMember.created_by_actor_id); +} +``` + +##### Response (200) + +```json +{ + "data": [ + { + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" + } + ], + "next_page": "next_page" +} +``` + +### Create Service Account Workspace Member + +`client.beta.organization.workspaces.serviceAccounts.add(workspaceID, params, options?): BetaServiceAccountWorkspaceMember` + +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` + +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). + +Add a service account to a workspace with the given `workspace_role`. + +The role determines what the service account can do in the workspace and +which workspace-scoped permissions it can be granted when authenticating +through federation. Every service account is already an implicit +`workspace_user` member of the default workspace; adding it explicitly +assigns a chosen role. If the service account is already an explicit +member of the workspace, its `workspace_role` is replaced with the +value supplied here. Archived workspaces return 400. Archived service +accounts cannot be added and are rejected. + +#### Parameters + +- `workspaceID: string` + + ID of the workspace. + +- `params: ServiceAccountAddParams` + + - `service_account_id: string` + + Body param: Tagged service account ID to add. + + - `workspace_role: BetaNoBillingWorkspaceRole` + + Body param: Role to assign to the service account in this workspace. + + - `"workspace_admin"` + + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` + + - `betas?: Array` + + Header param: Optional header to specify the beta version(s) you want to use. + + - `(string & {})` + + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -66144,43 +78247,57 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `BetaTunnelCertificate` +- `BetaServiceAccountWorkspaceMember` - A CA certificate attached to a tunnel. + - `created_by_actor_id: string | null` - - `id: string` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `implicit: boolean | null` - - `archived_at: string | null` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `service_account_id: string` - format: date-time + Tagged service account ID (`svac_...`). - - `created_at: string` + - `type: "service_account_workspace_member"` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `workspace_id: string` - - `expires_at: string | null` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `workspace_role: BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `fingerprint: string` + - `"workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `"workspace_billing"` - - `tunnel_id: string` + - `"workspace_developer"` - ID of the tunnel the certificate is registered against. + - `"workspace_restricted_developer"` - - `type: "tunnel_certificate"` + - `"workspace_user"` #### Example @@ -66191,46 +78308,56 @@ const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); -const betaTunnelCertificate = await client.beta.tunnels.certificates.create("tunnel_id", { - ca_certificate_pem: "ca_certificate_pem" -}); +const betaServiceAccountWorkspaceMember = + await client.beta.organization.workspaces.serviceAccounts.add("workspace_id", { + service_account_id: "service_account_id", + workspace_role: "workspace_admin" + }); -console.log(betaTunnelCertificate.id); +console.log(betaServiceAccountWorkspaceMember.created_by_actor_id); ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Get Tunnel Certificate +### Get Service Account Workspace Member -`client.beta.tunnels.certificates.retrieve(certificateID, params, options?): BetaTunnelCertificate` +`client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember` -**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` +**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Fetches a tunnel certificate by ID. +Retrieve a service account's membership in a workspace. + +Returns the membership record, including the service account's +`workspace_role` in this workspace. Archived workspaces return 400. For +the default workspace, returns the implicit (`implicit: true`) +membership when no explicit membership exists; an explicitly added +membership is returned with its assigned role. An archived service +account returns 404. #### Parameters -- `certificateID: string` +- `serviceAccountID: string` -- `params: CertificateRetrieveParams` + ID of the service account. - - `tunnel_id: string` +- `params: ServiceAccountRetrieveParams` - Path param: Path parameter tunnel_id + - `workspace_id: string` + + Path param: ID of the workspace. - `betas?: Array` @@ -66238,7 +78365,7 @@ Fetches a tunnel certificate by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -66308,43 +78435,57 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `BetaTunnelCertificate` +- `BetaServiceAccountWorkspaceMember` - A CA certificate attached to a tunnel. + - `created_by_actor_id: string | null` - - `id: string` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `implicit: boolean | null` - - `archived_at: string | null` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `service_account_id: string` - format: date-time + Tagged service account ID (`svac_...`). - - `created_at: string` + - `type: "service_account_workspace_member"` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `workspace_id: string` - - `expires_at: string | null` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `workspace_role: BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `fingerprint: string` + - `"workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `"workspace_billing"` - - `tunnel_id: string` + - `"workspace_developer"` - ID of the tunnel the certificate is registered against. + - `"workspace_restricted_developer"` - - `type: "tunnel_certificate"` + - `"workspace_user"` #### Example @@ -66355,57 +78496,67 @@ const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); -const betaTunnelCertificate = await client.beta.tunnels.certificates.retrieve( - "certificate_id", - { tunnel_id: "tunnel_id" } -); +const betaServiceAccountWorkspaceMember = + await client.beta.organization.workspaces.serviceAccounts.retrieve("service_account_id", { + workspace_id: "workspace_id" + }); -console.log(betaTunnelCertificate.id); +console.log(betaServiceAccountWorkspaceMember.created_by_actor_id); ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### List Tunnel Certificates +### Update Service Account Workspace Member -`client.beta.tunnels.certificates.list(tunnelID, params?, options?): PageCursor` +`client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): BetaServiceAccountWorkspaceMember` -**GET** `/v1/tunnels/{tunnel_id}/certificates` +**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. +Change a service account's role in a workspace. + +The new `workspace_role` replaces the current one. Only explicit +memberships can be updated; to set a role on the implicit +default-workspace membership, add the service account explicitly with +`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces +return 400. Archived service accounts cannot be updated and are +rejected. #### Parameters -- `tunnelID: string` +- `serviceAccountID: string` -- `params: CertificateListParams` + ID of the service account. - - `include_archived?: boolean` +- `params: ServiceAccountUpdateParams` - Query param: Whether to include archived certificates in the results. Defaults to false. + - `workspace_id: string` - - `limit?: number` + Path param: ID of the workspace. - Query param: Maximum number of certificates to return per page. Defaults to 20, maximum 1000. + - `workspace_role: BetaNoBillingWorkspaceRole` - format: int32 + Body param: New role for the service account in this workspace. - - `page?: string` + - `"workspace_admin"` - Query param: Opaque pagination cursor from a previous `list_tunnel_certificates` response. + - `"workspace_developer"` + + - `"workspace_restricted_developer"` + + - `"workspace_user"` - `betas?: Array` @@ -66413,7 +78564,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -66483,43 +78634,57 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `BetaTunnelCertificate` +- `BetaServiceAccountWorkspaceMember` - A CA certificate attached to a tunnel. + - `created_by_actor_id: string | null` - - `id: string` + Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - Unique identifier for the certificate, prefixed with `tcrt_`. + - `implicit: boolean | null` - - `archived_at: string | null` + True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - A timestamp in RFC 3339 format + - `service_account_id: string` - format: date-time + Tagged service account ID (`svac_...`). - - `created_at: string` + - `type: "service_account_workspace_member"` - A timestamp in RFC 3339 format + default: service_account_workspace_member - format: date-time + - `workspace_id: string` - - `expires_at: string | null` + Tagged workspace ID (`wrkspc_...`). - A timestamp in RFC 3339 format + - `workspace_role: BetaWorkspaceRole` - format: date-time + Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - - `fingerprint: string` + - `"workspace_admin"` - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `"workspace_billing"` - - `tunnel_id: string` + - `"workspace_developer"` - ID of the tunnel the certificate is registered against. + - `"workspace_restricted_developer"` - - `type: "tunnel_certificate"` + - `"workspace_user"` #### Example @@ -66530,50 +78695,55 @@ const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); -// Automatically fetches more pages as needed. -for await (const betaTunnelCertificate of client.beta.tunnels.certificates.list("tunnel_id")) { - console.log(betaTunnelCertificate.id); -} +const betaServiceAccountWorkspaceMember = + await client.beta.organization.workspaces.serviceAccounts.update("service_account_id", { + workspace_id: "workspace_id", + workspace_role: "workspace_admin" + }); + +console.log(betaServiceAccountWorkspaceMember.created_by_actor_id); ``` ##### Response (200) ```json { - "data": [ - { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" - } - ], - "next_page": "next_page" + "created_by_actor_id": "created_by_actor_id", + "implicit": true, + "service_account_id": "service_account_id", + "type": "service_account_workspace_member", + "workspace_id": "workspace_id", + "workspace_role": "workspace_admin" } ``` -### Archive Tunnel Certificate +### Delete Service Account Workspace Member -`client.beta.tunnels.certificates.archive(certificateID, params, options?): BetaTunnelCertificate` +`client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse` -**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` +**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` -The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. +**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api). -Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. +Remove a service account from a workspace. + +Removal is idempotent (returns 200 even if the membership was already +removed). A DELETE against the implicit default-workspace membership +returns 200 but is a no-op and the membership persists; deleting an +explicit default-workspace row reverts to the implicit `workspace_user` +membership. Archived workspaces return 400. #### Parameters -- `certificateID: string` +- `serviceAccountID: string` -- `params: CertificateArchiveParams` + ID of the service account. - - `tunnel_id: string` +- `params: ServiceAccountRemoveParams` - Path param: Path parameter tunnel_id + - `workspace_id: string` + + Path param: ID of the workspace. - `betas?: Array` @@ -66581,7 +78751,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -66651,43 +78821,162 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns -- `BetaTunnelCertificate` +- `ServiceAccountRemoveResponse` - A CA certificate attached to a tunnel. + - `service_account_id: string` + + Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. + + - `type: "service_account_workspace_member_deleted"` + + default: service_account_workspace_member_deleted + + - `workspace_id: string` + + Tagged workspace ID (`wrkspc_...`) named in the delete request. + +#### Example + +```typescript +import Anthropic from "@anthropic-ai/sdk"; + +const client = new Anthropic({ + apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted +}); + +const serviceAccount = await client.beta.organization.workspaces.serviceAccounts.remove( + "service_account_id", + { workspace_id: "workspace_id" } +); + +console.log(serviceAccount.service_account_id); +``` + +##### Response (200) + +```json +{ + "service_account_id": "service_account_id", + "type": "service_account_workspace_member_deleted", + "workspace_id": "workspace_id" +} +``` + +## Beta › Organization › Rate Limits + +### List Organization Rate Limits + +`client.beta.organization.rateLimits.list(query?, options?): PageCursor` + +**GET** `/v1/organizations/rate_limits` + +List Messages API rate limits for your organization. + +Each entry corresponds to one rate-limit group (either a model family +or an API-surface category such as the Files API or Message Batches) +and contains the set of limiter values that apply to it. + +This endpoint currently returns every matching entry in a single page +regardless of `limit`; follow `next_page` so that clients keep working +when pagination is enabled. + +#### Parameters + +- `query: RateLimitListParams` + + - `group_type?: "batch" | "files" | "model_group" | 3 more | null` + + Filter by group type. + + - `"batch"` + + - `"files"` + + - `"model_group"` + + - `"skills"` + + - `"token_count"` + + - `"web_search"` + + - `limit?: number | null` + + Maximum number of items to return per page. Ranges from `1` to `1000`. + + Accepted for request-shape compatibility and currently ignored: every entry is returned in a single page. + + maximum: 1000, minimum: 1 + + - `model?: string | null` + + Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. + + - `page?: string | null` + + Opaque cursor from a previous response's `next_page`. + +#### Returns + +- `BetaOrganizationRateLimit` - `id: string` - Unique identifier for the certificate, prefixed with `tcrt_`. + Stable identifier for this rate-limit group within the organization. - - `archived_at: string | null` + - `group_type: "batch" | "files" | "model_group" | 3 more` - A timestamp in RFC 3339 format + The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. - format: date-time + - `"batch"` - - `created_at: string` + - `"files"` - A timestamp in RFC 3339 format + - `"model_group"` - format: date-time + - `"skills"` - - `expires_at: string | null` + - `"token_count"` - A timestamp in RFC 3339 format + - `"web_search"` - format: date-time + - `limits: Array` - - `fingerprint: string` + The limiter values that apply to this group. - Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. + - `type: string` - - `tunnel_id: string` + The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - ID of the tunnel the certificate is registered against. + - `value: number` - - `type: "tunnel_certificate"` + The configured limit value for this limiter type. + + - `models: Array | null` + + Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. + + - `type: "rate_limit"` + + Object type. Always `rate_limit` for organization rate-limit entries. + + default: rate_limit #### Example @@ -66698,24 +78987,32 @@ const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); -const betaTunnelCertificate = await client.beta.tunnels.certificates.archive( - "certificate_id", - { tunnel_id: "tunnel_id" } -); - -console.log(betaTunnelCertificate.id); +// Automatically fetches more pages as needed. +for await (const betaOrganizationRateLimit of client.beta.organization.rateLimits.list()) { + console.log(betaOrganizationRateLimit.id); +} ``` ##### Response (200) ```json { - "id": "id", - "archived_at": "2019-12-27T18:11:19.117Z", - "created_at": "2019-12-27T18:11:19.117Z", - "expires_at": "2019-12-27T18:11:19.117Z", - "fingerprint": "fingerprint", - "tunnel_id": "tunnel_id", - "type": "tunnel_certificate" + "data": [ + { + "id": "id", + "group_type": "batch", + "limits": [ + { + "type": "type", + "value": 0 + } + ], + "models": [ + "string" + ], + "type": "rate_limit" + } + ], + "next_page": "next_page" } ``` diff --git a/content/en/api/typescript/beta/agents.md b/content/en/api/typescript/beta/agents.md index 42f6ffe58..428ab6ef5 100644 --- a/content/en/api/typescript/beta/agents.md +++ b/content/en/api/typescript/beta/agents.md @@ -664,7 +664,7 @@ Create Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -734,6 +734,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsAgent` @@ -1398,7 +1412,7 @@ List Agents - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1468,6 +1482,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsAgent` @@ -2117,7 +2145,7 @@ Get Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2187,6 +2215,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsAgent` @@ -3478,7 +3520,7 @@ Update Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3548,6 +3590,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsAgent` @@ -4188,7 +4244,7 @@ Archive Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4258,6 +4314,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsAgent` @@ -8627,7 +8697,7 @@ List Agent Versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -8697,6 +8767,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsAgent` diff --git a/content/en/api/typescript/beta/agents/archive.md b/content/en/api/typescript/beta/agents/archive.md index fb664c8cf..3e94c0898 100644 --- a/content/en/api/typescript/beta/agents/archive.md +++ b/content/en/api/typescript/beta/agents/archive.md @@ -18,7 +18,7 @@ Archive Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsAgent` diff --git a/content/en/api/typescript/beta/agents/create.md b/content/en/api/typescript/beta/agents/create.md index 27fabf7c8..94a7ec62f 100644 --- a/content/en/api/typescript/beta/agents/create.md +++ b/content/en/api/typescript/beta/agents/create.md @@ -662,7 +662,7 @@ Create Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -732,6 +732,20 @@ Create Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsAgent` diff --git a/content/en/api/typescript/beta/agents/list.md b/content/en/api/typescript/beta/agents/list.md index 158874176..f138f33b5 100644 --- a/content/en/api/typescript/beta/agents/list.md +++ b/content/en/api/typescript/beta/agents/list.md @@ -42,7 +42,7 @@ List Agents - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -112,6 +112,20 @@ List Agents - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsAgent` diff --git a/content/en/api/typescript/beta/agents/retrieve.md b/content/en/api/typescript/beta/agents/retrieve.md index aac968423..e4ffb63ef 100644 --- a/content/en/api/typescript/beta/agents/retrieve.md +++ b/content/en/api/typescript/beta/agents/retrieve.md @@ -24,7 +24,7 @@ Get Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Get Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsAgent` diff --git a/content/en/api/typescript/beta/agents/update.md b/content/en/api/typescript/beta/agents/update.md index f6353bcdc..ad08b9622 100644 --- a/content/en/api/typescript/beta/agents/update.md +++ b/content/en/api/typescript/beta/agents/update.md @@ -670,7 +670,7 @@ Update Agent - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -740,6 +740,20 @@ Update Agent - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsAgent` diff --git a/content/en/api/typescript/beta/agents/versions.md b/content/en/api/typescript/beta/agents/versions.md index 7c1625cce..384589ce7 100644 --- a/content/en/api/typescript/beta/agents/versions.md +++ b/content/en/api/typescript/beta/agents/versions.md @@ -30,7 +30,7 @@ List Agent Versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsAgent` diff --git a/content/en/api/typescript/beta/agents/versions/list.md b/content/en/api/typescript/beta/agents/versions/list.md index 460491678..acf894440 100644 --- a/content/en/api/typescript/beta/agents/versions/list.md +++ b/content/en/api/typescript/beta/agents/versions/list.md @@ -28,7 +28,7 @@ List Agent Versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Agent Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsAgent` diff --git a/content/en/api/typescript/beta/deployment_runs.md b/content/en/api/typescript/beta/deployment_runs.md index 232672ba8..ca543f87d 100644 --- a/content/en/api/typescript/beta/deployment_runs.md +++ b/content/en/api/typescript/beta/deployment_runs.md @@ -68,7 +68,7 @@ List Deployment Runs - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -138,6 +138,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeploymentRun` @@ -427,7 +441,7 @@ Get Deployment Run - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -497,6 +511,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/typescript/beta/deployment_runs/list.md b/content/en/api/typescript/beta/deployment_runs/list.md index 9c1d7bf2e..741aea839 100644 --- a/content/en/api/typescript/beta/deployment_runs/list.md +++ b/content/en/api/typescript/beta/deployment_runs/list.md @@ -66,7 +66,7 @@ List Deployment Runs - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -136,6 +136,20 @@ List Deployment Runs - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/typescript/beta/deployment_runs/retrieve.md b/content/en/api/typescript/beta/deployment_runs/retrieve.md index f8538cf33..6e60ed6ff 100644 --- a/content/en/api/typescript/beta/deployment_runs/retrieve.md +++ b/content/en/api/typescript/beta/deployment_runs/retrieve.md @@ -18,7 +18,7 @@ Get Deployment Run - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Deployment Run - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/typescript/beta/deployments.md b/content/en/api/typescript/beta/deployments.md index 3b019fe09..dd3a14dfc 100644 --- a/content/en/api/typescript/beta/deployments.md +++ b/content/en/api/typescript/beta/deployments.md @@ -418,7 +418,7 @@ Create Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -488,6 +488,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment` @@ -1148,7 +1162,7 @@ List Deployments - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1218,6 +1232,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment` @@ -1841,7 +1869,7 @@ Get Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1911,6 +1939,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment` @@ -2930,7 +2972,7 @@ Update Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3000,6 +3042,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment` @@ -3619,7 +3675,7 @@ Archive Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3689,6 +3745,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment` @@ -4308,7 +4378,7 @@ Run Deployment Now - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4378,6 +4448,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeploymentRun` @@ -4663,7 +4747,7 @@ Pause Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4733,6 +4817,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment` @@ -5352,7 +5450,7 @@ Unpause Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -5422,6 +5520,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeployment` diff --git a/content/en/api/typescript/beta/deployments/archive.md b/content/en/api/typescript/beta/deployments/archive.md index b7b2710ef..b7d7fcb38 100644 --- a/content/en/api/typescript/beta/deployments/archive.md +++ b/content/en/api/typescript/beta/deployments/archive.md @@ -18,7 +18,7 @@ Archive Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment` diff --git a/content/en/api/typescript/beta/deployments/create.md b/content/en/api/typescript/beta/deployments/create.md index bd930dd67..0ebd66f34 100644 --- a/content/en/api/typescript/beta/deployments/create.md +++ b/content/en/api/typescript/beta/deployments/create.md @@ -416,7 +416,7 @@ Create Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -486,6 +486,20 @@ Create Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment` diff --git a/content/en/api/typescript/beta/deployments/list.md b/content/en/api/typescript/beta/deployments/list.md index dbd22cb80..1046db3a7 100644 --- a/content/en/api/typescript/beta/deployments/list.md +++ b/content/en/api/typescript/beta/deployments/list.md @@ -54,7 +54,7 @@ List Deployments - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -124,6 +124,20 @@ List Deployments - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment` diff --git a/content/en/api/typescript/beta/deployments/pause.md b/content/en/api/typescript/beta/deployments/pause.md index 8d750c3b4..36d054cfb 100644 --- a/content/en/api/typescript/beta/deployments/pause.md +++ b/content/en/api/typescript/beta/deployments/pause.md @@ -18,7 +18,7 @@ Pause Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Pause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment` diff --git a/content/en/api/typescript/beta/deployments/retrieve.md b/content/en/api/typescript/beta/deployments/retrieve.md index aa1b44780..bc5909203 100644 --- a/content/en/api/typescript/beta/deployments/retrieve.md +++ b/content/en/api/typescript/beta/deployments/retrieve.md @@ -18,7 +18,7 @@ Get Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment` diff --git a/content/en/api/typescript/beta/deployments/run.md b/content/en/api/typescript/beta/deployments/run.md index e9052f524..db2b238f7 100644 --- a/content/en/api/typescript/beta/deployments/run.md +++ b/content/en/api/typescript/beta/deployments/run.md @@ -18,7 +18,7 @@ Run Deployment Now - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Run Deployment Now - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeploymentRun` diff --git a/content/en/api/typescript/beta/deployments/unpause.md b/content/en/api/typescript/beta/deployments/unpause.md index 6cb9eb1a0..216225036 100644 --- a/content/en/api/typescript/beta/deployments/unpause.md +++ b/content/en/api/typescript/beta/deployments/unpause.md @@ -18,7 +18,7 @@ Unpause Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Unpause Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment` diff --git a/content/en/api/typescript/beta/deployments/update.md b/content/en/api/typescript/beta/deployments/update.md index 23beb88c5..5c239e57c 100644 --- a/content/en/api/typescript/beta/deployments/update.md +++ b/content/en/api/typescript/beta/deployments/update.md @@ -418,7 +418,7 @@ Update Deployment - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -488,6 +488,20 @@ Update Deployment - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeployment` diff --git a/content/en/api/typescript/beta/environments.md b/content/en/api/typescript/beta/environments.md index 4f2ecc249..d8bd3362e 100644 --- a/content/en/api/typescript/beta/environments.md +++ b/content/en/api/typescript/beta/environments.md @@ -62,7 +62,7 @@ Create a new environment with the specified configuration. - `allow_package_managers?: boolean | null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts?: Array | null` @@ -74,6 +74,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt?: Array | null` Ubuntu/Debian packages to install @@ -136,7 +138,7 @@ Create a new environment with the specified configuration. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -206,6 +208,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironment` @@ -437,7 +453,7 @@ List environments with pagination support. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -507,6 +523,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironment` @@ -730,7 +760,7 @@ Retrieve a specific environment by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -800,6 +830,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironment` @@ -1057,7 +1101,7 @@ Update an existing environment's configuration. - `allow_package_managers?: boolean | null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts?: Array | null` @@ -1069,6 +1113,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt?: Array | null` Ubuntu/Debian packages to install @@ -1137,7 +1183,7 @@ Update an existing environment's configuration. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1207,6 +1253,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironment` @@ -1424,7 +1484,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1494,6 +1554,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironmentDeleteResponse` @@ -1555,7 +1629,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1625,6 +1699,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaEnvironment` @@ -1942,7 +2030,7 @@ console.log(betaEnvironment.id); - `allow_package_managers?: boolean | null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts?: Array | null` @@ -1954,6 +2042,8 @@ console.log(betaEnvironment.id); When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt?: Array | null` Ubuntu/Debian packages to install @@ -2175,7 +2265,7 @@ console.log(betaEnvironment.id); - `allow_package_managers?: boolean | null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts?: Array | null` @@ -2225,6 +2315,8 @@ console.log(betaEnvironment.id); When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt?: Array | null` Ubuntu/Debian packages to install @@ -2313,7 +2405,7 @@ Retrieve detailed information about a specific work item. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2383,6 +2475,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -2540,7 +2646,7 @@ Long poll for work items in the queue. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2610,6 +2716,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"Anthropic-Worker-ID"?: string` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -2757,7 +2877,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2827,6 +2947,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -2984,7 +3118,7 @@ Record a heartbeat for a work item to maintain the lease. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3054,6 +3188,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkHeartbeatResponse` @@ -3151,7 +3299,7 @@ Stop a work item, initiating graceful or forced shutdown. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3221,6 +3369,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -3376,7 +3538,7 @@ List work items in an environment. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3446,6 +3608,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -3605,7 +3781,7 @@ Update work item metadata with merge semantics. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3675,6 +3851,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWork` @@ -3819,7 +4009,7 @@ Get statistics about the work queue for an environment. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3889,6 +4079,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaSelfHostedWorkQueueStats` diff --git a/content/en/api/typescript/beta/environments/archive.md b/content/en/api/typescript/beta/environments/archive.md index db865808a..15c3ce90d 100644 --- a/content/en/api/typescript/beta/environments/archive.md +++ b/content/en/api/typescript/beta/environments/archive.md @@ -18,7 +18,7 @@ Archive an environment by ID. Archived environments cannot be used to create new - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive an environment by ID. Archived environments cannot be used to create new - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironment` diff --git a/content/en/api/typescript/beta/environments/create.md b/content/en/api/typescript/beta/environments/create.md index e7a06f9f1..c66e3d835 100644 --- a/content/en/api/typescript/beta/environments/create.md +++ b/content/en/api/typescript/beta/environments/create.md @@ -60,7 +60,7 @@ Create a new environment with the specified configuration. - `allow_package_managers?: boolean | null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts?: Array | null` @@ -72,6 +72,8 @@ Create a new environment with the specified configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt?: Array | null` Ubuntu/Debian packages to install @@ -134,7 +136,7 @@ Create a new environment with the specified configuration. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -204,6 +206,20 @@ Create a new environment with the specified configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironment` diff --git a/content/en/api/typescript/beta/environments/delete.md b/content/en/api/typescript/beta/environments/delete.md index d8dc1073c..3d0cab5e8 100644 --- a/content/en/api/typescript/beta/environments/delete.md +++ b/content/en/api/typescript/beta/environments/delete.md @@ -18,7 +18,7 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete an environment by ID. Returns a confirmation of the deletion. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironmentDeleteResponse` diff --git a/content/en/api/typescript/beta/environments/list.md b/content/en/api/typescript/beta/environments/list.md index c8317cee4..b2c519c21 100644 --- a/content/en/api/typescript/beta/environments/list.md +++ b/content/en/api/typescript/beta/environments/list.md @@ -30,7 +30,7 @@ List environments with pagination support. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List environments with pagination support. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironment` diff --git a/content/en/api/typescript/beta/environments/retrieve.md b/content/en/api/typescript/beta/environments/retrieve.md index 08062e54c..dd43ebe85 100644 --- a/content/en/api/typescript/beta/environments/retrieve.md +++ b/content/en/api/typescript/beta/environments/retrieve.md @@ -18,7 +18,7 @@ Retrieve a specific environment by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Retrieve a specific environment by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironment` diff --git a/content/en/api/typescript/beta/environments/update.md b/content/en/api/typescript/beta/environments/update.md index 914e2b968..09dc0c9db 100644 --- a/content/en/api/typescript/beta/environments/update.md +++ b/content/en/api/typescript/beta/environments/update.md @@ -56,7 +56,7 @@ Update an existing environment's configuration. - `allow_package_managers?: boolean | null` - Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts?: Array | null` @@ -68,6 +68,8 @@ Update an existing environment's configuration. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. + - `apt?: Array | null` Ubuntu/Debian packages to install @@ -136,7 +138,7 @@ Update an existing environment's configuration. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -206,6 +208,20 @@ Update an existing environment's configuration. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaEnvironment` diff --git a/content/en/api/typescript/beta/environments/work.md b/content/en/api/typescript/beta/environments/work.md index f6ae3bcdb..7900f0891 100644 --- a/content/en/api/typescript/beta/environments/work.md +++ b/content/en/api/typescript/beta/environments/work.md @@ -26,7 +26,7 @@ Retrieve detailed information about a specific work item. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWork` @@ -253,7 +267,7 @@ Long poll for work items in the queue. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -323,6 +337,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"Anthropic-Worker-ID"?: string` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console @@ -470,7 +498,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -540,6 +568,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWork` @@ -697,7 +739,7 @@ Record a heartbeat for a work item to maintain the lease. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -767,6 +809,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWorkHeartbeatResponse` @@ -864,7 +920,7 @@ Stop a work item, initiating graceful or forced shutdown. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -934,6 +990,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWork` @@ -1089,7 +1159,7 @@ List work items in an environment. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1159,6 +1229,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWork` @@ -1318,7 +1402,7 @@ Update work item metadata with merge semantics. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1388,6 +1472,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWork` @@ -1532,7 +1630,7 @@ Get statistics about the work queue for an environment. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1602,6 +1700,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaSelfHostedWorkQueueStats` diff --git a/content/en/api/typescript/beta/environments/work/ack.md b/content/en/api/typescript/beta/environments/work/ack.md index 673ee92ac..b810db622 100644 --- a/content/en/api/typescript/beta/environments/work/ack.md +++ b/content/en/api/typescript/beta/environments/work/ack.md @@ -24,7 +24,7 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWork` diff --git a/content/en/api/typescript/beta/environments/work/heartbeat.md b/content/en/api/typescript/beta/environments/work/heartbeat.md index f22d6a205..0670f7f3a 100644 --- a/content/en/api/typescript/beta/environments/work/heartbeat.md +++ b/content/en/api/typescript/beta/environments/work/heartbeat.md @@ -32,7 +32,7 @@ Record a heartbeat for a work item to maintain the lease. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Record a heartbeat for a work item to maintain the lease. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWorkHeartbeatResponse` diff --git a/content/en/api/typescript/beta/environments/work/list.md b/content/en/api/typescript/beta/environments/work/list.md index cde83bc5c..435406631 100644 --- a/content/en/api/typescript/beta/environments/work/list.md +++ b/content/en/api/typescript/beta/environments/work/list.md @@ -30,7 +30,7 @@ List work items in an environment. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List work items in an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWork` diff --git a/content/en/api/typescript/beta/environments/work/poll.md b/content/en/api/typescript/beta/environments/work/poll.md index 09170aa92..e576b51dc 100644 --- a/content/en/api/typescript/beta/environments/work/poll.md +++ b/content/en/api/typescript/beta/environments/work/poll.md @@ -32,7 +32,7 @@ Long poll for work items in the queue. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Long poll for work items in the queue. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `"Anthropic-Worker-ID"?: string` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console diff --git a/content/en/api/typescript/beta/environments/work/retrieve.md b/content/en/api/typescript/beta/environments/work/retrieve.md index c36b51f0a..8c2cfa0dc 100644 --- a/content/en/api/typescript/beta/environments/work/retrieve.md +++ b/content/en/api/typescript/beta/environments/work/retrieve.md @@ -24,7 +24,7 @@ Retrieve detailed information about a specific work item. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Retrieve detailed information about a specific work item. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWork` diff --git a/content/en/api/typescript/beta/environments/work/stats.md b/content/en/api/typescript/beta/environments/work/stats.md index 04c2efc94..9e14703a9 100644 --- a/content/en/api/typescript/beta/environments/work/stats.md +++ b/content/en/api/typescript/beta/environments/work/stats.md @@ -18,7 +18,7 @@ Get statistics about the work queue for an environment. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get statistics about the work queue for an environment. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWorkQueueStats` diff --git a/content/en/api/typescript/beta/environments/work/stop.md b/content/en/api/typescript/beta/environments/work/stop.md index dfa047feb..78c19d348 100644 --- a/content/en/api/typescript/beta/environments/work/stop.md +++ b/content/en/api/typescript/beta/environments/work/stop.md @@ -28,7 +28,7 @@ Stop a work item, initiating graceful or forced shutdown. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Stop a work item, initiating graceful or forced shutdown. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWork` diff --git a/content/en/api/typescript/beta/environments/work/update.md b/content/en/api/typescript/beta/environments/work/update.md index 42d3eb289..39daa72e5 100644 --- a/content/en/api/typescript/beta/environments/work/update.md +++ b/content/en/api/typescript/beta/environments/work/update.md @@ -28,7 +28,7 @@ Update work item metadata with merge semantics. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Update work item metadata with merge semantics. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaSelfHostedWork` diff --git a/content/en/api/typescript/beta/files.md b/content/en/api/typescript/beta/files.md index e2d8aca05..783bf5466 100644 --- a/content/en/api/typescript/beta/files.md +++ b/content/en/api/typescript/beta/files.md @@ -24,7 +24,7 @@ Upload File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaFileMetadata` @@ -225,7 +239,7 @@ List Files - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -295,6 +309,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaFileMetadata` @@ -415,7 +443,7 @@ Download File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -485,6 +513,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `unnamed_schema_1 = Response` @@ -528,7 +570,7 @@ Get File Metadata - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -598,6 +640,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaFileMetadata` @@ -710,7 +766,7 @@ Delete File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -780,6 +836,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaDeletedFile` diff --git a/content/en/api/typescript/beta/files/delete.md b/content/en/api/typescript/beta/files/delete.md index 54d27a1b2..5fc277078 100644 --- a/content/en/api/typescript/beta/files/delete.md +++ b/content/en/api/typescript/beta/files/delete.md @@ -20,7 +20,7 @@ Delete File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Delete File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaDeletedFile` diff --git a/content/en/api/typescript/beta/files/download.md b/content/en/api/typescript/beta/files/download.md index df1f94c4d..045f16698 100644 --- a/content/en/api/typescript/beta/files/download.md +++ b/content/en/api/typescript/beta/files/download.md @@ -20,7 +20,7 @@ Download File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Download File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `unnamed_schema_1 = Response` diff --git a/content/en/api/typescript/beta/files/list.md b/content/en/api/typescript/beta/files/list.md index 5fe730f7d..6044a384b 100644 --- a/content/en/api/typescript/beta/files/list.md +++ b/content/en/api/typescript/beta/files/list.md @@ -36,7 +36,7 @@ List Files - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -106,6 +106,20 @@ List Files - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaFileMetadata` diff --git a/content/en/api/typescript/beta/files/retrieve_metadata.md b/content/en/api/typescript/beta/files/retrieve_metadata.md index e89d28f35..1a23dcbb8 100644 --- a/content/en/api/typescript/beta/files/retrieve_metadata.md +++ b/content/en/api/typescript/beta/files/retrieve_metadata.md @@ -20,7 +20,7 @@ Get File Metadata - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Get File Metadata - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaFileMetadata` diff --git a/content/en/api/typescript/beta/files/upload.md b/content/en/api/typescript/beta/files/upload.md index b49f610cb..da7fa1154 100644 --- a/content/en/api/typescript/beta/files/upload.md +++ b/content/en/api/typescript/beta/files/upload.md @@ -22,7 +22,7 @@ Upload File - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Upload File - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaFileMetadata` diff --git a/content/en/api/typescript/beta/memory_stores.md b/content/en/api/typescript/beta/memory_stores.md index 3aee609ef..213e7f7e6 100644 --- a/content/en/api/typescript/beta/memory_stores.md +++ b/content/en/api/typescript/beta/memory_stores.md @@ -34,7 +34,7 @@ Create a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryStore` @@ -221,7 +235,7 @@ List memory stores - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -291,6 +305,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryStore` @@ -390,7 +418,7 @@ Retrieve a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -460,6 +488,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryStore` @@ -571,7 +613,7 @@ Update a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -641,6 +683,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryStore` @@ -734,7 +790,7 @@ Delete a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -804,6 +860,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedMemoryStore` @@ -861,7 +931,7 @@ Archive a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -931,6 +1001,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryStore` @@ -1100,7 +1184,7 @@ Create a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1170,6 +1254,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemory` @@ -1202,7 +1300,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1302,7 +1400,7 @@ List memories - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1372,6 +1470,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryListItem = BetaManagedAgentsMemory | BetaManagedAgentsMemoryPrefix` @@ -1408,7 +1520,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1507,7 +1619,7 @@ Retrieve a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1577,6 +1689,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemory` @@ -1609,7 +1735,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1712,7 +1838,7 @@ Update a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1782,6 +1908,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemory` @@ -1814,7 +1954,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1893,7 +2033,7 @@ Delete a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1963,11 +2103,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -2079,7 +2233,7 @@ List memory versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2149,11 +2303,25 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -2167,7 +2335,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -2345,7 +2513,7 @@ Retrieve a memory version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2415,11 +2583,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -2433,7 +2615,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -2598,7 +2780,7 @@ Redact a memory version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2668,11 +2850,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -2686,7 +2882,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/typescript/beta/memory_stores/archive.md b/content/en/api/typescript/beta/memory_stores/archive.md index 603af6430..89320219b 100644 --- a/content/en/api/typescript/beta/memory_stores/archive.md +++ b/content/en/api/typescript/beta/memory_stores/archive.md @@ -18,7 +18,7 @@ Archive a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryStore` diff --git a/content/en/api/typescript/beta/memory_stores/create.md b/content/en/api/typescript/beta/memory_stores/create.md index c569d71b3..78020c422 100644 --- a/content/en/api/typescript/beta/memory_stores/create.md +++ b/content/en/api/typescript/beta/memory_stores/create.md @@ -32,7 +32,7 @@ Create a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Create a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryStore` diff --git a/content/en/api/typescript/beta/memory_stores/delete.md b/content/en/api/typescript/beta/memory_stores/delete.md index d056e1636..d6cee31be 100644 --- a/content/en/api/typescript/beta/memory_stores/delete.md +++ b/content/en/api/typescript/beta/memory_stores/delete.md @@ -18,7 +18,7 @@ Delete a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedMemoryStore` diff --git a/content/en/api/typescript/beta/memory_stores/list.md b/content/en/api/typescript/beta/memory_stores/list.md index b0f04f6b9..eeecd6fd1 100644 --- a/content/en/api/typescript/beta/memory_stores/list.md +++ b/content/en/api/typescript/beta/memory_stores/list.md @@ -42,7 +42,7 @@ List memory stores - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -112,6 +112,20 @@ List memory stores - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryStore` diff --git a/content/en/api/typescript/beta/memory_stores/memories.md b/content/en/api/typescript/beta/memory_stores/memories.md index f8c6406c6..2a9673238 100644 --- a/content/en/api/typescript/beta/memory_stores/memories.md +++ b/content/en/api/typescript/beta/memory_stores/memories.md @@ -38,7 +38,7 @@ Create a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -108,6 +108,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemory` @@ -140,7 +154,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -240,7 +254,7 @@ List memories - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -310,6 +324,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryListItem = BetaManagedAgentsMemory | BetaManagedAgentsMemoryPrefix` @@ -346,7 +374,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -445,7 +473,7 @@ Retrieve a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -515,6 +543,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemory` @@ -547,7 +589,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -650,7 +692,7 @@ Update a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -720,6 +762,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemory` @@ -752,7 +808,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -831,7 +887,7 @@ Delete a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -901,11 +957,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -965,7 +1035,7 @@ console.log(betaManagedAgentsDeletedMemory.id); - `BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` @@ -1121,7 +1191,7 @@ console.log(betaManagedAgentsDeletedMemory.id); - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` @@ -1175,7 +1245,7 @@ console.log(betaManagedAgentsDeletedMemory.id); - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/typescript/beta/memory_stores/memories/create.md b/content/en/api/typescript/beta/memory_stores/memories/create.md index f989f2b7a..343a1aacc 100644 --- a/content/en/api/typescript/beta/memory_stores/memories/create.md +++ b/content/en/api/typescript/beta/memory_stores/memories/create.md @@ -36,7 +36,7 @@ Create a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -106,6 +106,20 @@ Create a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemory` @@ -138,7 +152,7 @@ Create a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/typescript/beta/memory_stores/memories/delete.md b/content/en/api/typescript/beta/memory_stores/memories/delete.md index f2b9f4e14..034653813 100644 --- a/content/en/api/typescript/beta/memory_stores/memories/delete.md +++ b/content/en/api/typescript/beta/memory_stores/memories/delete.md @@ -26,7 +26,7 @@ Delete a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -96,11 +96,25 @@ Delete a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedMemory` - Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `id: string` diff --git a/content/en/api/typescript/beta/memory_stores/memories/list.md b/content/en/api/typescript/beta/memory_stores/memories/list.md index 904c92e72..9bf21e3fb 100644 --- a/content/en/api/typescript/beta/memory_stores/memories/list.md +++ b/content/en/api/typescript/beta/memory_stores/memories/list.md @@ -46,7 +46,7 @@ List memories - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -116,6 +116,20 @@ List memories - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryListItem = BetaManagedAgentsMemory | BetaManagedAgentsMemoryPrefix` @@ -152,7 +166,7 @@ List memories - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/typescript/beta/memory_stores/memories/retrieve.md b/content/en/api/typescript/beta/memory_stores/memories/retrieve.md index f935229fe..fd3f55a7e 100644 --- a/content/en/api/typescript/beta/memory_stores/memories/retrieve.md +++ b/content/en/api/typescript/beta/memory_stores/memories/retrieve.md @@ -30,7 +30,7 @@ Retrieve a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Retrieve a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemory` @@ -132,7 +146,7 @@ Retrieve a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/typescript/beta/memory_stores/memories/update.md b/content/en/api/typescript/beta/memory_stores/memories/update.md index 13aa3258c..406dd1412 100644 --- a/content/en/api/typescript/beta/memory_stores/memories/update.md +++ b/content/en/api/typescript/beta/memory_stores/memories/update.md @@ -50,7 +50,7 @@ Update a memory - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -120,6 +120,20 @@ Update a memory - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemory` @@ -152,7 +166,7 @@ Update a memory - `memory_version_id: string` - ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). + ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` diff --git a/content/en/api/typescript/beta/memory_stores/memory_versions.md b/content/en/api/typescript/beta/memory_stores/memory_versions.md index a76343459..a8ddd787d 100644 --- a/content/en/api/typescript/beta/memory_stores/memory_versions.md +++ b/content/en/api/typescript/beta/memory_stores/memory_versions.md @@ -76,7 +76,7 @@ List memory versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -146,11 +146,25 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -164,7 +178,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -342,7 +356,7 @@ Retrieve a memory version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -412,11 +426,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -430,7 +458,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -595,7 +623,7 @@ Redact a memory version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -665,11 +693,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -683,7 +725,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` @@ -898,7 +940,7 @@ console.log(betaManagedAgentsMemoryVersion.id); - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -912,7 +954,7 @@ console.log(betaManagedAgentsMemoryVersion.id); - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/typescript/beta/memory_stores/memory_versions/list.md b/content/en/api/typescript/beta/memory_stores/memory_versions/list.md index 2d8343bd9..bcc60083c 100644 --- a/content/en/api/typescript/beta/memory_stores/memory_versions/list.md +++ b/content/en/api/typescript/beta/memory_stores/memory_versions/list.md @@ -74,7 +74,7 @@ List memory versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -144,11 +144,25 @@ List memory versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -162,7 +176,7 @@ List memory versions - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/typescript/beta/memory_stores/memory_versions/redact.md b/content/en/api/typescript/beta/memory_stores/memory_versions/redact.md index 93e0a643d..093b8f46b 100644 --- a/content/en/api/typescript/beta/memory_stores/memory_versions/redact.md +++ b/content/en/api/typescript/beta/memory_stores/memory_versions/redact.md @@ -22,7 +22,7 @@ Redact a memory version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,11 +92,25 @@ Redact a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -110,7 +124,7 @@ Redact a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/typescript/beta/memory_stores/memory_versions/retrieve.md b/content/en/api/typescript/beta/memory_stores/memory_versions/retrieve.md index 022e3a3c7..16e174d17 100644 --- a/content/en/api/typescript/beta/memory_stores/memory_versions/retrieve.md +++ b/content/en/api/typescript/beta/memory_stores/memory_versions/retrieve.md @@ -30,7 +30,7 @@ Retrieve a memory version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,11 +100,25 @@ Retrieve a memory version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryVersion` - A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. + A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` @@ -118,7 +132,7 @@ Retrieve a memory version - `memory_id: string` - ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` diff --git a/content/en/api/typescript/beta/memory_stores/retrieve.md b/content/en/api/typescript/beta/memory_stores/retrieve.md index 5504cb168..598ab512f 100644 --- a/content/en/api/typescript/beta/memory_stores/retrieve.md +++ b/content/en/api/typescript/beta/memory_stores/retrieve.md @@ -18,7 +18,7 @@ Retrieve a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Retrieve a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryStore` diff --git a/content/en/api/typescript/beta/memory_stores/update.md b/content/en/api/typescript/beta/memory_stores/update.md index 7595dcef9..8256ecdc3 100644 --- a/content/en/api/typescript/beta/memory_stores/update.md +++ b/content/en/api/typescript/beta/memory_stores/update.md @@ -34,7 +34,7 @@ Update a memory store - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ Update a memory store - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsMemoryStore` diff --git a/content/en/api/typescript/beta/messages.md b/content/en/api/typescript/beta/messages.md index 53bc5416e..6e5c2b231 100644 --- a/content/en/api/typescript/beta/messages.md +++ b/content/en/api/typescript/beta/messages.md @@ -1690,7 +1690,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1698,6 +1698,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -1706,7 +1708,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1714,6 +1716,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `"default"` - `"default"` @@ -3771,7 +3775,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3841,6 +3845,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5318,12 +5336,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -5633,12 +5653,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: number` The cumulative number of output tokens which were used. @@ -7549,7 +7571,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -7557,6 +7579,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -7565,7 +7589,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -7573,6 +7597,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice?: BetaToolChoice` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -9518,7 +9544,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -9588,6 +9614,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -18091,7 +18131,7 @@ console.log(betaMessageTokensCount.context_management); - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18099,6 +18139,8 @@ console.log(betaMessageTokensCount.context_management); - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -18107,7 +18149,7 @@ console.log(betaMessageTokensCount.context_management); - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18115,6 +18157,8 @@ console.log(betaMessageTokensCount.context_management); - `"omitted"` + - `"updates"` + ### Beta Fallback Refusal Trigger - `BetaFallbackRefusalTrigger` @@ -18299,7 +18343,7 @@ console.log(betaMessageTokensCount.context_management); - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18307,6 +18351,8 @@ console.log(betaMessageTokensCount.context_management); - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -18315,7 +18361,7 @@ console.log(betaMessageTokensCount.context_management); - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -18323,6 +18369,8 @@ console.log(betaMessageTokensCount.context_management); - `"omitted"` + - `"updates"` + - `"default"` - `"default"` @@ -18464,12 +18512,14 @@ console.log(betaMessageTokensCount.context_management); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -20720,12 +20770,14 @@ console.log(betaMessageTokensCount.context_management); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -21061,12 +21113,14 @@ console.log(betaMessageTokensCount.context_management); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -24571,12 +24625,14 @@ console.log(betaMessageTokensCount.context_management); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -26285,12 +26341,14 @@ console.log(betaMessageTokensCount.context_management); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -27957,12 +28015,14 @@ console.log(betaMessageTokensCount.context_management); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -28266,12 +28326,14 @@ console.log(betaMessageTokensCount.context_management); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: number` The cumulative number of output tokens which were used. @@ -30520,7 +30582,7 @@ console.log(betaMessageTokensCount.context_management); - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30528,6 +30590,8 @@ console.log(betaMessageTokensCount.context_management); - `"omitted"` + - `"updates"` + ### Beta Thinking Config Disabled - `BetaThinkingConfigDisabled` @@ -30550,7 +30614,7 @@ console.log(betaMessageTokensCount.context_management); - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30558,6 +30622,8 @@ console.log(betaMessageTokensCount.context_management); - `"omitted"` + - `"updates"` + ### Beta Thinking Config Param - `BetaThinkingConfigParam = BetaThinkingConfigEnabled | BetaThinkingConfigDisabled | BetaThinkingConfigAdaptive` @@ -30582,7 +30648,7 @@ console.log(betaMessageTokensCount.context_management); - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30590,6 +30656,8 @@ console.log(betaMessageTokensCount.context_management); - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -30598,7 +30666,7 @@ console.log(betaMessageTokensCount.context_management); - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -30606,6 +30674,8 @@ console.log(betaMessageTokensCount.context_management); - `"omitted"` + - `"updates"` + ### Beta Thinking Delta - `BetaThinkingDelta` @@ -34448,12 +34518,14 @@ console.log(betaMessageTokensCount.context_management); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -38315,7 +38387,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -38323,6 +38395,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -38331,7 +38405,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -38339,6 +38413,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `"default"` - `"default"` @@ -40440,7 +40516,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -40510,6 +40586,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -40696,7 +40786,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -40766,6 +40856,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch` @@ -40949,7 +41053,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -41019,6 +41123,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch` @@ -41200,7 +41318,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -41270,6 +41388,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatch` @@ -41443,7 +41575,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -41513,6 +41645,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaDeletedMessageBatch` @@ -41578,7 +41724,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -41648,6 +41794,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaMessageBatchIndividualResponse` @@ -43079,12 +43239,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. diff --git a/content/en/api/typescript/beta/messages/batches.md b/content/en/api/typescript/beta/messages/batches.md index f9734aa2c..d189ec519 100644 --- a/content/en/api/typescript/beta/messages/batches.md +++ b/content/en/api/typescript/beta/messages/batches.md @@ -1708,7 +1708,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1716,6 +1716,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -1724,7 +1726,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1732,6 +1734,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `"default"` - `"default"` @@ -3833,7 +3837,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3903,6 +3907,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. @@ -4089,7 +4107,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4159,6 +4177,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaMessageBatch` @@ -4342,7 +4374,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4412,6 +4444,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaMessageBatch` @@ -4593,7 +4639,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4663,6 +4709,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaMessageBatch` @@ -4836,7 +4896,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4906,6 +4966,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaDeletedMessageBatch` @@ -4971,7 +5045,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -5041,6 +5115,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaMessageBatchIndividualResponse` @@ -6472,12 +6560,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -8536,12 +8626,14 @@ console.log(betaMessageBatchIndividualResponse.custom_id); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -10364,12 +10456,14 @@ console.log(betaMessageBatchIndividualResponse.custom_id); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -12144,12 +12238,14 @@ console.log(betaMessageBatchIndividualResponse.custom_id); Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. diff --git a/content/en/api/typescript/beta/messages/batches/cancel.md b/content/en/api/typescript/beta/messages/batches/cancel.md index 92cde3410..cda049683 100644 --- a/content/en/api/typescript/beta/messages/batches/cancel.md +++ b/content/en/api/typescript/beta/messages/batches/cancel.md @@ -24,7 +24,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaMessageBatch` diff --git a/content/en/api/typescript/beta/messages/batches/create.md b/content/en/api/typescript/beta/messages/batches/create.md index 8453789ea..8e26a923c 100644 --- a/content/en/api/typescript/beta/messages/batches/create.md +++ b/content/en/api/typescript/beta/messages/batches/create.md @@ -1706,7 +1706,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1714,6 +1714,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -1722,7 +1724,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1730,6 +1732,8 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"omitted"` + - `"updates"` + - `"default"` - `"default"` @@ -3831,7 +3835,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3901,6 +3905,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. diff --git a/content/en/api/typescript/beta/messages/batches/delete.md b/content/en/api/typescript/beta/messages/batches/delete.md index c397d2155..37c50fed5 100644 --- a/content/en/api/typescript/beta/messages/batches/delete.md +++ b/content/en/api/typescript/beta/messages/batches/delete.md @@ -24,7 +24,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaDeletedMessageBatch` diff --git a/content/en/api/typescript/beta/messages/batches/list.md b/content/en/api/typescript/beta/messages/batches/list.md index 1023d6962..2da3d6967 100644 --- a/content/en/api/typescript/beta/messages/batches/list.md +++ b/content/en/api/typescript/beta/messages/batches/list.md @@ -34,7 +34,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaMessageBatch` diff --git a/content/en/api/typescript/beta/messages/batches/results.md b/content/en/api/typescript/beta/messages/batches/results.md index b8e312a9e..9ca40b35d 100644 --- a/content/en/api/typescript/beta/messages/batches/results.md +++ b/content/en/api/typescript/beta/messages/batches/results.md @@ -24,7 +24,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaMessageBatchIndividualResponse` @@ -1525,12 +1539,14 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. diff --git a/content/en/api/typescript/beta/messages/batches/retrieve.md b/content/en/api/typescript/beta/messages/batches/retrieve.md index 1dd777dd8..a4a9c7410 100644 --- a/content/en/api/typescript/beta/messages/batches/retrieve.md +++ b/content/en/api/typescript/beta/messages/batches/retrieve.md @@ -22,7 +22,7 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Learn more about the Message Batches API in our [user guide](https://platform.cl - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaMessageBatch` diff --git a/content/en/api/typescript/beta/messages/count_tokens.md b/content/en/api/typescript/beta/messages/count_tokens.md index f79ad0c15..7801977e4 100644 --- a/content/en/api/typescript/beta/messages/count_tokens.md +++ b/content/en/api/typescript/beta/messages/count_tokens.md @@ -1610,7 +1610,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1618,6 +1618,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -1626,7 +1628,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1634,6 +1636,8 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"omitted"` + - `"updates"` + - `tool_choice?: BetaToolChoice` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. @@ -3579,7 +3583,7 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3649,6 +3653,20 @@ Learn more about token counting in our [user guide](https://platform.claude.com/ - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. diff --git a/content/en/api/typescript/beta/messages/create.md b/content/en/api/typescript/beta/messages/create.md index b899c8b41..c93ef2277 100644 --- a/content/en/api/typescript/beta/messages/create.md +++ b/content/en/api/typescript/beta/messages/create.md @@ -1688,7 +1688,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "enabled"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1696,6 +1696,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `BetaThinkingConfigDisabled` - `type: "disabled"` @@ -1704,7 +1706,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `type: "adaptive"` - - `display?: "summarized" | "omitted" | null` + - `display?: "summarized" | "omitted" | "updates" | null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. @@ -1712,6 +1714,8 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"omitted"` + - `"updates"` + - `"default"` - `"default"` @@ -3769,7 +3773,7 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3839,6 +3843,20 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `user_profile_id?: string` Header param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. @@ -5316,12 +5334,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `BetaMessageIterationUsage` Token usage for a sampling iteration. @@ -5631,12 +5651,14 @@ Learn more about the Messages API in our [user guide](https://platform.claude.co Per-iteration token usage breakdown. - Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - - Calculate the true context window size from the last iteration + - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops + A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. + - `output_tokens: number` The cumulative number of output tokens which were used. diff --git a/content/en/api/typescript/beta/models.md b/content/en/api/typescript/beta/models.md index 2a35458fc..53b72158f 100644 --- a/content/en/api/typescript/beta/models.md +++ b/content/en/api/typescript/beta/models.md @@ -36,7 +36,7 @@ The Models API response can be used to determine which models are available for - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -106,6 +106,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaModelInfo` @@ -367,7 +381,7 @@ The Models API response can be used to determine information about a specific mo - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -437,6 +451,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaModelInfo` diff --git a/content/en/api/typescript/beta/models/list.md b/content/en/api/typescript/beta/models/list.md index 80a57ec70..0bdd6406b 100644 --- a/content/en/api/typescript/beta/models/list.md +++ b/content/en/api/typescript/beta/models/list.md @@ -34,7 +34,7 @@ The Models API response can be used to determine which models are available for - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaModelInfo` diff --git a/content/en/api/typescript/beta/models/retrieve.md b/content/en/api/typescript/beta/models/retrieve.md index d53ba5e5c..d6db040f8 100644 --- a/content/en/api/typescript/beta/models/retrieve.md +++ b/content/en/api/typescript/beta/models/retrieve.md @@ -22,7 +22,7 @@ The Models API response can be used to determine information about a specific mo - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaModelInfo` diff --git a/content/en/api/typescript/beta/sessions.md b/content/en/api/typescript/beta/sessions.md index 34dbf23e9..c1bf8ad34 100644 --- a/content/en/api/typescript/beta/sessions.md +++ b/content/en/api/typescript/beta/sessions.md @@ -976,7 +976,7 @@ Create Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1046,6 +1046,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession` @@ -2181,7 +2195,7 @@ List Sessions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2251,6 +2265,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession` @@ -3316,7 +3344,7 @@ Get Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3386,6 +3414,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession` @@ -4884,7 +4926,7 @@ Update Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -4954,6 +4996,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession` @@ -6014,7 +6070,7 @@ Delete Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -6084,6 +6140,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedSession` @@ -6139,7 +6209,7 @@ Archive Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -6209,6 +6279,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession` @@ -11747,7 +11831,7 @@ List Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -11817,6 +11901,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -14372,7 +14470,7 @@ Send Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -14442,6 +14540,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSendSessionEvents` @@ -14957,7 +15069,7 @@ Stream Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -15027,6 +15139,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` @@ -17277,7 +17403,7 @@ Add Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -17347,6 +17473,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsFileResource` @@ -17431,7 +17571,7 @@ List Session Resources - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -17501,6 +17641,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionResource = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -17680,7 +17834,7 @@ Get Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -17750,6 +17904,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `ResourceRetrieveResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -17922,7 +18090,7 @@ Update Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -17992,6 +18160,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `ResourceUpdateResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -18158,7 +18340,7 @@ Delete Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -18228,6 +18410,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeleteSessionResource` @@ -18296,7 +18492,7 @@ List Session Threads - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -18366,6 +18562,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread` @@ -18378,7 +18588,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -19129,7 +19339,7 @@ Get Session Thread - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -19199,6 +19409,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread` @@ -19211,7 +19435,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -19957,7 +20181,7 @@ Archive Session Thread - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -20027,6 +20251,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionThread` @@ -20039,7 +20277,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -20797,7 +21035,7 @@ List Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -20867,6 +21105,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -23062,7 +23314,7 @@ Stream Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -23132,6 +23384,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/typescript/beta/sessions/archive.md b/content/en/api/typescript/beta/sessions/archive.md index 7acb32170..ce4f7f092 100644 --- a/content/en/api/typescript/beta/sessions/archive.md +++ b/content/en/api/typescript/beta/sessions/archive.md @@ -18,7 +18,7 @@ Archive Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSession` diff --git a/content/en/api/typescript/beta/sessions/create.md b/content/en/api/typescript/beta/sessions/create.md index 8c7baeebe..d1e4aa800 100644 --- a/content/en/api/typescript/beta/sessions/create.md +++ b/content/en/api/typescript/beta/sessions/create.md @@ -974,7 +974,7 @@ Create Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1044,6 +1044,20 @@ Create Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSession` diff --git a/content/en/api/typescript/beta/sessions/delete.md b/content/en/api/typescript/beta/sessions/delete.md index 8fbbaf688..56a3e74b1 100644 --- a/content/en/api/typescript/beta/sessions/delete.md +++ b/content/en/api/typescript/beta/sessions/delete.md @@ -18,7 +18,7 @@ Delete Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedSession` diff --git a/content/en/api/typescript/beta/sessions/events.md b/content/en/api/typescript/beta/sessions/events.md index bbe481e1b..aa99a2851 100644 --- a/content/en/api/typescript/beta/sessions/events.md +++ b/content/en/api/typescript/beta/sessions/events.md @@ -66,7 +66,7 @@ List Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -136,6 +136,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -2691,7 +2705,7 @@ Send Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2761,6 +2775,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSendSessionEvents` @@ -3276,7 +3304,7 @@ Stream Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3346,6 +3374,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/typescript/beta/sessions/events/list.md b/content/en/api/typescript/beta/sessions/events/list.md index 3b7c58df3..adc088361 100644 --- a/content/en/api/typescript/beta/sessions/events/list.md +++ b/content/en/api/typescript/beta/sessions/events/list.md @@ -64,7 +64,7 @@ List Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -134,6 +134,20 @@ List Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` diff --git a/content/en/api/typescript/beta/sessions/events/send.md b/content/en/api/typescript/beta/sessions/events/send.md index 691683df0..822e07382 100644 --- a/content/en/api/typescript/beta/sessions/events/send.md +++ b/content/en/api/typescript/beta/sessions/events/send.md @@ -380,7 +380,7 @@ Send Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -450,6 +450,20 @@ Send Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSendSessionEvents` diff --git a/content/en/api/typescript/beta/sessions/events/stream.md b/content/en/api/typescript/beta/sessions/events/stream.md index a8ea2132e..42cffa3fc 100644 --- a/content/en/api/typescript/beta/sessions/events/stream.md +++ b/content/en/api/typescript/beta/sessions/events/stream.md @@ -26,7 +26,7 @@ Stream Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Stream Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/typescript/beta/sessions/list.md b/content/en/api/typescript/beta/sessions/list.md index 4180b5fb4..e91683208 100644 --- a/content/en/api/typescript/beta/sessions/list.md +++ b/content/en/api/typescript/beta/sessions/list.md @@ -92,7 +92,7 @@ List Sessions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -162,6 +162,20 @@ List Sessions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSession` diff --git a/content/en/api/typescript/beta/sessions/resources.md b/content/en/api/typescript/beta/sessions/resources.md index a877839e2..667d0208f 100644 --- a/content/en/api/typescript/beta/sessions/resources.md +++ b/content/en/api/typescript/beta/sessions/resources.md @@ -36,7 +36,7 @@ Add Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -106,6 +106,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsFileResource` @@ -190,7 +204,7 @@ List Session Resources - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -260,6 +274,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionResource = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -439,7 +467,7 @@ Get Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -509,6 +537,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `ResourceRetrieveResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -681,7 +723,7 @@ Update Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -751,6 +793,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `ResourceUpdateResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` @@ -917,7 +973,7 @@ Delete Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -987,6 +1043,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeleteSessionResource` diff --git a/content/en/api/typescript/beta/sessions/resources/add.md b/content/en/api/typescript/beta/sessions/resources/add.md index 3a9cc8e05..ec190fcf7 100644 --- a/content/en/api/typescript/beta/sessions/resources/add.md +++ b/content/en/api/typescript/beta/sessions/resources/add.md @@ -34,7 +34,7 @@ Add Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ Add Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsFileResource` diff --git a/content/en/api/typescript/beta/sessions/resources/delete.md b/content/en/api/typescript/beta/sessions/resources/delete.md index 06cfd7b01..58a7bd9ca 100644 --- a/content/en/api/typescript/beta/sessions/resources/delete.md +++ b/content/en/api/typescript/beta/sessions/resources/delete.md @@ -22,7 +22,7 @@ Delete Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Delete Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeleteSessionResource` diff --git a/content/en/api/typescript/beta/sessions/resources/list.md b/content/en/api/typescript/beta/sessions/resources/list.md index 0b878a024..6eaf944d1 100644 --- a/content/en/api/typescript/beta/sessions/resources/list.md +++ b/content/en/api/typescript/beta/sessions/resources/list.md @@ -28,7 +28,7 @@ List Session Resources - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Session Resources - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionResource = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` diff --git a/content/en/api/typescript/beta/sessions/resources/retrieve.md b/content/en/api/typescript/beta/sessions/resources/retrieve.md index a73ad9233..1c7909a82 100644 --- a/content/en/api/typescript/beta/sessions/resources/retrieve.md +++ b/content/en/api/typescript/beta/sessions/resources/retrieve.md @@ -22,7 +22,7 @@ Get Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Get Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `ResourceRetrieveResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` diff --git a/content/en/api/typescript/beta/sessions/resources/update.md b/content/en/api/typescript/beta/sessions/resources/update.md index eb373b1c6..a76046ea9 100644 --- a/content/en/api/typescript/beta/sessions/resources/update.md +++ b/content/en/api/typescript/beta/sessions/resources/update.md @@ -28,7 +28,7 @@ Update Session Resource - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Update Session Resource - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `ResourceUpdateResponse = BetaManagedAgentsGitHubRepositoryResource | BetaManagedAgentsFileResource | BetaManagedAgentsMemoryStoreResource` diff --git a/content/en/api/typescript/beta/sessions/retrieve.md b/content/en/api/typescript/beta/sessions/retrieve.md index 8b3906d4e..af2ea28af 100644 --- a/content/en/api/typescript/beta/sessions/retrieve.md +++ b/content/en/api/typescript/beta/sessions/retrieve.md @@ -18,7 +18,7 @@ Get Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSession` diff --git a/content/en/api/typescript/beta/sessions/threads.md b/content/en/api/typescript/beta/sessions/threads.md index b8145eab2..a6e222454 100644 --- a/content/en/api/typescript/beta/sessions/threads.md +++ b/content/en/api/typescript/beta/sessions/threads.md @@ -30,7 +30,7 @@ List Session Threads - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionThread` @@ -112,7 +126,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -863,7 +877,7 @@ Get Session Thread - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -933,6 +947,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionThread` @@ -945,7 +973,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -1691,7 +1719,7 @@ Archive Session Thread - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1761,6 +1789,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionThread` @@ -1773,7 +1815,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -2509,7 +2551,7 @@ console.log(betaManagedAgentsSessionThread.id); - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` @@ -5449,7 +5491,7 @@ List Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -5519,6 +5561,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -7714,7 +7770,7 @@ Stream Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -7784,6 +7840,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/typescript/beta/sessions/threads/archive.md b/content/en/api/typescript/beta/sessions/threads/archive.md index 5e46c0e97..2704e4f8d 100644 --- a/content/en/api/typescript/beta/sessions/threads/archive.md +++ b/content/en/api/typescript/beta/sessions/threads/archive.md @@ -22,7 +22,7 @@ Archive Session Thread - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Archive Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionThread` @@ -104,7 +118,7 @@ Archive Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` diff --git a/content/en/api/typescript/beta/sessions/threads/events.md b/content/en/api/typescript/beta/sessions/threads/events.md index 2ec37ed16..2cb214cb5 100644 --- a/content/en/api/typescript/beta/sessions/threads/events.md +++ b/content/en/api/typescript/beta/sessions/threads/events.md @@ -34,7 +34,7 @@ List Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` @@ -2299,7 +2313,7 @@ Stream Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2369,6 +2383,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/typescript/beta/sessions/threads/events/list.md b/content/en/api/typescript/beta/sessions/threads/events/list.md index 90b8e454c..edbfea4d9 100644 --- a/content/en/api/typescript/beta/sessions/threads/events/list.md +++ b/content/en/api/typescript/beta/sessions/threads/events/list.md @@ -32,7 +32,7 @@ List Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionEvent = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 32 more` diff --git a/content/en/api/typescript/beta/sessions/threads/events/stream.md b/content/en/api/typescript/beta/sessions/threads/events/stream.md index 9a69c99e5..3e442275e 100644 --- a/content/en/api/typescript/beta/sessions/threads/events/stream.md +++ b/content/en/api/typescript/beta/sessions/threads/events/stream.md @@ -30,7 +30,7 @@ Stream Session Thread Events - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Stream Session Thread Events - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent | BetaManagedAgentsUserInterruptEvent | BetaManagedAgentsUserToolConfirmationEvent | 34 more` diff --git a/content/en/api/typescript/beta/sessions/threads/list.md b/content/en/api/typescript/beta/sessions/threads/list.md index 5407e1784..1b8d8ae12 100644 --- a/content/en/api/typescript/beta/sessions/threads/list.md +++ b/content/en/api/typescript/beta/sessions/threads/list.md @@ -28,7 +28,7 @@ List Session Threads - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ List Session Threads - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionThread` @@ -110,7 +124,7 @@ List Session Threads - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` diff --git a/content/en/api/typescript/beta/sessions/threads/retrieve.md b/content/en/api/typescript/beta/sessions/threads/retrieve.md index cc53c3837..bca067417 100644 --- a/content/en/api/typescript/beta/sessions/threads/retrieve.md +++ b/content/en/api/typescript/beta/sessions/threads/retrieve.md @@ -22,7 +22,7 @@ Get Session Thread - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Get Session Thread - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSessionThread` @@ -104,7 +118,7 @@ Get Session Thread - `agent: BetaManagedAgentsSessionThreadAgent | BetaManagedAgentsAdvisor` - A session-resolved multiagent roster entry. + The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot. - `BetaManagedAgentsSessionThreadAgent` diff --git a/content/en/api/typescript/beta/sessions/update.md b/content/en/api/typescript/beta/sessions/update.md index 139e12d0b..875acc4c1 100644 --- a/content/en/api/typescript/beta/sessions/update.md +++ b/content/en/api/typescript/beta/sessions/update.md @@ -456,7 +456,7 @@ Update Session - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -526,6 +526,20 @@ Update Session - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsSession` diff --git a/content/en/api/typescript/beta/skills.md b/content/en/api/typescript/beta/skills.md index 35b6d19cc..2c8413b3c 100644 --- a/content/en/api/typescript/beta/skills.md +++ b/content/en/api/typescript/beta/skills.md @@ -30,7 +30,7 @@ Create Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `SkillCreateResponse` @@ -216,7 +230,7 @@ List Skills - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -286,6 +300,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `SkillListResponse` @@ -392,7 +420,7 @@ Get Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -462,6 +490,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `SkillRetrieveResponse` @@ -561,7 +603,7 @@ Delete Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -631,6 +673,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `SkillDeleteResponse` @@ -865,7 +921,7 @@ Create Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -935,6 +991,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `VersionCreateResponse` @@ -1050,7 +1120,7 @@ List Skill Versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1120,6 +1190,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `VersionListResponse` @@ -1236,7 +1320,7 @@ Download a skill version's content as a zip archive. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1306,6 +1390,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `unnamed_schema_2 = Response` @@ -1359,7 +1457,7 @@ Get Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1429,6 +1527,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `VersionRetrieveResponse` @@ -1540,7 +1652,7 @@ Delete Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1610,6 +1722,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `VersionDeleteResponse` diff --git a/content/en/api/typescript/beta/skills/create.md b/content/en/api/typescript/beta/skills/create.md index 70db8ab56..6c59eadae 100644 --- a/content/en/api/typescript/beta/skills/create.md +++ b/content/en/api/typescript/beta/skills/create.md @@ -28,7 +28,7 @@ Create Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Create Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `SkillCreateResponse` diff --git a/content/en/api/typescript/beta/skills/delete.md b/content/en/api/typescript/beta/skills/delete.md index 56dbfa257..02bbcdfb5 100644 --- a/content/en/api/typescript/beta/skills/delete.md +++ b/content/en/api/typescript/beta/skills/delete.md @@ -22,7 +22,7 @@ Delete Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Delete Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `SkillDeleteResponse` diff --git a/content/en/api/typescript/beta/skills/list.md b/content/en/api/typescript/beta/skills/list.md index e32cf1963..093bb07fb 100644 --- a/content/en/api/typescript/beta/skills/list.md +++ b/content/en/api/typescript/beta/skills/list.md @@ -37,7 +37,7 @@ List Skills - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -107,6 +107,20 @@ List Skills - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `SkillListResponse` diff --git a/content/en/api/typescript/beta/skills/retrieve.md b/content/en/api/typescript/beta/skills/retrieve.md index e7188cbfb..1967c32f9 100644 --- a/content/en/api/typescript/beta/skills/retrieve.md +++ b/content/en/api/typescript/beta/skills/retrieve.md @@ -22,7 +22,7 @@ Get Skill - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Get Skill - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `SkillRetrieveResponse` diff --git a/content/en/api/typescript/beta/skills/versions.md b/content/en/api/typescript/beta/skills/versions.md index 4cec0da7c..6ad7d4265 100644 --- a/content/en/api/typescript/beta/skills/versions.md +++ b/content/en/api/typescript/beta/skills/versions.md @@ -30,7 +30,7 @@ Create Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `VersionCreateResponse` @@ -215,7 +229,7 @@ List Skill Versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -285,6 +299,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `VersionListResponse` @@ -401,7 +429,7 @@ Download a skill version's content as a zip archive. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -471,6 +499,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `unnamed_schema_2 = Response` @@ -524,7 +566,7 @@ Get Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -594,6 +636,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `VersionRetrieveResponse` @@ -705,7 +761,7 @@ Delete Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -775,6 +831,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `VersionDeleteResponse` diff --git a/content/en/api/typescript/beta/skills/versions/create.md b/content/en/api/typescript/beta/skills/versions/create.md index 4a81a7946..c6d503f38 100644 --- a/content/en/api/typescript/beta/skills/versions/create.md +++ b/content/en/api/typescript/beta/skills/versions/create.md @@ -28,7 +28,7 @@ Create Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Create Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `VersionCreateResponse` diff --git a/content/en/api/typescript/beta/skills/versions/delete.md b/content/en/api/typescript/beta/skills/versions/delete.md index c0464c2d3..e1c4d8c99 100644 --- a/content/en/api/typescript/beta/skills/versions/delete.md +++ b/content/en/api/typescript/beta/skills/versions/delete.md @@ -28,7 +28,7 @@ Delete Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Delete Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `VersionDeleteResponse` diff --git a/content/en/api/typescript/beta/skills/versions/download.md b/content/en/api/typescript/beta/skills/versions/download.md index 8def09e5e..951ed00d4 100644 --- a/content/en/api/typescript/beta/skills/versions/download.md +++ b/content/en/api/typescript/beta/skills/versions/download.md @@ -28,7 +28,7 @@ Download a skill version's content as a zip archive. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Download a skill version's content as a zip archive. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `unnamed_schema_2 = Response` diff --git a/content/en/api/typescript/beta/skills/versions/list.md b/content/en/api/typescript/beta/skills/versions/list.md index b2edafbf3..e5f47d2af 100644 --- a/content/en/api/typescript/beta/skills/versions/list.md +++ b/content/en/api/typescript/beta/skills/versions/list.md @@ -32,7 +32,7 @@ List Skill Versions - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List Skill Versions - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `VersionListResponse` diff --git a/content/en/api/typescript/beta/skills/versions/retrieve.md b/content/en/api/typescript/beta/skills/versions/retrieve.md index 77220c373..a2da96042 100644 --- a/content/en/api/typescript/beta/skills/versions/retrieve.md +++ b/content/en/api/typescript/beta/skills/versions/retrieve.md @@ -28,7 +28,7 @@ Get Skill Version - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Get Skill Version - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `VersionRetrieveResponse` diff --git a/content/en/api/typescript/beta/tunnels.md b/content/en/api/typescript/beta/tunnels.md index 4332fcf32..d2ae0a67f 100644 --- a/content/en/api/typescript/beta/tunnels.md +++ b/content/en/api/typescript/beta/tunnels.md @@ -26,7 +26,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnel` @@ -177,7 +191,7 @@ Fetches a tunnel by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -247,6 +261,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnel` @@ -340,7 +368,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -410,6 +438,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnel` @@ -497,7 +539,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -567,6 +609,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnel` @@ -648,7 +704,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -718,6 +774,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelToken` @@ -786,7 +856,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -856,6 +926,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelToken` @@ -976,7 +1060,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1046,6 +1130,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelCertificate` @@ -1140,7 +1238,7 @@ Fetches a tunnel certificate by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1210,6 +1308,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelCertificate` @@ -1315,7 +1427,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1385,6 +1497,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelCertificate` @@ -1483,7 +1609,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1553,6 +1679,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaTunnelCertificate` diff --git a/content/en/api/typescript/beta/tunnels/archive.md b/content/en/api/typescript/beta/tunnels/archive.md index 539f68157..5b77aeefa 100644 --- a/content/en/api/typescript/beta/tunnels/archive.md +++ b/content/en/api/typescript/beta/tunnels/archive.md @@ -20,7 +20,7 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Archives a tunnel. Archival is irreversible: every non-archived certificate on t - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnel` diff --git a/content/en/api/typescript/beta/tunnels/certificates.md b/content/en/api/typescript/beta/tunnels/certificates.md index c17c4b4f7..1eced928b 100644 --- a/content/en/api/typescript/beta/tunnels/certificates.md +++ b/content/en/api/typescript/beta/tunnels/certificates.md @@ -28,7 +28,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelCertificate` @@ -192,7 +206,7 @@ Fetches a tunnel certificate by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -262,6 +276,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelCertificate` @@ -367,7 +395,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -437,6 +465,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelCertificate` @@ -535,7 +577,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -605,6 +647,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaTunnelCertificate` diff --git a/content/en/api/typescript/beta/tunnels/certificates/archive.md b/content/en/api/typescript/beta/tunnels/certificates/archive.md index 94ac888a7..baa1c92a9 100644 --- a/content/en/api/typescript/beta/tunnels/certificates/archive.md +++ b/content/en/api/typescript/beta/tunnels/certificates/archive.md @@ -24,7 +24,7 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Archives a tunnel certificate, removing it from the set Anthropic trusts for the - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelCertificate` diff --git a/content/en/api/typescript/beta/tunnels/certificates/create.md b/content/en/api/typescript/beta/tunnels/certificates/create.md index 515ee87b6..552f03507 100644 --- a/content/en/api/typescript/beta/tunnels/certificates/create.md +++ b/content/en/api/typescript/beta/tunnels/certificates/create.md @@ -26,7 +26,7 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelCertificate` diff --git a/content/en/api/typescript/beta/tunnels/certificates/list.md b/content/en/api/typescript/beta/tunnels/certificates/list.md index 3856aa85f..d9727bc50 100644 --- a/content/en/api/typescript/beta/tunnels/certificates/list.md +++ b/content/en/api/typescript/beta/tunnels/certificates/list.md @@ -34,7 +34,7 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ Lists the certificates registered on a tunnel. Archived certificates are exclude - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelCertificate` diff --git a/content/en/api/typescript/beta/tunnels/certificates/retrieve.md b/content/en/api/typescript/beta/tunnels/certificates/retrieve.md index d6d03ba53..e8847b34a 100644 --- a/content/en/api/typescript/beta/tunnels/certificates/retrieve.md +++ b/content/en/api/typescript/beta/tunnels/certificates/retrieve.md @@ -24,7 +24,7 @@ Fetches a tunnel certificate by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Fetches a tunnel certificate by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelCertificate` diff --git a/content/en/api/typescript/beta/tunnels/create.md b/content/en/api/typescript/beta/tunnels/create.md index ccc625630..014e80245 100644 --- a/content/en/api/typescript/beta/tunnels/create.md +++ b/content/en/api/typescript/beta/tunnels/create.md @@ -24,7 +24,7 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -94,6 +94,20 @@ Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnel` diff --git a/content/en/api/typescript/beta/tunnels/list.md b/content/en/api/typescript/beta/tunnels/list.md index 003ec66f8..df6255c0b 100644 --- a/content/en/api/typescript/beta/tunnels/list.md +++ b/content/en/api/typescript/beta/tunnels/list.md @@ -32,7 +32,7 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ Lists tunnels. Results are ordered by creation time, newest first; archived tunn - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnel` diff --git a/content/en/api/typescript/beta/tunnels/retrieve.md b/content/en/api/typescript/beta/tunnels/retrieve.md index 90a44906f..dd3702046 100644 --- a/content/en/api/typescript/beta/tunnels/retrieve.md +++ b/content/en/api/typescript/beta/tunnels/retrieve.md @@ -20,7 +20,7 @@ Fetches a tunnel by ID. - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Fetches a tunnel by ID. - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnel` diff --git a/content/en/api/typescript/beta/tunnels/reveal_token.md b/content/en/api/typescript/beta/tunnels/reveal_token.md index d1e7cfbed..ce45193e0 100644 --- a/content/en/api/typescript/beta/tunnels/reveal_token.md +++ b/content/en/api/typescript/beta/tunnels/reveal_token.md @@ -20,7 +20,7 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -90,6 +90,20 @@ Reveals a tunnel's connector token. The value is fetched live on each call; Anth - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelToken` diff --git a/content/en/api/typescript/beta/tunnels/rotate_token.md b/content/en/api/typescript/beta/tunnels/rotate_token.md index e8935f0fd..443402539 100644 --- a/content/en/api/typescript/beta/tunnels/rotate_token.md +++ b/content/en/api/typescript/beta/tunnels/rotate_token.md @@ -26,7 +26,7 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Rotates a tunnel's connector token. Rotation invalidates the current token for n - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaTunnelToken` diff --git a/content/en/api/typescript/beta/user_profiles.md b/content/en/api/typescript/beta/user_profiles.md index 5110ce943..7917894d1 100644 --- a/content/en/api/typescript/beta/user_profiles.md +++ b/content/en/api/typescript/beta/user_profiles.md @@ -52,7 +52,7 @@ Create User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -122,6 +122,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaUserProfile` @@ -261,7 +275,7 @@ List User Profiles - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -331,6 +345,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaUserProfile` @@ -460,7 +488,7 @@ Get User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -530,6 +558,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaUserProfile` @@ -689,7 +731,7 @@ Update User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -759,6 +801,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaUserProfile` @@ -884,7 +940,7 @@ Create Enrollment URL - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -954,6 +1010,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaUserProfileEnrollmentURL` diff --git a/content/en/api/typescript/beta/user_profiles/create.md b/content/en/api/typescript/beta/user_profiles/create.md index e185baac2..2135dc817 100644 --- a/content/en/api/typescript/beta/user_profiles/create.md +++ b/content/en/api/typescript/beta/user_profiles/create.md @@ -50,7 +50,7 @@ Create User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -120,6 +120,20 @@ Create User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaUserProfile` diff --git a/content/en/api/typescript/beta/user_profiles/create_enrollment_url.md b/content/en/api/typescript/beta/user_profiles/create_enrollment_url.md index 591756b6d..abdef47da 100644 --- a/content/en/api/typescript/beta/user_profiles/create_enrollment_url.md +++ b/content/en/api/typescript/beta/user_profiles/create_enrollment_url.md @@ -18,7 +18,7 @@ Create Enrollment URL - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Create Enrollment URL - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaUserProfileEnrollmentURL` diff --git a/content/en/api/typescript/beta/user_profiles/list.md b/content/en/api/typescript/beta/user_profiles/list.md index ad9bb3bdf..2db8d7403 100644 --- a/content/en/api/typescript/beta/user_profiles/list.md +++ b/content/en/api/typescript/beta/user_profiles/list.md @@ -34,7 +34,7 @@ List User Profiles - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ List User Profiles - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaUserProfile` diff --git a/content/en/api/typescript/beta/user_profiles/retrieve.md b/content/en/api/typescript/beta/user_profiles/retrieve.md index b9cf28bd2..ff2dc0d16 100644 --- a/content/en/api/typescript/beta/user_profiles/retrieve.md +++ b/content/en/api/typescript/beta/user_profiles/retrieve.md @@ -18,7 +18,7 @@ Get User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaUserProfile` diff --git a/content/en/api/typescript/beta/user_profiles/update.md b/content/en/api/typescript/beta/user_profiles/update.md index 5645a74bf..23ede744c 100644 --- a/content/en/api/typescript/beta/user_profiles/update.md +++ b/content/en/api/typescript/beta/user_profiles/update.md @@ -52,7 +52,7 @@ Update User Profile - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -122,6 +122,20 @@ Update User Profile - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaUserProfile` diff --git a/content/en/api/typescript/beta/vaults.md b/content/en/api/typescript/beta/vaults.md index 672b46449..30d48c5db 100644 --- a/content/en/api/typescript/beta/vaults.md +++ b/content/en/api/typescript/beta/vaults.md @@ -28,7 +28,7 @@ Create Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsVault` @@ -200,7 +214,7 @@ List Vaults - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -270,6 +284,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsVault` @@ -364,7 +392,7 @@ Get Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -434,6 +462,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsVault` @@ -534,7 +576,7 @@ Update Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -604,6 +646,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsVault` @@ -692,7 +748,7 @@ Delete Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -762,6 +818,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedVault` @@ -819,7 +889,7 @@ Archive Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -889,6 +959,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsVault` @@ -1207,7 +1291,7 @@ Create Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1277,6 +1361,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -1511,7 +1609,7 @@ List Credentials - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1581,6 +1679,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -1804,7 +1916,7 @@ Get Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1874,6 +1986,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -2224,7 +2350,7 @@ Update Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2294,6 +2420,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -2512,7 +2652,7 @@ Delete Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2582,6 +2722,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsDeletedCredential` @@ -2644,7 +2798,7 @@ Archive Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -2714,6 +2868,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredential` @@ -2932,7 +3100,7 @@ Validate Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -3002,6 +3170,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + #### Returns - `BetaManagedAgentsCredentialValidation` diff --git a/content/en/api/typescript/beta/vaults/archive.md b/content/en/api/typescript/beta/vaults/archive.md index 2e24faf43..6aea1fe98 100644 --- a/content/en/api/typescript/beta/vaults/archive.md +++ b/content/en/api/typescript/beta/vaults/archive.md @@ -18,7 +18,7 @@ Archive Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Archive Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsVault` diff --git a/content/en/api/typescript/beta/vaults/create.md b/content/en/api/typescript/beta/vaults/create.md index f308c05c6..10c62066e 100644 --- a/content/en/api/typescript/beta/vaults/create.md +++ b/content/en/api/typescript/beta/vaults/create.md @@ -26,7 +26,7 @@ Create Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -96,6 +96,20 @@ Create Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsVault` diff --git a/content/en/api/typescript/beta/vaults/credentials.md b/content/en/api/typescript/beta/vaults/credentials.md index dea5bf2f7..02ca60cd9 100644 --- a/content/en/api/typescript/beta/vaults/credentials.md +++ b/content/en/api/typescript/beta/vaults/credentials.md @@ -194,7 +194,7 @@ Create Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -264,6 +264,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredential` @@ -498,7 +512,7 @@ List Credentials - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -568,6 +582,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredential` @@ -791,7 +819,7 @@ Get Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -861,6 +889,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredential` @@ -1211,7 +1253,7 @@ Update Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1281,6 +1323,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredential` @@ -1499,7 +1555,7 @@ Delete Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1569,6 +1625,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedCredential` @@ -1631,7 +1701,7 @@ Archive Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1701,6 +1771,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredential` @@ -1919,7 +2003,7 @@ Validate Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -1989,6 +2073,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsCredentialValidation` diff --git a/content/en/api/typescript/beta/vaults/credentials/archive.md b/content/en/api/typescript/beta/vaults/credentials/archive.md index 378e8dc1e..263581550 100644 --- a/content/en/api/typescript/beta/vaults/credentials/archive.md +++ b/content/en/api/typescript/beta/vaults/credentials/archive.md @@ -22,7 +22,7 @@ Archive Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Archive Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredential` diff --git a/content/en/api/typescript/beta/vaults/credentials/create.md b/content/en/api/typescript/beta/vaults/credentials/create.md index b7336196b..58e4b83a5 100644 --- a/content/en/api/typescript/beta/vaults/credentials/create.md +++ b/content/en/api/typescript/beta/vaults/credentials/create.md @@ -192,7 +192,7 @@ Create Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -262,6 +262,20 @@ Create Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredential` diff --git a/content/en/api/typescript/beta/vaults/credentials/delete.md b/content/en/api/typescript/beta/vaults/credentials/delete.md index 7c3ed5132..6da31afb6 100644 --- a/content/en/api/typescript/beta/vaults/credentials/delete.md +++ b/content/en/api/typescript/beta/vaults/credentials/delete.md @@ -22,7 +22,7 @@ Delete Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Delete Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedCredential` diff --git a/content/en/api/typescript/beta/vaults/credentials/list.md b/content/en/api/typescript/beta/vaults/credentials/list.md index 08de2bb59..4423007c0 100644 --- a/content/en/api/typescript/beta/vaults/credentials/list.md +++ b/content/en/api/typescript/beta/vaults/credentials/list.md @@ -32,7 +32,7 @@ List Credentials - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -102,6 +102,20 @@ List Credentials - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredential` diff --git a/content/en/api/typescript/beta/vaults/credentials/mcp_oauth_validate.md b/content/en/api/typescript/beta/vaults/credentials/mcp_oauth_validate.md index 76d843370..79aece529 100644 --- a/content/en/api/typescript/beta/vaults/credentials/mcp_oauth_validate.md +++ b/content/en/api/typescript/beta/vaults/credentials/mcp_oauth_validate.md @@ -22,7 +22,7 @@ Validate Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Validate Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredentialValidation` diff --git a/content/en/api/typescript/beta/vaults/credentials/retrieve.md b/content/en/api/typescript/beta/vaults/credentials/retrieve.md index 92e72fad1..c8a716e1b 100644 --- a/content/en/api/typescript/beta/vaults/credentials/retrieve.md +++ b/content/en/api/typescript/beta/vaults/credentials/retrieve.md @@ -22,7 +22,7 @@ Get Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ Get Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredential` diff --git a/content/en/api/typescript/beta/vaults/credentials/update.md b/content/en/api/typescript/beta/vaults/credentials/update.md index 0f968940d..88b0177de 100644 --- a/content/en/api/typescript/beta/vaults/credentials/update.md +++ b/content/en/api/typescript/beta/vaults/credentials/update.md @@ -154,7 +154,7 @@ Update Credential - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -224,6 +224,20 @@ Update Credential - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsCredential` diff --git a/content/en/api/typescript/beta/vaults/delete.md b/content/en/api/typescript/beta/vaults/delete.md index b92576f12..49ccdb814 100644 --- a/content/en/api/typescript/beta/vaults/delete.md +++ b/content/en/api/typescript/beta/vaults/delete.md @@ -18,7 +18,7 @@ Delete Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Delete Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsDeletedVault` diff --git a/content/en/api/typescript/beta/vaults/list.md b/content/en/api/typescript/beta/vaults/list.md index 75d8fb57e..e78e785e0 100644 --- a/content/en/api/typescript/beta/vaults/list.md +++ b/content/en/api/typescript/beta/vaults/list.md @@ -30,7 +30,7 @@ List Vaults - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -100,6 +100,20 @@ List Vaults - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsVault` diff --git a/content/en/api/typescript/beta/vaults/retrieve.md b/content/en/api/typescript/beta/vaults/retrieve.md index 32b4153b1..c84de15f0 100644 --- a/content/en/api/typescript/beta/vaults/retrieve.md +++ b/content/en/api/typescript/beta/vaults/retrieve.md @@ -18,7 +18,7 @@ Get Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -88,6 +88,20 @@ Get Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsVault` diff --git a/content/en/api/typescript/beta/vaults/update.md b/content/en/api/typescript/beta/vaults/update.md index 095e901e2..c73405d10 100644 --- a/content/en/api/typescript/beta/vaults/update.md +++ b/content/en/api/typescript/beta/vaults/update.md @@ -28,7 +28,7 @@ Update Vault - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -98,6 +98,20 @@ Update Vault - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `BetaManagedAgentsVault` diff --git a/content/en/api/typescript/completions.md b/content/en/api/typescript/completions.md index a82188966..039682f4d 100644 --- a/content/en/api/typescript/completions.md +++ b/content/en/api/typescript/completions.md @@ -150,7 +150,7 @@ Future models and features will not be compatible with Text Completions. See our - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -220,6 +220,20 @@ Future models and features will not be compatible with Text Completions. See our - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `temperature?: number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error. diff --git a/content/en/api/typescript/completions/create.md b/content/en/api/typescript/completions/create.md index 0ddb294b0..e5451b43c 100644 --- a/content/en/api/typescript/completions/create.md +++ b/content/en/api/typescript/completions/create.md @@ -148,7 +148,7 @@ Future models and features will not be compatible with Text Completions. See our - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -218,6 +218,20 @@ Future models and features will not be compatible with Text Completions. See our - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + - `temperature?: number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error. diff --git a/content/en/api/typescript/models.md b/content/en/api/typescript/models.md index 043ed7a3a..84a1b0f8b 100644 --- a/content/en/api/typescript/models.md +++ b/content/en/api/typescript/models.md @@ -36,7 +36,7 @@ The Models API response can be used to determine which models are available for - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -106,6 +106,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `ModelInfo` @@ -360,7 +374,7 @@ The Models API response can be used to determine information about a specific mo - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -430,6 +444,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `ModelInfo` diff --git a/content/en/api/typescript/models/list.md b/content/en/api/typescript/models/list.md index 49193f6ba..e6026ff2f 100644 --- a/content/en/api/typescript/models/list.md +++ b/content/en/api/typescript/models/list.md @@ -34,7 +34,7 @@ The Models API response can be used to determine which models are available for - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -104,6 +104,20 @@ The Models API response can be used to determine which models are available for - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `ModelInfo` diff --git a/content/en/api/typescript/models/retrieve.md b/content/en/api/typescript/models/retrieve.md index 123cff1d1..baa7ab244 100644 --- a/content/en/api/typescript/models/retrieve.md +++ b/content/en/api/typescript/models/retrieve.md @@ -22,7 +22,7 @@ The Models API response can be used to determine information about a specific mo - `(string & {})` - - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 31 more` + - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 38 more` - `"message-batches-2024-09-24"` @@ -92,6 +92,20 @@ The Models API response can be used to determine information about a specific mo - `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ## Returns - `ModelInfo` diff --git a/content/en/build-with-claude/claude-in-microsoft-foundry.md b/content/en/build-with-claude/claude-in-microsoft-foundry.md index 6a33bdac8..2724c55ee 100644 --- a/content/en/build-with-claude/claude-in-microsoft-foundry.md +++ b/content/en/build-with-claude/claude-in-microsoft-foundry.md @@ -649,12 +649,11 @@ Claude Fable 5, Claude Opus 5, Claude Opus 4.8, Claude Opus 4.7, Claude Opus 4.6 The following features are available for deployments hosted on Anthropic but are not supported for deployments hosted on Azure: -* Structured outputs -* Server-side tools (web search, web fetch, code execution, and tool search) -* MCP connector -* Agent Skills -* Programmatic tool calling -* Files API +* [Code execution](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool) +* [Web search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) and [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) tool versions later than `web_search_20250305` and `web_fetch_20250910`. Deployments hosted on Azure support only these basic versions, so dynamic filtering, response inclusion, and cache bypass are not available. +* [Agent Skills](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview) +* [Programmatic tool calling](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling) +* [Files API](https://platform.claude.com/docs/en/build-with-claude/files) Requests that use these features against a deployment hosted on Azure return a `400 Bad Request` error by design. Claude Code detects deployments hosted on Azure and automatically adapts its feature set. diff --git a/content/en/build-with-claude/claude-on-vertex-ai.md b/content/en/build-with-claude/claude-on-vertex-ai.md index a25a23396..d6f32414a 100644 --- a/content/en/build-with-claude/claude-on-vertex-ai.md +++ b/content/en/build-with-claude/claude-on-vertex-ai.md @@ -349,7 +349,7 @@ For the full feature list with Google Cloud availability, see [Features overview * [Messages API](https://platform.claude.com/docs/en/api/messages/create) * [Prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) * [Thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) -* [Tool use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview), including the [Bash tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool), [Computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), [Memory tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool), and [Text editor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool) +* [Tool use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview), including the [Bash tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool), [Browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool), [Computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), [Memory tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool), and [Text editor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool) * [Web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) * [Citations](https://platform.claude.com/docs/en/build-with-claude/citations) * [Structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) @@ -362,7 +362,6 @@ For the full feature list with Google Cloud availability, see [Features overview * API endpoints (Message Batches, Models, Admin, Compliance, Usage and Cost) * Claude Managed Agents * Server-side fallback (the [`fallbacks` parameter](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#server-side-fallback); use the [client-side fallback pattern](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#client-side-fallback) instead) -* [Computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) and [browser use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) toolsets (`computer_toolset_20260801` and `browser_toolset_20260801` are not currently available on Google Cloud; the beta computer use tool versions remain available) ### Context window diff --git a/content/en/build-with-claude/claude-platform-on-aws.md b/content/en/build-with-claude/claude-platform-on-aws.md index 83f8247bd..1f3634664 100644 --- a/content/en/build-with-claude/claude-platform-on-aws.md +++ b/content/en/build-with-claude/claude-platform-on-aws.md @@ -14,11 +14,11 @@ Claude Platform on AWS gives you the full Anthropic platform experience, includi Claude models run on Anthropic-managed infrastructure. This is a commercial integration for billing and access through AWS. Anthropic is the data processor for inference inputs and outputs. AWS processes billing and identity metadata under the marketplace model. Customers using Claude through Claude Platform on AWS are subject to Anthropic's [data use terms](https://www.anthropic.com/legal). -Claude Platform on AWS has the following operational characteristics: data may not reside in AWS, inference may route to Anthropic's primary cloud, and subservices may change without notice. Set the [`inference_geo`](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#data-residency) parameter per request to pin inference to a specific geography. +Claude Platform on AWS has the following operational characteristics: data might not reside in AWS, inference might route to Anthropic's primary cloud, and subservices might change without notice. Set the [`inference_geo`](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#data-residency) parameter per request to pin inference to a specific geography. Claude Platform on AWS follows the same data retention policy as the first-party Claude API. Zero Data Retention (ZDR) is available on request. Contact your Anthropic account representative to enable it for your organization. -## Claude Platform on AWS vs Amazon Bedrock +## Claude Platform on AWS versus Amazon Bedrock Both offerings let you use Claude through AWS, but they differ in architecture, API surface, and feature availability. @@ -542,7 +542,7 @@ Claude Platform on AWS uses Claude API endpoints directly, which means you get f * **Batch processing:** Submit batch requests for high-throughput workloads. * **Prompt caching:** Cache tools, system prompts, and message history to reduce latency and cost. All prompt caching capabilities (5-minute TTL, 1-hour TTL, and automatic caching) are available. * **Files API:** Upload and reference files across requests. -* **Customer-managed encryption keys (CMEK):** [CMEK](https://platform.claude.com/docs/en/manage-claude/cmek) is available with [AWS KMS](https://platform.claude.com/docs/en/manage-claude/cmek-aws-kms) keys only. Google Cloud KMS and Azure Key Vault keys cannot be registered. Create, validate, and attach keys in the [Claude Console](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#using-the-claude-console). The `external_keys` Admin API endpoints are not currently available. The key must be in the same AWS region as the workspace it is attached to. +* **Customer-managed encryption keys (CMEK):** [CMEK](https://platform.claude.com/docs/en/manage-claude/cmek) is available with [AWS KMS](https://platform.claude.com/docs/en/manage-claude/cmek-aws-kms) keys only. Google Cloud KMS and Azure Key Vault keys cannot be registered. Create and attach keys in the [Claude Console](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#using-the-claude-console). There is no separate validation step: the key is implicitly validated when you attach it to a workspace (the attach call performs an encrypt/decrypt round), so a key policy problem surfaces at attach time rather than at registration. The `external_keys` Admin API endpoints are not currently available. The key must be in the same AWS region as the workspace it is attached to. * **Compliance API:** The [Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api) is available. Access is authorized through the AWS IAM [`ListComplianceActivities` action](https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions#compliance). See the [comparison table](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#claude-platform-on-aws-vs-amazon-bedrock) for feature-availability differences from Amazon Bedrock. diff --git a/content/en/build-with-claude/overview.md b/content/en/build-with-claude/overview.md index 6ad3570cb..e94657cda 100644 --- a/content/en/build-with-claude/overview.md +++ b/content/en/build-with-claude/overview.md @@ -50,7 +50,7 @@ The ZDR column indicates whether a feature is available under a Zero Data Retent | [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support) | Process and analyze text and visual content from PDF documents. | ZDR eligible | | | [Search results](https://platform.claude.com/docs/en/build-with-claude/search-results) | Enable natural citations for RAG applications by providing search results with proper source attribution. Achieve web search-quality citations for custom knowledge bases and tools. | ZDR eligible | | | [Server-side fallback](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback) | Retry a refused request inside a single API call. Use the `"default"` mode to apply Anthropic's recommended fallback models, or name up to three models of your own; when the requested model declines, the API runs the next model in the chain on the same request. The `fallbacks` parameter is not available in the Message Batches API. | Not ZDR eligible\* | | -| [Structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) | Guarantee schema conformance with two approaches: JSON outputs for structured data responses, and strict tool use for validated tool inputs. | [ZDR eligible (qualified)](https://platform.claude.com/docs/en/build-with-claude/structured-outputs#data-retention)\* | † | +| [Structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) | Guarantee schema conformance with two approaches: JSON outputs for structured data responses, and strict tool use for validated tool inputs. | [ZDR eligible (qualified)](https://platform.claude.com/docs/en/build-with-claude/structured-outputs#data-retention)\* | | | [Thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) | Enhanced reasoning capabilities for complex tasks, providing transparency into Claude's step-by-step thought process before delivering its final answer. | ZDR eligible | | ## Tools @@ -59,34 +59,34 @@ Built-in tools that Claude invokes through `tool_use`. Server-side tools are run ### Server-side tools -| Feature | Description | ZDR | Availability | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ---------------------------------------------------------------------- | -| [Advisor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/advisor-tool) | Pair a faster executor model with a higher-intelligence advisor model that provides strategic guidance mid-generation for long-horizon agentic workloads. | ZDR eligible | | -| [Code execution](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool) | Run code in a sandboxed environment for advanced data analysis, calculations, and file processing. Free when used with web search or web fetch. | Not ZDR eligible | † | -| [Web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) | Retrieve full content from specified web pages and PDF documents for in-depth analysis. | ZDR eligible\* | † | -| [Web search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) | Augment Claude's comprehensive knowledge with current, real-world data from across the web. | ZDR eligible\* | † | +| Feature | Description | ZDR | Availability | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | --------------------------------------------------------------------- | +| [Advisor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/advisor-tool) | Pair a faster executor model with a higher-intelligence advisor model that provides strategic guidance mid-generation for long-horizon agentic workloads. | ZDR eligible | | +| [Code execution](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool) | Run code in a sandboxed environment for advanced data analysis, calculations, and file processing. Free when used with web search or web fetch. | Not ZDR eligible | † | +| [Web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) | Retrieve full content from specified web pages and PDF documents for in-depth analysis. | ZDR eligible\* | | +| [Web search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) | Augment Claude's comprehensive knowledge with current, real-world data from across the web. | ZDR eligible\* | | ### Client-side tools -| Feature | Description | ZDR | Availability | -| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | --------------------------------------------------------------------------------------------- | -| [Bash](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool) | Execute bash commands and scripts to interact with the system shell and perform command-line operations. | ZDR eligible | | -| [Browser use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) | Navigate, read, and interact with webpages in your own browser environment. | ZDR eligible | | -| [Computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) | Control computer interfaces by taking screenshots and issuing mouse and keyboard commands. | ZDR eligible | | -| [Memory](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool) | Enable Claude to store and retrieve information across conversations. Build knowledge bases over time, maintain project context, and learn from past interactions. | ZDR eligible | | -| [Text editor](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool) | Create and edit text files with a built-in text editor interface for file manipulation tasks. | ZDR eligible | | +| Feature | Description | ZDR | Availability | +| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | ----------------------------------------------------------------------------------------- | +| [Bash](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool) | Execute bash commands and scripts to interact with the system shell and perform command-line operations. | ZDR eligible | | +| [Browser use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) | Navigate, read, and interact with webpages in your own browser environment. | ZDR eligible | | +| [Computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) | Control computer interfaces by taking screenshots and issuing mouse and keyboard commands. | ZDR eligible | | +| [Memory](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool) | Enable Claude to store and retrieve information across conversations. Build knowledge bases over time, maintain project context, and learn from past interactions. | ZDR eligible | | +| [Text editor](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool) | Create and edit text files with a built-in text editor interface for file manipulation tasks. | ZDR eligible | | ## Tool infrastructure Infrastructure that supports discovering, orchestrating, and scaling tool use. -| Feature | Description | ZDR | Availability | -| ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------ | -| [Agent Skills](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview) | Extend Claude's capabilities with Skills. Use pre-built Skills (PowerPoint, Excel, Word, PDF) or create custom Skills with instructions and scripts. Skills use progressive disclosure to efficiently manage context. | Not ZDR eligible | † | -| [Fine-grained tool streaming](https://platform.claude.com/docs/en/agents-and-tools/tool-use/fine-grained-tool-streaming) | Stream tool use parameters without buffering/JSON validation, reducing latency for receiving large parameters. | ZDR eligible | | -| [MCP connector](https://platform.claude.com/docs/en/agents-and-tools/mcp-connector) | Connect to remote [MCP](https://platform.claude.com/docs/en/mcp) servers directly from the Messages API without a separate MCP client. | Not ZDR eligible | † | -| [Programmatic tool calling](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling) | Enable Claude to call your tools programmatically from within code execution containers, reducing latency and token consumption for multi-tool workflows. | Not ZDR eligible | † | -| [Tool search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool) | Scale to thousands of tools by dynamically discovering and loading tools on-demand using regex- and BM25-based search, optimizing context usage and improving tool selection accuracy. | ZDR eligible | † | +| Feature | Description | ZDR | Availability | +| ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ----------------------------------------------------------------------------- | +| [Agent Skills](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview) | Extend Claude's capabilities with Skills. Use pre-built Skills (PowerPoint, Excel, Word, PDF) or create custom Skills with instructions and scripts. Skills use progressive disclosure to efficiently manage context. | Not ZDR eligible | † | +| [Fine-grained tool streaming](https://platform.claude.com/docs/en/agents-and-tools/tool-use/fine-grained-tool-streaming) | Stream tool use parameters without buffering/JSON validation, reducing latency for receiving large parameters. | ZDR eligible | | +| [MCP connector](https://platform.claude.com/docs/en/agents-and-tools/mcp-connector) | Connect to remote [MCP](https://platform.claude.com/docs/en/mcp) servers directly from the Messages API without a separate MCP client. | Not ZDR eligible | | +| [Programmatic tool calling](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling) | Enable Claude to call your tools programmatically from within code execution containers, reducing latency and token consumption for multi-tool workflows. | Not ZDR eligible | † | +| [Tool search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool) | Scale to thousands of tools by dynamically discovering and loading tools on-demand using regex- and BM25-based search, optimizing context usage and improving tool selection accuracy. | ZDR eligible | | ## Context management diff --git a/content/en/build-with-claude/prompt-engineering/prompting-claude-opus-4-8.md b/content/en/build-with-claude/prompt-engineering/prompting-claude-opus-4-8.md index afb4c133e..171ffd921 100644 --- a/content/en/build-with-claude/prompt-engineering/prompting-claude-opus-4-8.md +++ b/content/en/build-with-claude/prompt-engineering/prompting-claude-opus-4-8.md @@ -157,6 +157,6 @@ Iterate on prompts against a subset of your evals or test cases to validate reca ## Computer use -On the Claude API, Claude Opus 4.8 supports the `computer_toolset_20260801` toolset and the earlier `computer_20251124` tool version. For tasks inside webpages, Claude Opus 4.8 also supports the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) (`browser_toolset_20260801`). [Computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) capability works across resolutions, up to a maximum resolution of 2576px / 3.75MP. Internal computer use testing shows that sending images at 1080p provides a good balance of performance and cost. +Claude Opus 4.8 supports the `computer_toolset_20260801` toolset (on the Claude API and Google Cloud) and the earlier `computer_20251124` tool version. For tasks inside webpages, Claude Opus 4.8 also supports the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) (`browser_toolset_20260801`). [Computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) capability works across resolutions, up to a maximum resolution of 2576px / 3.75MP. Internal computer use testing shows that sending images at 1080p provides a good balance of performance and cost. For particularly cost-sensitive workloads, 720p or 1366×768 are lower-cost options with strong performance. Conduct your own testing to find the ideal settings for your use case; experimenting with effort settings can also help tune the model's behavior. diff --git a/content/en/build-with-claude/prompt-engineering/prompting-claude-sonnet-5.md b/content/en/build-with-claude/prompt-engineering/prompting-claude-sonnet-5.md index 7442e48a8..ffb813edf 100644 --- a/content/en/build-with-claude/prompt-engineering/prompting-claude-sonnet-5.md +++ b/content/en/build-with-claude/prompt-engineering/prompting-claude-sonnet-5.md @@ -153,6 +153,6 @@ Iterate on prompts against a subset of your evals or test cases to validate reca ## Computer use -On the Claude API, Claude Sonnet 5 supports the `computer_toolset_20260801` toolset and the earlier `computer_20251124` tool version. For tasks inside webpages, Claude Sonnet 5 also supports the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) (`browser_toolset_20260801`). [Computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) capability works across resolutions, up to a maximum resolution of 2576px / 3.75MP. Internal computer use testing shows that sending images at 1080p provides a good balance of performance and cost. +Claude Sonnet 5 supports the `computer_toolset_20260801` toolset (on the Claude API and Google Cloud) and the earlier `computer_20251124` tool version. For tasks inside webpages, Claude Sonnet 5 also supports the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) (`browser_toolset_20260801`). [Computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) capability works across resolutions, up to a maximum resolution of 2576px / 3.75MP. Internal computer use testing shows that sending images at 1080p provides a good balance of performance and cost. For particularly cost-sensitive workloads, 720p or 1366×768 are lower-cost options with strong performance. Conduct your own testing to find the ideal settings for your use case; experimenting with effort settings can also help tune the model's behavior. diff --git a/content/en/build-with-claude/structured-outputs.md b/content/en/build-with-claude/structured-outputs.md index 7162683d3..e1fa84959 100644 --- a/content/en/build-with-claude/structured-outputs.md +++ b/content/en/build-with-claude/structured-outputs.md @@ -7,9 +7,8 @@ description: Get validated JSON results from agent workflows ## Compatibility - [ZDR](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention): eligible (excludes [Covered Models](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#model-specific-data-retention-requirements)) - Supported models: `claude-fable-5`, `claude-mythos-5`, `claude-mythos-preview`, `claude-opus-5`, `claude-opus-4-8`, `claude-opus-4-7`, `claude-opus-4-6`, `claude-sonnet-5`, `claude-sonnet-4-6`, `claude-sonnet-4-5-20250929`, `claude-opus-4-5-20251101`, `claude-haiku-4-5-20251001` -- Platforms: Claude API, Claude Platform on AWS, Amazon Bedrock [1], Google Cloud, Microsoft Foundry [2] +- Platforms: Claude API, Claude Platform on AWS, Amazon Bedrock [1], Google Cloud, Microsoft Foundry 1. On Amazon Bedrock, structured outputs are available for Claude Opus 4.6, Claude Sonnet 4.6, Claude Sonnet 4.5, Claude Opus 4.5, and Claude Haiku 4.5. -2. On [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry), structured outputs require a [Hosted on Anthropic deployment](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#additional-features-not-supported-when-hosted-on-azure). Structured outputs constrain Claude's responses to follow a specific schema, ensuring valid, parseable output for downstream processing. Structured outputs provide two complementary features: diff --git a/content/en/docs/claude-code/agent-sdk/python.md b/content/en/docs/claude-code/agent-sdk/python.md index 7a8299f32..ca46b9a44 100644 --- a/content/en/docs/claude-code/agent-sdk/python.md +++ b/content/en/docs/claude-code/agent-sdk/python.md @@ -1859,7 +1859,7 @@ class ClaudeSDKError(Exception): """Base error for Claude SDK.""" ``` -When a single-shot `query()` ends with an error result, for example a turn-limit error, the SDK raises a plain `Exception` after yielding the final result message, not a `ClaudeSDKError` subclass. +When a single-shot `query()` ends with an error result, for example a turn-limit error, the SDK raises a [`ResultError`](#resulterror) after yielding the final result message. Python Agent SDK versions before 0.2.140 raised a plain `Exception` that wasn't a `ClaudeSDKError` subclass. ### `CLINotFoundError` @@ -1899,6 +1899,21 @@ class ProcessError(ClaudeSDKError): self.stderr = stderr ``` +### `ResultError` + +Raised after the final [`ResultMessage`](#resultmessage) when the Claude Code process exits because the run ended with an error result, such as a turn-limit error or an API error. `ResultError` subclasses `ProcessError`, so an existing `except ProcessError` handler also catches it. Its attributes carry the fields of that result message, so you can branch on why the run failed without parsing the message text. Requires Python Agent SDK 0.2.140 or later. + +```python theme={null} +class ResultError(ProcessError): + subtype: str | None # for example "error_max_turns" or "error_during_execution" + errors: list[str] # an empty list when the result message reported none + result: str | None + api_error_status: int | None + terminal_reason: str | None # for example "max_turns" or "api_error" + session_id: str | None + data: dict[str, Any] # the raw result message payload +``` + ### `CLIJSONDecodeError` Raised when JSON parsing fails. @@ -3351,10 +3366,18 @@ asyncio.run(create_project()) ### Error handling +This example catches [`ResultError`](#resulterror), which requires Python Agent SDK 0.2.140 or later. + ```python theme={null} import asyncio -from claude_agent_sdk import query, CLINotFoundError, ProcessError, CLIJSONDecodeError +from claude_agent_sdk import ( + query, + CLINotFoundError, + ProcessError, + ResultError, + CLIJSONDecodeError, +) async def main(): @@ -3365,13 +3388,14 @@ async def main(): print( "Claude Code CLI not found. Try reinstalling: pip install --force-reinstall claude-agent-sdk" ) + # Catch ResultError before ProcessError, which it subclasses. Its message + # carries the error text; branch on e.subtype or e.terminal_reason. + except ResultError as e: + print(f"Query ended with an error result ({e.subtype}): {e}") except ProcessError as e: print(f"Process failed with exit code: {e.exit_code}") except CLIJSONDecodeError as e: print(f"Failed to parse response: {e}") - # A single-shot query() raises a plain Exception after yielding an error result - except Exception as e: - print(f"Query ended with an error result: {e}") asyncio.run(main()) diff --git a/content/en/docs/claude-code/agent-sdk/streaming-vs-single-mode.md b/content/en/docs/claude-code/agent-sdk/streaming-vs-single-mode.md index 6f1d20169..9a6a03bb2 100644 --- a/content/en/docs/claude-code/agent-sdk/streaming-vs-single-mode.md +++ b/content/en/docs/claude-code/agent-sdk/streaming-vs-single-mode.md @@ -276,7 +276,7 @@ If a query ends with an error result, such as `error_max_turns`, a single messag async def single_message_example(): # Simple one-shot query using query() function - # query() raises after an error result, such as error_max_turns + # query() raises ResultError after an error result, such as error_max_turns try: async for message in query( prompt="Explain the authentication flow", @@ -284,7 +284,6 @@ If a query ends with an error result, such as `error_max_turns`, a single messag ): if isinstance(message, ResultMessage) and message.subtype == "success": print(message.result) - # The SDK raises a plain Exception for error results, so match Exception here except Exception as e: print(f"Query failed: {e}") diff --git a/content/en/docs/claude-code/agent-view.md b/content/en/docs/claude-code/agent-view.md index 5f22a6a63..d84892986 100644 --- a/content/en/docs/claude-code/agent-view.md +++ b/content/en/docs/claude-code/agent-view.md @@ -774,6 +774,26 @@ In agent view, opening that row shows `Press enter again to restart this session The original conversation is intact; resume it with `claude --resume` or keep working in it. See the [error reference](/docs/en/errors#this-session-has-no-saved-transcript) for details. +### The terminal host died or the session stopped responding + +The [supervisor](#the-supervisor-process) runs each background session's terminal in its own host process. When that process dies or stops responding, Claude Code shows the reason and offers a restart; in both cases the conversation is saved and the restart resumes it. The [error reference](/docs/en/errors#terminal-host-process-died) quotes the full messages. + +Claude Code never restarts a row running a [shell command](#run-a-shell-command), from `Enter` or from `claude attach`, because that would run the command again; the row's message and `claude attach` both say the command isn't run again. + +#### Terminal host died + +On Linux and WSL, the supervisor checks each host process every few seconds, whether or not you open the session, and marks the session failed when the process has exited but its connection to the supervisor never closed. + +* In agent view, the row shows `terminal host process died — press Enter to restart`. Press `Enter` on it and Claude Code restarts the session on a fresh host process. +* From the shell, `claude attach ` restarts a session already marked failed. Otherwise it reports the cause and exits, telling you to run `claude attach ` again. + +#### Session isn't responding + +When the supervisor accepts an open but no output arrives for about ten seconds, Claude Code ends the attempt and offers a restart. A session that merely stalled, for example across machine sleep, doesn't reach this offer: the supervisor [restarts it on open](#read-session-state) itself. + +* In agent view, the footer shows `Press enter again to restart this session — it isn't responding (its conversation is saved and resumes).` Press `Enter` on the same row again and Claude Code stops the unresponsive process and restarts the session; it stops nothing without that second press. +* From the shell, `claude attach ` reports the cause and exits, telling you to run `claude stop `, then `claude attach `. + ### A session fails before starting with a `possibly low memory` note When a background session's process exits before it finishes starting and the host is low on memory, the row's status names the exit and adds `possibly low memory — free some up and retry`. @@ -854,6 +874,7 @@ Agent view has evolved quickly during research preview. If you are on an older C | Version | Change | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| v2.1.247 | On Linux and WSL, a session [whose terminal host process died](#the-terminal-host-died-or-the-session-stopped-responding) fails within seconds with the reason. An open that produces no output ends after about ten seconds with a restart offer, and `Enter` on the row restarts the session with its conversation; `claude attach ` reports the cause and exits. Before this release, opening such a session showed `opening… · esc to cancel` indefinitely and `claude attach ` waited without reporting an error. | | v2.1.239 | With [vim editor mode](/docs/en/interactive-mode#vim-editor-mode) on, pressing `Esc` in agent view's input switches from INSERT to NORMAL mode and keeps your text, matching the main prompt; in NORMAL mode with text still in the input, pressing `Esc` clears it, and pressing `Esc` on an empty input exits, as the [`Esc` shortcut](#keyboard-shortcuts) describes. Before this release, `Esc` cleared the input. | | v2.1.233 | For a session linked to a GitLab merge request, Claude Code writes the row's label in GitLab's `!1234` reference syntax. You can also paste the merge request's URL into the [dispatch input](#filter-sessions) to select that session. Before this release, the label rendered as `#1234`, and a pasted merge request URL matched a session only when its first prompt contained the URL. | | v2.1.227 | [Deleting a session](#what-deleting-a-session-removes) keeps the session and its worktree while another live Claude Code session is running inside that worktree directory. Agent view shows `not deleted` on the row and the reason in the footer, and `claude rm` prints `kept ` with the reason, which names the other session's process ID. Before this release, deleting the session removed the worktree while the other session was still working in it. | diff --git a/content/en/docs/claude-code/best-practices.md b/content/en/docs/claude-code/best-practices.md index 30167a1f0..9a9b1358f 100644 --- a/content/en/docs/claude-code/best-practices.md +++ b/content/en/docs/claude-code/best-practices.md @@ -498,7 +498,7 @@ For large migrations or analyses, you can distribute work across many parallel C ```bash theme={null} for file in $(cat files.txt); do - claude -p "Migrate $file from React to Vue. Return OK or FAIL." \ + claude -p "Migrate $file from Python 2 to Python 3. Return OK or FAIL." \ --allowedTools "Edit,Bash(git commit *)" done ``` diff --git a/content/en/docs/claude-code/changelog.md b/content/en/docs/claude-code/changelog.md index dfb814a86..23b47b394 100644 --- a/content/en/docs/claude-code/changelog.md +++ b/content/en/docs/claude-code/changelog.md @@ -10,6 +10,42 @@ This page is generated from the [CHANGELOG.md on GitHub](https://github.com/anth Run `claude --version` to check your installed version. + + * Added the `SendFeedback` tool: when something goes wrong in a session, Claude can draft a feedback report for you to review and send from `/feedback` (turn off with the `feedbackDrafts` setting) + * Added `{id, text, cooldownSessions, priority}` entries, `tipsFile`, and `label` to `spinnerTipsOverride`, so organizations can rotate their own tips alongside the built-in ones + * Added a tip on Bash permission prompts pointing to auto mode, with a one-keystroke "Yes, and switch to auto mode" option + * Added `/claude-api cost-optimize` to profile an existing project's Claude API spend and work through cost levers (caching, token hygiene, batch, effort, model choice) one measured change at a time + * Updated the `/claude-api` skill with Admin API coverage (organization members, invites, workspaces, API keys, rate limit reports, workload identity federation, CMEK) + * Fixed fast arrow-key + Enter sequences acting on the row above the one you navigated to in history search, `/config`, `/mcp`, `/skills`, background tasks, and `/model` + * Fixed sub-agents dying on a first-call model 404: they now use the session's fallback model chain, and the error returned to the parent includes the error type, status, request id, and model + * Fixed a hook or background agent that printed megabytes of error output being able to overflow the conversation and wedge the session on "Prompt is too long" + * Fixed Ctrl keyboard shortcuts not firing under non-Latin (e.g. Cyrillic) keyboard layouts in kitty-protocol terminals + * Fixed text like `<35;150;7M` being inserted into the prompt when a mouse report arrived split across reads right after the escape prefix + * Fixed the Bash sandbox's after-command cleanup deleting a dotfile-managed `~/.claude/settings.json` symlink (nix/home-manager, stow) when it is repointed outside the sandbox's writable area + * Fixed `/terminal-setup` overwriting your entire Zed `keymap.json` instead of merging in its keybinding + * Fixed `/rename` silently confirming when the session registry could not be updated; it now says other sessions may still show the old name + * Fixed `/compact` and "Summarize from here" in sessions started with `--agent` summarizing under the default system prompt instead of the conversation's own + * Fixed a background session showing "opening…" forever in `claude agents` after its terminal host process died; the row now fails within seconds with the reason, and Enter restarts it + * Fixed unbounded memory growth when a hook's or background task's output file could not be written; the file now notes where output was lost + * Fixed `/install-github-app` over SSH: the copy shortcut now says how the sign-in URL was copied instead of always claiming success, and the URL appears immediately when no browser can open + * Fixed shell commands carried over from the foreground logging an internal error or showing a misleading `[exited with code -1]` line when they finish in background sessions + * Fixed a version-less marketplace plugin's live cache directory being deleted and recreated on a second-scope install, which could disrupt a running session using it + * Fixed Remote Control sessions started with `/remote-control` not reporting the working-tree diff to connected clients + * Fixed self-hosted runner sessions reporting `running` before Claude Code had started, which could trigger a premature "Claude is waiting for your input" notification from the Claude desktop app + * Fixed first-run setup exiting with "Unable to connect to Anthropic services" when managed settings configure Claude apps gateway sign-in and Anthropic endpoints are unreachable + * Fixed cloud sessions (Claude Code on the web, desktop and mobile apps) sometimes showing the previous permission mode when you switch modes right after sending a message + * Fixed cloud sessions going silent when the session's container restarts between turns while a background agent, shell, or monitor is still running — the resumed session now reports the lost work + * Improved plugin marketplace hardening: names containing control or invisible characters are rejected, and marketplace-supplied text in `/plugin` and `claude plugin` output is escape-safe + * Improved Bedrock, Vertex, and Foundry sessions (and any with telemetry disabled): Claude is now told when a configured MCP server failed to connect, instead of concluding its tools don't exist + * Changed Sonnet 5's default auto-compact window to its full 1M context, so sessions on the 1M window now auto-compact at about 967K tokens instead of about 934K + * Changed cross-session peer messages to collapse by default to a one-line `Message from @: ` preview; Ctrl+O expands the full body + * Changed terminal hyperlinks in rendered markdown: link targets that point at a network or automounter path, contain a control character, or lead with an invisible character now render as plain text + * Changed the prompt-footer PR badge to skip its GitHub re-check on terminal refocus when the last check is under a minute old + * Changed analytics to stay off from startup, not only after login, when managed settings force gateway login or a custom OAuth deployment is configured + * Changed Claude apps gateway sign-in requests to identify Claude Code (a `surface=claude_code` device-authorization parameter and a `claude-code/` User-Agent) + * Changed organization sign-in enforcement to exit at start when the administrator's managed settings cannot be read, even if host-supplied or per-user Windows registry settings exist + + * Added a startup warning for Bash allow rules with a wildcard before the subcommand (e.g. `Bash(git * main)`), since they also match options inserted before the subcommand * Added an Auto mode tab to `/permissions` for viewing and editing auto mode classifier rules diff --git a/content/en/docs/claude-code/chrome.md b/content/en/docs/claude-code/chrome.md index 89a301bb0..baf2af5f8 100644 --- a/content/en/docs/claude-code/chrome.md +++ b/content/en/docs/claude-code/chrome.md @@ -284,12 +284,12 @@ On Windows, you may encounter: These are the most frequently encountered errors and how to resolve them: -| Error | Cause | Fix | -| ------------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| "Browser extension is not connected" | Native messaging host cannot reach the extension | Restart Chrome and Claude Code, then run `/chrome` to reconnect | -| Extension shows "Not detected" in `/chrome` | Chrome extension is not installed or is disabled | Install or enable the extension in `chrome://extensions` | -| "No tab available" | Claude tried to act before a tab was ready | Ask Claude to create a new tab and retry | -| "Receiving end does not exist" | Extension service worker went idle | Run `/chrome` and select "Reconnect extension" | +| Error | Cause | Fix | +| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| "Browser extension is not connected" | Native messaging host cannot reach the extension, or your organization's IP allowlist rejects the connection to `bridge.claudeusercontent.com` | Restart Chrome and Claude Code, then run `/chrome` to reconnect. If your organization uses IP allowlisting and the error persists, see [Organization IP allowlists and proxy egress](/docs/en/network-config#organization-ip-allowlists-and-proxy-egress) | +| Extension shows "Not detected" in `/chrome` | Chrome extension is not installed or is disabled | Install or enable the extension in `chrome://extensions` | +| "No tab available" | Claude tried to act before a tab was ready | Ask Claude to create a new tab and retry | +| "Receiving end does not exist" | Extension service worker went idle | Run `/chrome` and select "Reconnect extension" | ## See also diff --git a/content/en/docs/claude-code/claude-code-on-the-web.md b/content/en/docs/claude-code/claude-code-on-the-web.md index 41478835d..b535f5cae 100644 --- a/content/en/docs/claude-code/claude-code-on-the-web.md +++ b/content/en/docs/claude-code/claude-code-on-the-web.md @@ -28,7 +28,7 @@ This page covers the web product itself: ## Cloud environments -Every cloud session runs in a [cloud environment](/docs/en/cloud-environments), the saved configuration that controls network access, environment variables, and setup scripts. If you don't have an environment yet when you onboard, Claude Code sets up a **Default** environment with [**Trusted** network access](/docs/en/cloud-environments#access-levels). See [The Default environment](/docs/en/cloud-environments#the-default-environment) for how it's created and how sessions choose an environment when you have more than one. +Every cloud session runs in a [cloud environment](/docs/en/cloud-environments), the saved configuration that controls network access, environment variables, and setup scripts. If you don't have an environment yet, onboarding sets up a **Default** environment with [**Trusted** network access](/docs/en/cloud-environments#access-levels), either by creating it for you or by asking you to create it. See [The Default environment](/docs/en/cloud-environments#the-default-environment) for which of those happens on your plan and how sessions choose an environment when you have more than one. The same environments apply wherever you start a cloud session: the web, the terminal, [Claude Tag](https://claude.com/docs/claude-tag/overview), [routines](/docs/en/routines), and the mobile and Desktop apps. Claude Tag channel sessions use [organization-shared environments](/docs/en/cloud-environments#organization-shared-environments) only. @@ -49,7 +49,7 @@ Cloud sessions need access to your GitHub repositories to clone code and push br Either method works. [`/schedule`](/docs/en/routines) checks for either form of access and prompts you to run `/web-setup` if neither is configured. See [Connect from your terminal](/docs/en/web-quickstart#connect-from-your-terminal) for the `/web-setup` walkthrough. -Team and Enterprise Owners can disable `/web-setup` with the Quick web setup toggle at [claude.ai/admin-settings/claude-code](https://claude.ai/admin-settings/claude-code). +Quick web setup is an organization setting that lets members connect GitHub with `/web-setup`, skips the Claude GitHub App install prompt during browser onboarding, and has browser onboarding create the [**Default** environment](/docs/en/cloud-environments#the-default-environment) for them instead of showing the environment form. On Team and Enterprise plans it's off by default, which hides `/web-setup`. An [Owner](/docs/en/server-managed-settings#access-control) turns it on with the **Quick web setup** toggle at [**Admin settings > Claude Code**](https://claude.ai/admin-settings/claude-code). Organizations with [Zero Data Retention](/docs/en/zero-data-retention) enabled can't use `/web-setup` or other cloud session features. @@ -268,7 +268,7 @@ You will be asked to confirm before a session is deleted. Claude can watch a pull request and automatically respond to CI failures and review comments. Claude subscribes to GitHub activity on the PR, and when a check fails or a reviewer leaves a comment, Claude investigates and pushes a fix if one is clear. - Auto-fix requires the Claude GitHub App to be installed on your repository. If you haven't already, install it from the [GitHub App page](https://github.com/apps/claude) or when prompted during [setup](/docs/en/web-quickstart#connect-github). + Auto-fix requires the Claude GitHub App to be installed on your repository. If you haven't already, install it from the [GitHub App page](https://github.com/apps/claude). There are a few ways to turn on auto-fix depending on where the PR came from and what device you're using: diff --git a/content/en/docs/claude-code/claude-directory.md b/content/en/docs/claude-code/claude-directory.md index ca04832f6..0452377cb 100644 --- a/content/en/docs/claude-code/claude-directory.md +++ b/content/en/docs/claude-code/claude-directory.md @@ -1534,6 +1534,7 @@ Claude Code deletes the files in the paths below once they're older than [`clean | `shell-snapshots/` | Aliases, functions, and shell options captured at startup and applied by the [Bash tool](/docs/en/tools-reference#bash-tool-behavior) to each command. Removed on clean exit. The sweep clears any left after a crash. | | `backups/` | Earlier versions of `~/.claude.json`, copied when Claude Code rewrites the file. Claude Code keeps the five newest, plus a copy of any version it couldn't parse. | | `feedback-bundles/` | Redacted transcript archives written by `/feedback` on third-party providers or when no Anthropic credentials are configured, for sending to your Anthropic account team | +| `feedback/drafts/` | Queued [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior) awaiting your review in `/feedback`. Swept after `cleanupPeriodDays` or 30 days, whichever is shorter. When the queue is at its 10-draft limit, Claude Code deletes the oldest draft to make room. | | `usage-data/` | `report.html` and timestamped report copies written by [`/insights`](/docs/en/costs#analyze-your-usage-patterns), plus cached per-session analysis data used to build them | | `todos/`, `statsig/`, `logs/` | Legacy directories from older versions. No longer written. The sweep removes their contents and then the empty directory. | @@ -1634,6 +1635,7 @@ You can also delete any of the application-data paths above by hand. New session | `~/.claude/stats-cache.json` | Historical totals shown by `/usage` | | `~/.claude/usage-data/` | Past [`/insights`](/docs/en/costs#analyze-your-usage-patterns) reports and the cached analysis data used to build them | | `~/.claude/feedback-bundles/` | Feedback and bug-report archives you haven't yet sent to your Anthropic account team | +| `~/.claude/feedback/drafts/` | [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior) you haven't sent | | `~/.claude/remote-settings.json` | Nothing. Re-fetched on next launch. | | `~/.claude/cache/changelog.md` | Nothing. Refreshed in the background. | | `~/.claude/policy-limits.json` | Nothing. Refreshed automatically. | diff --git a/content/en/docs/claude-code/cloud-environments.md b/content/en/docs/claude-code/cloud-environments.md index bb0b1db0a..61b5d5ed1 100644 --- a/content/en/docs/claude-code/cloud-environments.md +++ b/content/en/docs/claude-code/cloud-environments.md @@ -20,7 +20,13 @@ The same environments apply wherever you start a cloud session: [Claude Code on ## The Default environment -If you don't have an environment yet, onboarding sets up the **Default** environment for you, whether you connect through [the web](/docs/en/web-quickstart#connect-github) or a CLI flow such as `/web-setup`; if web onboarding shows an environment form instead of creating the environment, keep the form's defaults to get the same **Default** environment. **Default** carries no configuration of its own: +If you don't have an environment yet, onboarding sets up the **Default** environment. How depends on where you onboard: + +* **CLI flows such as `/web-setup`**: create **Default** for you +* **Web onboarding on Pro and Max**: creates **Default** for you +* **Web onboarding on Team and Enterprise**: shows a **Create your first cloud environment** form unless an Owner has turned on [Quick web setup](/docs/en/claude-code-on-the-web#github-authentication-options); keep the form's defaults and click **Create & finish** to get the same **Default** environment + +**Default** carries no configuration of its own: * [**Trusted** network access](#access-levels): sessions reach package registries and other [allowlisted domains](#default-allowed-domains), and nothing else through the session's network. * No other configuration: **Default** defines no environment variables or setup script, so sessions start with just the [pre-installed tools](#installed-tools). diff --git a/content/en/docs/claude-code/code-review.md b/content/en/docs/claude-code/code-review.md index 6810a6a24..552c8004e 100644 --- a/content/en/docs/claude-code/code-review.md +++ b/content/en/docs/claude-code/code-review.md @@ -104,7 +104,9 @@ An Owner enables Code Review once for the organization and selects which reposit * **Once after PR creation**: review runs once when a PR is opened or marked ready for review * **After every push**: review runs on every push to the PR branch, catching new issues as the PR evolves and auto-resolving threads when you fix flagged issues - * **Manual**: reviews start only when someone [comments `@claude review` on a PR](#manually-trigger-reviews); `@claude review always` starts a review and subscribes the PR to reviews on subsequent pushes + * **Manual**: opening or pushing to a PR doesn't start a review; comment [`@claude review`](#manually-trigger-reviews) to request one, or `@claude review always` to also subscribe the PR to reviews on subsequent pushes + + Whichever option you choose, Claude reviews a [pull request from a fork](#review-pull-requests-from-forks) only when someone comments `@claude review` on it. Reviewing on every push runs the most reviews and costs the most. Manual mode is useful for high-traffic repos where you want to opt specific PRs into review, or to only start reviewing your PRs once they're ready. @@ -134,13 +136,24 @@ For any of these commands to trigger a review: * Post it as a top-level PR comment, not an inline comment on a diff line * Put the command at the start of the comment, with `once` or `always` on the same line as the rest of the command -* You must have owner, member, or collaborator access to the repository +* You must have write, maintain, or admin permission on the repository * The PR must be open +If the repository belongs to an organization and your membership in that organization is private, which is GitHub's default, GitHub doesn't identify you to Claude as a member. Claude may still react to your comment with 👀, but it doesn't start a review unless you were added to the repository directly as a collaborator, even when a team or the organization's base permissions give you write access. To fix this, [make your organization membership public](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership) or ask a repository admin to add you to the repository as a collaborator. + Unlike automatic triggers, manual triggers run on draft PRs, since an explicit request signals you want the review now regardless of draft status. If a review is already running on that PR, the request is queued until the in-progress review completes. You can monitor progress via the check run on the PR. +### Review pull requests from forks + +Claude doesn't review a pull request from a fork automatically, regardless of the repository's **Review Behavior** setting. To start one, comment `@claude review` on the pull request. The [requirements for comment commands](#manually-trigger-reviews) still apply, and the write access you need is to the base repository, not the fork. + +To get another review of a fork pull request, post a new `@claude review` comment. `@claude review always` works too, but doesn't subscribe the pull request to reviews on later pushes. Nothing other than a comment command starts a review on a fork pull request: + +* Clicking **Re-run** on the check run doesn't start a review +* Pushing new commits doesn't start a review, even in a repository set to **After every push** + ## Customize reviews Code Review reads two files from your repository to guide what it flags. They differ in how strongly they influence the review: @@ -240,9 +253,9 @@ The review trigger you choose affects total cost: * **Once after PR creation**: runs once per PR * **After every push**: runs on each push, multiplying cost by the number of pushes -* **Manual**: no reviews until someone comments `@claude review` on a PR +* **Manual**: no reviews on open or push, so cost accrues only from reviews someone requests -In Once after PR creation or Manual mode, commenting `@claude review always` [opts the PR into push-triggered reviews](#manually-trigger-reviews), so additional cost accrues per push after that comment. In After every push mode, pushes already trigger reviews, so the subscription doesn't change per-push cost. Commenting `@claude review` runs a single review without subscribing to future pushes. +In Once after PR creation or Manual mode, commenting `@claude review always` [opts the PR into push-triggered reviews](#manually-trigger-reviews), so additional cost accrues per push after that comment. In After every push mode, pushes already trigger reviews, so the subscription doesn't change per-push cost. Commenting `@claude review` runs a single review without subscribing to future pushes. Claude reviews a [pull request from a fork](#review-pull-requests-from-forks) only when someone comments `@claude review`, so a fork pull request never accrues per-push cost in any mode. Costs appear on your Anthropic bill regardless of whether your organization uses Amazon Bedrock or Google Cloud's Agent Platform for other Claude Code features. To set a monthly spend cap for Code Review, go to [claude.ai/admin-settings/usage](https://claude.ai/admin-settings/usage) and configure the limit for the Claude Code Review service. @@ -256,9 +269,7 @@ Review runs are best-effort. A failed run never blocks your PR, but it also does When the review infrastructure hits an internal error or exceeds its time limit, the check run completes with a title of **Code review encountered an error** or **Code review timed out**. The conclusion is still neutral, so nothing blocks your merge, but no findings are posted. -To run the review again, comment `@claude review` on the PR. This starts a fresh review without subscribing the PR to future pushes. If the PR is already subscribed to push-triggered reviews, pushing a new commit also starts a new review. - -The **Re-run** button in GitHub's Checks tab does not retrigger Code Review. Use the comment command or a new push instead. +To run the review again, comment `@claude review` on the PR. This starts a fresh review without subscribing the PR to future pushes. If the PR isn't [from a fork](#review-pull-requests-from-forks), you can instead click **Re-run** on the **Claude Code Review** check in GitHub's Checks tab. A re-run also starts a fresh review without subscribing the PR. ### Review didn't run and the PR shows a spend-cap message diff --git a/content/en/docs/claude-code/commands.md b/content/en/docs/claude-code/commands.md index 5d9dcdaff..32dbe2572 100644 --- a/content/en/docs/claude-code/commands.md +++ b/content/en/docs/claude-code/commands.md @@ -57,7 +57,7 @@ In the table below, `` indicates a required argument and `[arg]` indicates | `/autocompact [auto\|]` | Set the auto-compact window: how full the context window gets before Claude Code compacts automatically. Pass a size such as `500k`, or `auto` to return to the window tuned for your model. Claude Code saves the value to user settings and applies it to the current session. See [Set the auto-compact window](/docs/en/model-config#set-the-auto-compact-window) for accepted values and what overrides it. Without an argument, opens a dialog that shows the current window. Requires Claude Code v2.1.221 or later | | `/autofix-pr [prompt]` | Spawn a [Claude Code on the web](/docs/en/claude-code-on-the-web#auto-fix-pull-requests) session that watches the current branch's PR and pushes fixes when CI fails or reviewers leave comments. Detects the open PR from your checked-out branch with `gh pr view`; to watch a different PR, check out its branch first. By default the cloud session is told to fix every CI failure and review comment; pass a prompt to give it different instructions, for example `/autofix-pr only fix lint and type errors`. Requires the `gh` CLI and access to [Claude Code on the web](/docs/en/claude-code-on-the-web) | | `/background [prompt]` | Detach the current session to run as a [background agent](/docs/en/agent-view) and free this terminal. Pass a prompt to send one more instruction before detaching. Monitor the session with `claude agents`. To copy the conversation into a new background session while this one keeps running, use `/fork`. Alias: `/bg` | -| `/batch ` | **[Skill](/docs/en/skills#bundled-skills).** Orchestrate large-scale changes across a codebase in parallel. Researches the codebase, decomposes the work into 5 to 30 independent units, and presents a plan. Once approved, spawns one [background subagent](/docs/en/sub-agents#run-subagents-in-foreground-or-background) per unit in an isolated [git worktree](/docs/en/worktrees). Each subagent implements its unit, runs tests, and opens a pull request. Requires a git repository. Example: `/batch migrate src/ from Solid to React` | +| `/batch ` | **[Skill](/docs/en/skills#bundled-skills).** Orchestrate large-scale changes across a codebase in parallel. Researches the codebase, decomposes the work into 5 to 30 independent units, and presents a plan. Once approved, spawns one [background subagent](/docs/en/sub-agents#run-subagents-in-foreground-or-background) per unit in an isolated [git worktree](/docs/en/worktrees). Each subagent implements its unit, runs tests, and opens a pull request. Requires a git repository. Example: `/batch migrate src/ from JavaScript to TypeScript` | | `/branch [name]` | Create a branch of the current conversation at this point, so you can try a different direction without losing the conversation as it stands. Switches you into the branch and preserves the original, which you can return to with `/resume`. To run a copy as a separate [background session](/docs/en/agent-view) instead of switching into it, use `/fork`; to hand a side task to a [subagent](/docs/en/sub-agents) that reports back into this conversation, use `/subtask` | | `/btw [question]` | Ask a [side question](/docs/en/interactive-mode#side-questions-with-%2Fbtw) about the current session without adding to the conversation. If you run `/btw` without a question, Claude Code shows your most recent side question so you can browse earlier answers; if you haven't asked one yet, Claude Code prints a usage line. Before v2.1.212, `/btw` required a question | | `/bug [report]` | Report a bug or share your conversation. You choose how much session history to include and confirm on a consent screen before anything is sent. When you're signed in to Anthropic on a first-party connection, the report goes to Anthropic; on a third-party provider, or without Anthropic credentials, Claude Code writes the report to a [local archive under `~/.claude/feedback-bundles/`](/docs/en/data-usage#telemetry-services) that you forward yourself. In the [VS Code extension](/docs/en/vs-code#use-the-prompt-box), `/bug` opens the extension's own feedback dialog instead; requires Claude Code v2.1.229 or later. When you run it while Claude is responding, Claude Code opens the dialog immediately. Before v2.1.232, Claude Code queued the command until the turn finished. Alias: `/share`. Before v2.1.212, `/bug` and `/share` were aliases of `/feedback` | @@ -84,7 +84,7 @@ In the table below, `` indicates a required argument and `[arg]` indicates | `/exit` | Exit the CLI. In an attached [background session](/docs/en/agent-view#attach-to-a-session), this detaches and the session keeps running. Alias: `/quit` | | `/export [filename]` | Export the current conversation as plain text. With a filename, writes directly to that file. Without, opens a dialog to copy to clipboard or save to a file | | `/fast [on\|off]` | Toggle [fast mode](/docs/en/fast-mode) on or off. Availability in non-interactive mode with `-p` is limited; see [Toggle fast mode](/docs/en/fast-mode#toggle-fast-mode). Requires Claude Code v2.1.205 or later | -| `/feedback [report]` | Send product feedback about Claude Code. Opens the same dialog as [`/bug`](#all-commands), with the same consent step, sending rules, and mid-turn behavior | +| `/feedback [report]` | Send product feedback about Claude Code. Opens the same dialog as [`/bug`](#all-commands), with the same consent step, sending rules, and mid-turn behavior. In sessions with [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior), `/feedback` with no argument opens the drafts queue instead, where you review, edit, send, or discard the drafts Claude queued; the queue includes an option to write a new report in the dialog. With an argument, and for `/bug` always, the dialog opens directly | | `/fewer-permission-prompts` | **[Skill](/docs/en/skills#bundled-skills).** Scan your transcripts for common read-only Bash and MCP tool calls, then add a prioritized allowlist to project `.claude/settings.json` to reduce permission prompts | | `/focus` | Toggle the focus view, which shows only your last prompt, a one-line tool-call summary with edit diffstats, and the final response. The tool-call summary also counts the subagents launched in the turn and collapses completed background-task notifications into a single count. The selection persists across sessions; set [`viewMode`](/docs/en/settings-reference#viewmode) in settings to override it. Only available in [fullscreen rendering](/docs/en/fullscreen). The [VS Code extension](/docs/en/vs-code#use-the-prompt-box) offers its own Focus view as a command-menu toggle, stored as an extension setting, independent of `viewMode` | | `/fork [prompt]` | [Copy the current conversation](/docs/en/agent-view#copy-the-session-with-%2Ffork) into a new background session and keep working here. Pass a prompt and the copy starts working on it immediately; without one it waits in agent view for its first prompt. Except when the copy [edits in place](/docs/en/agent-view#how-file-edits-are-isolated), Claude Code instructs it to create a worktree of its own before making code changes; the isolation instruction requires Claude Code v2.1.221 or later. To hand a side task to a subagent whose result comes back into this conversation, use `/subtask`; to switch into a copy yourself, use `/branch`. Requires Claude Code v2.1.212 or later; on v2.1.161 through v2.1.211, and whenever [agent view is turned off](/docs/en/agent-view#turn-off-agent-view), `/fork` starts a [forked subagent](/docs/en/sub-agents#fork-the-current-conversation) instead | @@ -135,7 +135,7 @@ In the table below, `` indicates a required argument and `[arg]` indicates | `/setup-bedrock` | Configure [Amazon Bedrock](/docs/en/amazon-bedrock) authentication, region, and model pins through an interactive wizard. [Hidden from the command menu](#how-the-command-menu-matches-what-you-type) until `CLAUDE_CODE_USE_BEDROCK=1` is set; type it in full. First-time Amazon Bedrock users can also access this wizard from the login screen | | `/setup-vertex` | Configure [Google Cloud's Agent Platform](/docs/en/google-vertex-ai) authentication, project, region, and model pins through an interactive wizard. [Hidden from the command menu](#how-the-command-menu-matches-what-you-type) until `CLAUDE_CODE_USE_VERTEX=1` is set; type it in full. First-time Google Cloud's Agent Platform users can also access this wizard from the login screen | | `/simplify [target]` | **[Skill](/docs/en/skills#bundled-skills).** Review the changed code for cleanup opportunities and apply the fixes. Four review [agents](/docs/en/sub-agents) run in parallel, covering reuse of existing helpers, simplification, efficiency, and whether the change is at the right level of abstraction. From v2.1.154, the review doesn't look for correctness bugs. Use `/code-review` to find bugs. On earlier versions, `/simplify` is equivalent to `/code-review --fix`. Pass a path or PR reference to review a specific target | -| `/skills` | List available [skills](/docs/en/skills). Type to filter the list by name. Press `t` to sort by token count. Press `Space` to [cycle a skill's visibility to Claude and the `/` menu](/docs/en/skills#override-skill-visibility-from-settings) | +| `/skills` | List available [skills](/docs/en/skills). Type to filter the list by name, description, or source. Press `t` to sort by token count, `Space` or `Enter` to [cycle a skill's visibility to Claude and the `/` menu](/docs/en/skills#override-skill-visibility-from-settings), and `Esc` to save and close. You can't cycle plugin skills, skills whose frontmatter sets `disable-model-invocation: true`, or skills with a `skillOverrides` entry in managed settings or the `--settings` flag | | `/stats` | Alias for `/usage`. Opens on the Stats tab | | `/status` | Open the Settings interface on the Status tab, showing version, model, account, and connectivity. A `Session kind` row reads `background job · attached` or `background job · unattended` in a [background session](/docs/en/agent-view), depending on whether a terminal is attached, and `interactive` in any other session. Before v2.1.221, `/status` didn't show this row. Works while Claude is responding | | `/statusline` | Configure Claude Code's [status line](/docs/en/statusline). Describe what you want, or run without arguments to auto-configure from your shell prompt | diff --git a/content/en/docs/claude-code/data-usage.md b/content/en/docs/claude-code/data-usage.md index 925a3287a..790fdbf03 100644 --- a/content/en/docs/claude-code/data-usage.md +++ b/content/en/docs/claude-code/data-usage.md @@ -23,6 +23,8 @@ If you explicitly opt in to methods to provide us with materials to train on, su If you choose to send us feedback about Claude Code using the `/feedback` command, we may use your feedback to improve our products and services. Transcripts shared via `/feedback`, or via `/bug` and `/share`, which report through the same path, are retained for 5 years. +With [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior), Claude can also draft a feedback report and queue it on your machine for you to review. Claude Code sends nothing until you choose to send the draft, and a sent draft goes through the same submission path and retention as other `/feedback` reports. + ### Session quality surveys When you see the "How is Claude doing this session?" prompt in Claude Code, responding to this survey, including selecting "Dismiss", records only your rating. We do not collect or store any conversation transcripts, inputs, outputs, or other session data as part of the rating prompt itself. Unlike thumbs up/down feedback or `/feedback` reports, this session quality survey is a simple product satisfaction metric. @@ -110,7 +112,7 @@ Error reporting is on only when all of these apply: * you're connecting directly to the Claude API * your organization doesn't have a zero data retention or HIPAA agreement -When you run the `/feedback` command, a copy of your conversation history including code is sent to Anthropic. The `/bug` and `/share` commands submit through the same path. Before submitting, you choose how much history to include: the current session only, which is the default, or also other sessions from the same project over the last 24 hours or 7 days. The data is encrypted in transit via TLS and stored in Google Cloud Storage, which encrypts stored data at rest by default. Optionally, a GitHub issue is created in the public repository. To opt out, set the `DISABLE_FEEDBACK_COMMAND` environment variable to `1`. +When you run the `/feedback` command, a copy of your conversation history including code is sent to Anthropic. The `/bug` and `/share` commands submit through the same path. Before submitting a report from the feedback dialog, you choose how much history to include: the current session only, which is the default, or also other sessions from the same project over the last 24 hours or 7 days. Claude Code submits [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior) through the same path, including the transcript when you chose to include it on the draft's review screen. The data is encrypted in transit via TLS and stored in Google Cloud Storage, which encrypts stored data at rest by default. Optionally, a GitHub issue is created in the public repository. To opt out, set the `DISABLE_FEEDBACK_COMMAND` environment variable to `1`. When you use a third-party provider such as Amazon Bedrock or Google Cloud's Agent Platform, or have no Anthropic credentials configured, `/feedback` writes the report to a local archive under `~/.claude/feedback-bundles/` instead of sending it to Anthropic. Known API key and token patterns are redacted before the archive is written. Nothing leaves your machine until you send that file to your Anthropic account representative or attach it to a support request. diff --git a/content/en/docs/claude-code/desktop-changelog.md b/content/en/docs/claude-code/desktop-changelog.md index 1adf6eaa0..01c12225f 100644 --- a/content/en/docs/claude-code/desktop-changelog.md +++ b/content/en/docs/claude-code/desktop-changelog.md @@ -792,6 +792,10 @@ platform.claude.com *.claudemcpcontent.com ``` +If your organization has [IP allowlisting](https://support.claude.com/en/articles/13200993-restrict-access-to-claude-with-ip-allowlisting) enabled for Claude, route `bridge.claudeusercontent.com` through the same proxy egress as `claude.ai` and `api.anthropic.com`. If you can't route it that way, add the egress address your proxy uses for that host to your organization's IP allowlist, but only when that address is dedicated to your organization: a shared proxy egress range also admits the proxy vendor's other customers. + +Anthropic checks connections to that host against your organization's IP allowlist using the address they arrive from. If your proxy sends traffic for it out through an address that isn't on that allowlist, Claude in Chrome and other features that connect through the bridge stop working while the rest of the app keeps working. + An [artifact](/docs/en/artifacts) that loads a typeface from [Google Fonts](/docs/en/artifacts#improve-the-visual-design) also requests `fonts.googleapis.com` and `fonts.gstatic.com`. Both hosts are optional. If you block them, artifacts render in fallback typefaces. Block with a fast rejection rather than a silent drop so the font request fails immediately instead of delaying the page's first render. ### Authentication and SSO diff --git a/content/en/docs/claude-code/desktop.md b/content/en/docs/claude-code/desktop.md index 1adf6eaa0..01c12225f 100644 --- a/content/en/docs/claude-code/desktop.md +++ b/content/en/docs/claude-code/desktop.md @@ -792,6 +792,10 @@ platform.claude.com *.claudemcpcontent.com ``` +If your organization has [IP allowlisting](https://support.claude.com/en/articles/13200993-restrict-access-to-claude-with-ip-allowlisting) enabled for Claude, route `bridge.claudeusercontent.com` through the same proxy egress as `claude.ai` and `api.anthropic.com`. If you can't route it that way, add the egress address your proxy uses for that host to your organization's IP allowlist, but only when that address is dedicated to your organization: a shared proxy egress range also admits the proxy vendor's other customers. + +Anthropic checks connections to that host against your organization's IP allowlist using the address they arrive from. If your proxy sends traffic for it out through an address that isn't on that allowlist, Claude in Chrome and other features that connect through the bridge stop working while the rest of the app keeps working. + An [artifact](/docs/en/artifacts) that loads a typeface from [Google Fonts](/docs/en/artifacts#improve-the-visual-design) also requests `fonts.googleapis.com` and `fonts.gstatic.com`. Both hosts are optional. If you block them, artifacts render in fallback typefaces. Block with a fast rejection rather than a silent drop so the font request fails immediately instead of delaying the page's first render. ### Authentication and SSO diff --git a/content/en/docs/claude-code/discover-plugins.md b/content/en/docs/claude-code/discover-plugins.md index af245026c..262d97f6b 100644 --- a/content/en/docs/claude-code/discover-plugins.md +++ b/content/en/docs/claude-code/discover-plugins.md @@ -408,7 +408,7 @@ When the [install summary](#install-plugins) reports `Plugin is now active.`, Cl When the reload would invalidate the prompt cache, the command warns and skips until you rerun it with `--force`. -Claude Code reloads all active plugins and shows counts for plugins, skills, agents, hooks, plugin MCP servers, and plugin LSP servers. The skills count covers only each plugin's `commands/` directory, not its `skills/` directory, so the summary can report `0 skills` even when the plugin's skills reloaded. +Claude Code reloads all active plugins and shows counts for plugins, skills, agents, hooks, plugin MCP servers, and plugin LSP servers. In the skills count, Claude Code includes every skill a plugin provides: both its `commands/` entries and its `SKILL.md` skills. Before v2.1.246, Claude Code counted only `commands/` entries, so it could reload a plugin's `SKILL.md` skills and still report `0 skills` in the summary. Reloading has a token cost on the next request: newly loaded components announce themselves in content appended to the conversation, while the existing history still reads from the prompt cache. A plugin that provides MCP servers costs more when its tools aren't deferred by [tool search](/docs/en/mcp#scale-with-mcp-tool-search): the change invalidates the cache and the next request re-reads the entire conversation. See [enabling or disabling a plugin](/docs/en/prompt-caching#enabling-or-disabling-a-plugin) for details. diff --git a/content/en/docs/claude-code/env-vars.md b/content/en/docs/claude-code/env-vars.md index 9b133d411..07d2d90cd 100644 --- a/content/en/docs/claude-code/env-vars.md +++ b/content/en/docs/claude-code/env-vars.md @@ -249,7 +249,7 @@ Numeric variables such as timeouts, token budgets, and retry counts accept scien | `CLAUDE_CODE_DISABLE_MOUSE` | Set to `1` to disable mouse tracking in [fullscreen rendering](/docs/en/fullscreen). Keyboard scrolling with `PgUp` and `PgDn` still works. Use this to keep your terminal's native copy-on-select behavior | | `CLAUDE_CODE_DISABLE_MOUSE_CLICKS` | Set to `1` to disable click, drag, and hover handling in [fullscreen rendering](/docs/en/fullscreen) while keeping mouse-wheel scrolling. Use this when you want wheel scroll to work inside Claude Code but don't want clicks to position the cursor, expand tool output, or open links. `CLAUDE_CODE_DISABLE_MOUSE` takes precedence when both are set. Requires Claude Code v2.1.195 or later | | `CLAUDE_CODE_DISABLE_MTLS_RELOAD_ON_STALE_CONNECTION` | Set to `1` to stop Claude Code from re-reading the [mTLS client certificate and key](/docs/en/network-config#mtls-authentication) when an API request fails with a connection-level error, such as a connection reset or a TLS handshake error. With the reload disabled, Claude Code loads rotated files only when it next applies settings or at the next startup. Requires Claude Code v2.1.232 or later | -| `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | Set to any non-empty value, such as `1`, to disable nonessential network traffic: auto-updates, telemetry, error reporting, the `/feedback` command, release notes, [gateway model discovery](/docs/en/llm-gateway-connect#add-gateway-models-to-the-model-picker) refreshes, and availability checks such as the [fast mode](/docs/en/fast-mode#use-fast-mode-behind-proxies-and-llm-gateways) check. It also stops the [background runs of plugin `command` sources](/docs/en/plugin-marketplaces#when-claude-code-re-runs-the-command), which are local commands rather than network traffic, because they can trigger dependency installs. **Setting it to `0` or `false` still disables this traffic**, unlike most on/off variables; unset the variable to allow it again. Also disables feature-flag fetching, which makes [Remote Control](/docs/en/remote-control#requirements) and the other [features that need feature-flag fetching](#features-that-need-feature-flag-fetching) unavailable. Official plugin marketplace auto-install isn't covered; disable it with `CLAUDE_CODE_DISABLE_OFFICIAL_MARKETPLACE_AUTOINSTALL` | +| `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | Set to any non-empty value, such as `1`, to disable nonessential network traffic: auto-updates, telemetry, error reporting, the `/feedback` command, [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior), release notes, [gateway model discovery](/docs/en/llm-gateway-connect#add-gateway-models-to-the-model-picker) refreshes, and availability checks such as the [fast mode](/docs/en/fast-mode#use-fast-mode-behind-proxies-and-llm-gateways) check. It also stops the [background runs of plugin `command` sources](/docs/en/plugin-marketplaces#when-claude-code-re-runs-the-command), which are local commands rather than network traffic, because they can trigger dependency installs. **Setting it to `0` or `false` still disables this traffic**, unlike most on/off variables; unset the variable to allow it again. Also disables feature-flag fetching, which makes [Remote Control](/docs/en/remote-control#requirements) and the other [features that need feature-flag fetching](#features-that-need-feature-flag-fetching) unavailable. Official plugin marketplace auto-install isn't covered; disable it with `CLAUDE_CODE_DISABLE_OFFICIAL_MARKETPLACE_AUTOINSTALL` | | `CLAUDE_CODE_DISABLE_NONSTREAMING_FALLBACK` | Set to `1` to disable the non-streaming fallback when a streaming request fails mid-stream. Streaming errors propagate to the retry layer instead. Useful when a proxy or gateway causes the fallback to produce duplicate tool execution | | `CLAUDE_CODE_DISABLE_NOTIFICATION_PRESENCE_CHECK` | Set to `1` to send the `PushNotification` tool's desktop notification even while you are typing in or focused on the terminal. By default the tool skips both the desktop notification and the [mobile push](/docs/en/remote-control#mobile-push-notifications) when it detects recent keyboard activity or terminal focus. This variable disables only that local check, so the server can still suppress the mobile push when it detects that you are active. Requires Claude Code v2.1.193 or later | | `CLAUDE_CODE_DISABLE_OFFICIAL_MARKETPLACE_AUTOINSTALL` | Set to `1` to disable automatic registration of the official plugin marketplace. Claude Code reads the variable when it is about to register the marketplace, usually during a machine's first interactive launch. If the variable is set at that point, Claude Code skips the registration permanently. Unsetting the variable later doesn't undo the skip. Run `claude plugin marketplace add anthropics/claude-plugins-official` to register the marketplace at any time | @@ -341,6 +341,7 @@ Numeric variables such as timeouts, token budgets, and retry counts accept scien | `CLAUDE_CODE_SAFE_MODE` | Set to `1` to start in safe mode: CLAUDE.md, skills, plugins, hooks, MCP servers, custom commands and agents, output styles, workflows, custom themes, custom keybindings, status line and file-suggestion commands, LSP servers, and auto memory do not load, for troubleshooting a broken configuration. Managed settings policy still applies, including policy-configured hooks, status line, and file-suggestion commands; managed plugins, managed skills, managed CLAUDE.md, and policy-configured MCP servers do not. Equivalent to passing [`--safe-mode`](/docs/en/cli-reference#cli-flags). Directly spawned child processes inherit the variable | | `CLAUDE_CODE_SCRIPT_CAPS` | JSON object limiting how many times specific scripts may be invoked per session when `CLAUDE_CODE_SUBPROCESS_ENV_SCRUB` is set. Keys are substrings matched against the command text; values are integer call limits. For example, `{"deploy.sh": 2}` allows `deploy.sh` to be called at most twice. Matching is substring-based so shell-expansion tricks like `./scripts/deploy.sh $(evil)` still count against the cap. Runtime fan-out via `xargs` or `find -exec` is not detected; this is a defense-in-depth control | | `CLAUDE_CODE_SCROLL_SPEED` | Set the mouse wheel scroll multiplier in [fullscreen rendering](/docs/en/fullscreen#mouse-wheel-scrolling). Accepts any positive value up to 20, including fractional values below 1 such as `0.5` to slow accelerated trackpad and wheel scrolling in terminals that already amplify wheel events. Set to `3` to match `vim` if your terminal sends one wheel event per notch without amplification. Ignored in the JetBrains IDE terminal, where Claude Code uses its own scroll handling | +| `CLAUDE_CODE_SEND_FEEDBACK` | Set to `0` to turn off [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior) for a session. Set to `1` to turn it on where your account already has access; the variable can't grant access itself, and the other switches that turn feedback off, such as `DISABLE_FEEDBACK_COMMAND` and the [`feedbackDrafts`](/docs/en/settings-reference#feedbackdrafts) setting's `off` value, still apply | | `CLAUDE_CODE_SESSIONEND_HOOKS_TIMEOUT_MS` | Override the time budget in milliseconds for [SessionEnd](/docs/en/hooks#sessionend) hooks. Applies to session exit, `/clear`, and switching sessions via interactive `/resume`. By default the budget is 1.5 seconds, automatically raised to the highest per-hook `timeout` configured in settings files, up to 60 seconds. Timeouts on plugin-provided hooks do not raise the budget | | `CLAUDE_CODE_SESSION_ID` | Set automatically to the current session ID in Bash and PowerShell tool subprocesses, [hook command](/docs/en/hooks) subprocesses, and stdio [MCP server](/docs/en/mcp) subprocesses. For Bash, PowerShell, and hooks this matches the `session_id` field in the hook JSON input and is updated on `/clear`. An MCP server subprocess retains the ID it was spawned with. On `--resume ` it receives the resumed ID, matching hooks and Bash. On `--continue` or `--resume` without an explicit ID it may receive the initial startup ID instead. Use to correlate scripts and external tools with the Claude Code session that launched them | | `CLAUDE_CODE_SHELL` | Set the shell Claude Code uses to run Bash tool commands. Accepts a path to a `bash` or `zsh` binary, for example `/opt/homebrew/bin/bash`. Other shells such as `fish` are not supported. If the value is not a working `bash` or `zsh` path, Claude Code ignores it and falls back to auto-detection. Auto-detection uses your `$SHELL` when it points to `bash` or `zsh`, otherwise it picks the first working `zsh` then `bash` found on your `PATH` and standard install locations | @@ -400,7 +401,7 @@ Numeric variables such as timeouts, token budgets, and retry counts accept scien | `DISABLE_DOCTOR_COMMAND` | Set to `1` to hide the [`/doctor`](/docs/en/commands#all-commands) setup checkup skill and its `/checkup` alias. Useful for managed deployments where users shouldn't run setup diagnostics from a session. Doesn't affect the `claude doctor` terminal command. Before v2.1.205, this variable hid the `/doctor` diagnostics screen command | | `DISABLE_ERROR_REPORTING` | Set to any non-empty value, such as `1`, to opt out of error reporting. **Setting it to `0` or `false` still opts out**, unlike most on/off variables; unset the variable to turn error reporting back on | | `DISABLE_EXTRA_USAGE_COMMAND` | Set to `1` to hide the `/usage-credits` command that lets users purchase additional usage beyond rate limits | -| `DISABLE_FEEDBACK_COMMAND` | Set to `1` to disable the `/feedback` command. Also disables `/bug` and `/share`, which report through the same path; before v2.1.212 they were aliases of `/feedback`, so the command was disabled under every name. The older name `DISABLE_BUG_COMMAND` is also accepted | +| `DISABLE_FEEDBACK_COMMAND` | Set to `1` to disable the `/feedback` command and [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior). Also disables `/bug` and `/share`, which report through the same path; before v2.1.212 they were aliases of `/feedback`, so the command was disabled under every name. The older name `DISABLE_BUG_COMMAND` is also accepted | | `DISABLE_GROWTHBOOK` | Set to `1` or `true` to disable GrowthBook feature-flag fetching and use code defaults for every flag. This makes [Remote Control](/docs/en/remote-control#requirements) and the other [features that need feature-flag fetching](#features-that-need-feature-flag-fetching) unavailable. Setting it to `0` or `false` leaves fetching on. Telemetry event logging stays on unless `DISABLE_TELEMETRY` is also set | | `DISABLE_INSTALLATION_CHECKS` | Set to `1` to disable installation warnings. Use only when manually managing the installation location, as this can mask issues with standard installations | | `DISABLE_INSTALL_GITHUB_APP_COMMAND` | Set to `1` to hide the `/install-github-app` command. Already hidden when using third-party providers (Amazon Bedrock, Google Cloud's Agent Platform, or Microsoft Foundry) | @@ -498,6 +499,7 @@ Claude Code also leaves fetching off when you connect through a [Claude apps gat * Have Claude Code refresh the [PR review status badge](/docs/en/interactive-mode#pr-review-status) less often while you're idle; Claude Code refreshes it every 60 seconds instead * Get the [v2 MCP client runtime](/docs/en/mcp#mcp-client-runtimes) and its protocol probe without setting `MCP_SDK_GENERATION` and `MCP_PROTOCOL_NEGOTIATION`; Claude Code uses the v1 runtime unless you set `MCP_SDK_GENERATION=v2`, and skips the probe unless you set `MCP_PROTOCOL_NEGOTIATION=auto` * Get the [PowerShell tool](/docs/en/tools-reference#powershell-tool) by default for claude.ai and Console accounts on Windows with Git Bash installed; Claude Code routes shell commands through Git Bash unless you set `CLAUDE_CODE_USE_POWERSHELL_TOOL=1`. On Windows without Git Bash, the tool stays on +* Get [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior), which Claude Code turns on through a fetched flag ### First session after an install or upgrade diff --git a/content/en/docs/claude-code/errors.md b/content/en/docs/claude-code/errors.md index 229bf6234..fc10a460e 100644 --- a/content/en/docs/claude-code/errors.md +++ b/content/en/docs/claude-code/errors.md @@ -117,6 +117,8 @@ Match the message you see to a section below. | `thinking.type.enabled is not supported for this model` | [Request errors](#thinking-type-enabled-is-not-supported-for-this-model) | | `max_tokens must be greater than thinking.budget_tokens` | [Request errors](#thinking-budget-exceeds-output-limit) | | `API Error: 400 due to tool use concurrency issues` | [Request errors](#tool-use-or-thinking-block-mismatch) | +| `[Unsupported tool content removed]` | [Request errors](#unsupported-tool-content-removed) | +| `server_tool_use.name: Input should be` on every turn of a resumed session | [Request errors](#unsupported-tool-content-removed) | | ` can't help with this. Start a new session to continue` | [Request errors](#usage-policy-refusal) | | `Claude Code is unable to respond to this request, which appears to violate our Usage Policy` | [Request errors](#usage-policy-refusal) | | `'s safeguards flagged this message` | [Request errors](#safety-measures-flagged-a-cybersecurity-topic) | @@ -132,6 +134,7 @@ Match the message you see to a section below. | `` `claude import` is not yet available in this build `` | [Command-line errors](#claude-import-is-not-yet-available-in-this-build) | | `Could not read Claude Code config` | [Command-line errors](#could-not-read-claude-code-config) | | `Could not import : ` | [Command-line errors](#could-not-import-a-server-from-claude-desktop) | +| `is Anthropic-hosted and doesn't support local OAuth` | [Command-line errors](#anthropic-hosted-and-doesnt-support-local-oauth) | | `Error: MCP tool (passed via --permission-prompt-tool) not found` | [Command-line errors](#mcp-permission-prompt-tool-not-found) | | `Shell command failed for pattern "..."`, from `/security-review` or any skill that injects dynamic context | [Command-line errors](#security-review-fails-without-origin-head) | | `Shell command permission check failed for pattern "..."`, from a skill that injects dynamic context | [Command-line errors](#security-review-fails-without-origin-head) | @@ -147,6 +150,8 @@ Match the message you see to a section below. | `No conversation found with session ID: ` | [Command-line errors](#no-conversation-found-with-the-session-id) | | `Cannot switch renderers in this session` | [Command-line errors](#cannot-switch-renderers-in-this-session) | | `Cannot switch renderers while work is running in the background` | [Command-line errors](#cannot-switch-renderers-in-this-session) | +| `Couldn't read your Zed keymap` / `Couldn't back up your Zed keymap` / `Couldn't update your Zed keymap` | [Command-line errors](#terminal-setup-left-your-zed-keymap-unchanged) | +| `Your Zed keymap isn't a readable list of keybindings` | [Command-line errors](#terminal-setup-left-your-zed-keymap-unchanged) | | `Marketplace "" is registered from an untrusted source` | [Plugin errors](#marketplace-is-registered-from-an-untrusted-source) | | `references ${user_config.*} in a shell-form command` | [Plugin errors](#plugin-command-references-user-config) | | `Monitor "" from plugin references ${user_config.*} in its command` | [Plugin errors](#plugin-command-references-user-config) | @@ -168,6 +173,8 @@ Match the message you see to a section below. | `blocked because the path is spelled in a form that cannot be safely resolved` | [Background session errors](#write-or-command-blocked-because-the-path-cannot-be-safely-resolved) | | `blocked because the path is network-shaped` | [Background session errors](#write-or-command-blocked-because-the-path-names-a-network-location) | | `This session has no saved transcript` | [Background session errors](#this-session-has-no-saved-transcript) | +| `terminal host process died — press Enter to restart` / `This session's terminal host process died` | [Background session errors](#terminal-host-process-died) | +| `Session isn't responding` / `Press enter again to restart this session — it isn't responding` | [Background session errors](#session-isnt-responding) | | `This session was running agent '', which is no longer available` | [Background session errors](#session-agent-no-longer-available) | | `CLAUDE_CODE_PROCESS_WRAPPER: launcher ...` | [Background session errors](#claude_code_process_wrapper-launcher-errors) | | `EUNKNOWN: unknown error, uv_spawn` | [Background session errors](#eunknown-when-starting-a-background-session) | @@ -177,6 +184,8 @@ Match the message you see to a section below. | `Transcript writes are failing (...)` | [Session saving warnings](#transcript-writes-are-failing) | | `Transcript saving is off — CLAUDE_CODE_SKIP_PROMPT_HISTORY is set` | [Session saving warnings](#transcript-saving-is-off-skip-prompt-history) | | `Transcript saving is off — inherited CLAUDE_CODE_CHILD_SESSION marker` | [Session saving warnings](#transcript-saving-is-off-child-session-marker) | +| `Claude Code's fullscreen renderer didn't finish starting last time on this machine` / `Claude Code's fullscreen renderer has repeatedly failed to start on this machine` | [Configuration warnings](#fullscreen-failed-start-notice) | +| `Claude Code exited after an unrecoverable interface error (...)` | [Configuration warnings](#exited-after-an-unrecoverable-interface-error) | | `Ignoring N permissions.allow entries from ... this workspace has not been trusted` | [Configuration warnings](#workspace-has-not-been-trusted) | | `headersHelper not run — this workspace has no persisted trust` | [Configuration warnings](#headershelper-not-run) | | `... is not matched by file permission checks` | [Configuration warnings](#is-not-matched-by-file-permission-checks) | @@ -207,7 +216,7 @@ Before v2.1.227, `Connection lost before a response was produced` read `Connecti Claude Code doesn't retry these failures: * A TLS certificate validation failure, such as a TLS-inspecting proxy, a missing `NODE_EXTRA_CA_CERTS` bundle, or an expired certificate. Claude Code reports the error on the first attempt, so you can fix the certificate setup right away; see [SSL certificate errors](#ssl-certificate-errors). Claude Code still retries transient TLS conditions such as a handshake timeout. Before v2.1.199, Claude Code retried certificate failures through the full retry budget before showing the error. -* A server error, dropped connection, or stalled stream that arrives after Claude has completed a block of text or a tool call, or has started one after finishing its thinking, but before it finishes the response. Claude Code could execute the same tool calls twice if it re-ran the request, so it keeps what Claude completed and shows an [incomplete-response notice](#the-response-above-may-be-incomplete). Claude Code still runs any tool calls Claude completed and continues the turn from their results. Before v2.1.199, Claude Code discarded the partial output and reported the whole turn as an error when a server error arrived mid-stream. +* A server error, dropped connection, or stalled stream that arrives after Claude has completed a block of text or a tool call, or has started one after finishing its thinking, but before it finishes the response. Claude Code doesn't re-run the request, because that could execute the same tool calls twice. It keeps what Claude completed, runs any tool calls Claude finished, and continues the turn from their results. For what you see in an interactive session and in a non-interactive one, read [The response above may be incomplete](#the-response-above-may-be-incomplete). Before v2.1.199, Claude Code discarded the partial output and reported the whole turn as an error when a server error arrived mid-stream. * A failure that arrives after Claude has finished the response: nothing needs retrying, so Claude Code keeps the complete response and ends the turn normally. * An [Amazon Bedrock streaming response with an unexpected content-type](#bedrock-streaming-response-has-an-unexpected-content-type), because the gateway or proxy rewriting the response would rewrite the retry the same way. Requires Claude Code v2.1.208 or later. * A non-streaming retry of a failed streaming request that gets a success status but [no Claude API message in the body](#api-returned-an-empty-or-malformed-response). Claude Code ends the turn with that error. @@ -219,7 +228,13 @@ While retrying, the spinner shows a `Retrying in Ns · attempt x/y` countdown af As of v2.1.198, the usual spinner tip is suppressed during retries. Once the error reason is revealed, if the failure is a 529 overload the line below the countdown also names where to check service status: `status.claude.com` on the Anthropic API, or the provider or gateway host named in the message on other configurations. -If no data arrives on the response stream for 20 seconds while a request is still pending, the spinner shows `Waiting for API response · will retry in … · check your network` before any retry has started. The request hasn't failed yet: the countdown runs to the point where Claude Code aborts the stalled connection. After the abort, Claude Code retries the request, ends the turn with an error when the failure isn't retryable or [retries run out](#automatic-retries), shows [The response above may be incomplete](#the-response-above-may-be-incomplete) and continues the turn from the results of any tool calls Claude completed, or ends the turn normally when Claude had already finished the response before the stall. The banner clears on its own once data resumes or a retry succeeds; if it reappears on every attempt, treat it as a [network issue](#unable-to-connect-to-api). Before v2.1.185, the banner appeared after 10 seconds with different wording. +If no data arrives on the response stream for 20 seconds while a request is still pending, the spinner shows `Waiting for API response · will retry in … · check your network` before any retry has started. The request hasn't failed yet: the countdown runs to the point where Claude Code aborts the stalled connection. After the abort, what you see depends on how far the response had got: + +* Before Claude has completed a block of text or a tool call, or started one after finishing its thinking, Claude Code retries the request or ends the turn with an error. [Automatic retries](#automatic-retries) says which stalls it retries and how many times. +* After Claude has completed a block of text or a tool call, or started one after finishing its thinking, but before Claude has finished the response, Claude Code keeps what Claude completed, continues the turn from any tool calls Claude finished, and shows [The response above may be incomplete](#the-response-above-may-be-incomplete). In a non-interactive session, Claude Code may first prompt Claude to continue the response; that entry says when it does and when you still see the notice there. +* After Claude finished the response, Claude Code ends the turn normally. + +The banner clears on its own once data resumes or a retry succeeds. If it reappears on every attempt, treat it as a [network issue](#unable-to-connect-to-api). Before v2.1.185, the banner appeared after 10 seconds with different wording. While Claude is consulting the [advisor](/docs/en/advisor), the banner appears after 90 seconds without data instead of 20, because a long advisor review can send nothing for well over 20 seconds. Before v2.1.214, the 20-second threshold applied during advisor calls too, so the banner appeared during advisor reviews even when nothing was wrong. @@ -308,10 +323,11 @@ API Error: The response stopped arriving. The response above may be incomplete. Before v2.1.227, `Connection lost mid-response` read `Connection closed mid-response` and `The response stopped arriving` read `Response stalled mid-stream`. -When one of these failures lands at another point in the turn, Claude Code handles it without this notice: +In three cases, Claude Code handles the failure without showing this notice right away: * Earlier in the response, Claude Code either retries the failure or ends the turn with a different error. See [Automatic retries](#automatic-retries). * When one of these failures arrives after Claude has finished the response, Claude Code keeps the complete response and ends the turn normally, without this notice. Before v2.1.222, Claude Code showed this notice when the connection dropped or stalled after the response finished, and reported the turn as an error even though the response was complete. +* In a [non-interactive session](/docs/en/headless), such as a `-p` run, an [Agent SDK](/docs/en/agent-sdk/overview) run, or a [cloud session](/docs/en/claude-code-on-the-web), you don't have to send `continue` yourself when the cut-off response is in the main conversation and contains text but no tool calls: Claude Code keeps the partial output and prompts Claude to continue from where it stopped, up to three times in a row. You see this notice for such a response only once Claude Code has used up those continuations. Before v2.1.246, Claude Code ended a non-interactive turn with this notice on the first cut-off. **What to do:** @@ -319,7 +335,7 @@ When one of these failures lands at another point in the turn, Claude Code handl * In [non-interactive mode](/docs/en/headless) (`-p`): * With the default text output, Claude Code prints the last completed block of text it still holds from earlier in the turn, followed by this message. When it holds none, Claude Code prints this message alone, for example because Claude Code compacted the conversation mid-turn and cleared that text. Before v2.1.219, Claude Code printed only this message in `-p` text output and dropped the response it had already produced. * With `--output-format json` or `stream-json`, Claude Code reports this message in the `result` field. - * To continue the turn, resume the session and send `continue` as described in [Continue conversations](/docs/en/headless#continue-conversations). + * To continue the turn once the connection is stable, resume the session and send `continue` as described in [Continue conversations](/docs/en/headless#continue-conversations). ### Auto mode cannot determine the safety of an action @@ -1223,7 +1239,7 @@ The status is the proxy's answer to the `CONNECT`. The host never answered, so e **What to do:** * Check the address and credentials in the proxy variable, as [Proxy configuration](/docs/en/network-config#proxy-configuration) describes, then run `curl -x http://proxy.example.com:8080 -I https://api.anthropic.com` from the shell you start Claude Code in, using your own proxy URL. On Windows PowerShell, run `curl.exe`. If this probe fails the same way, fix the proxy setup first. If it succeeds, the refusal is specific to the artifact host. -* If your network lets Claude Code reach the artifact host directly, add `.claudeusercontent.com` to [`NO_PROXY`](/docs/en/network-config#environment-variables). +* If your network lets Claude Code reach the artifact host directly, add `.frame.claudeusercontent.com` to [`NO_PROXY`](/docs/en/network-config#environment-variables). Keep the entry that narrow: a broader `.claudeusercontent.com` entry also bypasses the proxy for `bridge.claudeusercontent.com`, which organizations with [IP allowlisting](/docs/en/network-config#organization-ip-allowlists-and-proxy-egress) need to keep on the proxy. Before v2.1.238, Claude Code reported a refused tunnel as a generic network error. @@ -1594,6 +1610,21 @@ All three variants mean the same thing: the sequence of `tool_use`, `tool_result * If you are using Opus 4.7 or Opus 4.8, run `claude update` first. Versions before v2.1.156 can trigger this error during normal tool use, and `/rewind` doesn't clear it. * Run `/rewind`, or press Esc twice, to step back to a checkpoint before the corrupted turn and continue from there. See [Checkpointing](/docs/en/checkpointing) for how checkpoints are created and restored. +### Unsupported tool content removed + +When Claude Code connects directly to the Anthropic API and loads or previews a saved session, it removes tool content the Anthropic API doesn't accept and leaves this line where removed content sat between two thinking blocks: + +```text theme={null} +[Unsupported tool content removed] +``` + +Such content reaches a session file when something other than the Anthropic API answered in the API's format, typically a third-party proxy set through [`ANTHROPIC_BASE_URL`](/docs/en/env-vars) that translates another provider's tool calls. Claude Code removes it only when the session connects directly to the Anthropic API, and loads the saved history as it is when the session runs through a proxy or on another provider. Before v2.1.246, Claude Code sent the tool use and its result back to the API, and every turn of the resumed session failed with a 400 error such as `messages.1.content.0.server_tool_use.name: Input should be 'web_search', 'web_fetch', ...`. + +**What to do:** + +* None needed when you see the placeholder line. The session continues without the removed content. +* If every turn of a resumed session fails with the 400 error instead, run `claude update` and resume the session again. Versions before v2.1.246 don't remove the content. + ### Usage Policy refusal The API declined to respond because content in the conversation triggered a [Usage Policy](https://www.anthropic.com/legal/aup) check. The message includes a Request ID you can quote to support if you believe the refusal is incorrect. @@ -1812,6 +1843,23 @@ The text after the server name is the reason. The most common one is the name ch * Rename the server in `claude_desktop_config.json` to use only letters, numbers, hyphens, and underscores, then run `claude mcp add-from-claude-desktop` again * Add that server directly with `claude mcp add` or `claude mcp add-json` under a valid name. See [Import MCP servers from Claude Desktop](/docs/en/mcp#import-mcp-servers-from-claude-desktop). +

+ Server is Anthropic-hosted and doesn't support local OAuth +

+ +You started a sign-in for an MCP server whose URL points at an Anthropic-hosted connector host that authenticates through a third-party identity provider. These hosts include `microsoft365.mcp.claude.com`, `gmail.mcp.claude.com`, and `gcal.mcp.claude.com`. Claude Code refuses to start its local OAuth flow for these hosts from both the `/mcp` panel and `claude mcp login`, because [their sign-in works only through claude.ai](/docs/en/mcp#use-mcp-servers-from-claude-ai). + +```text theme={null} +"gmail" is Anthropic-hosted and doesn't support local OAuth. Connect it via Settings → Connectors on claude.ai (requires `claude login`), then it'll be available here automatically. +``` + +Claude Code matches these hosts by URL, so the message appears when a server you added with `claude mcp add` or in `.mcp.json` points at one of them. + +**What to do:** + +* Remove your entry with `claude mcp remove `, so it can't hide the claude.ai connector at the same URL +* After removing it, connect the service at [claude.ai/customize/connectors](https://claude.ai/customize/connectors), while signed in to the account you use in Claude Code. Once connected, [the connector appears in Claude Code automatically](/docs/en/mcp#use-mcp-servers-from-claude-ai) if your active authentication method is a claude.ai subscription login + ### MCP permission prompt tool not found The tool you passed to [`--permission-prompt-tool`](/docs/en/cli-reference#cli-flags) wasn't among the connected MCP tools when the run first needed a permission decision, either because its server never connected or because no connected server exposes a tool by that name. Claude Code still sends your prompt: the [non-interactive](/docs/en/headless) run exits with this error, and exit code 1, on the first tool call that needs approval, so it produces no answer even though the request was made. Before the first prompt, Claude Code waits up to the per-server connection timeout of 30 seconds set by [`MCP_TIMEOUT`](/docs/en/env-vars) for that server to connect. Before v2.1.206, startup didn't wait for the server to finish connecting, so a slow-starting but healthy server produced this error too. @@ -2013,6 +2061,34 @@ Each reason the message can show in parentheses: * In a session started without those restrictions, run `/tui fullscreen`, or `/tui default` to switch back. Claude Code saves the [`tui` setting](/docs/en/settings-reference#tui) there +

+ /terminal-setup left your Zed keymap unchanged +

+ +You ran [`/terminal-setup`](/docs/en/terminal-config#enter-multiline-prompts) in Zed, and Claude Code couldn't complete the update to your Zed `keymap.json`, so it left the file as it was. + +Each message names the path to your keymap and ends with the keybinding block to add yourself: + +```text theme={null} +Couldn't update your Zed keymap, so it was left unchanged. +To add the binding yourself, add this block to the keymap array in : +{ "context": "Terminal", "bindings": { "shift-enter": ["terminal::SendText", "\u001b\r"] } } +``` + +The first line of the message names the cause: + +* `Couldn't read your Zed keymap, so it was left unchanged.`: Claude Code couldn't read the file, for example because of file permissions +* `Your Zed keymap isn't a readable list of keybindings, so it was left unchanged.`: the file read fine but doesn't parse as an array of keybinding blocks, even with `//` comments and trailing commas allowed +* `Couldn't back up your Zed keymap; not modifying it.`: Claude Code couldn't copy the file to a `.bak` backup beside it, so it changed nothing +* `Couldn't update your Zed keymap, so it was left unchanged.`: the merged result didn't verify as a valid keymap carrying the binding, so Claude Code discarded it instead of writing. A keybinding block with a duplicated key can cause this + +**What to do:** + +* Copy the block from the message into the top-level array in your `keymap.json` at the path the message names +* For `isn't a readable list of keybindings`, fix the syntax error, or make the file's top-level value an array, then run `/terminal-setup` again + +Before v2.1.247, `/terminal-setup` couldn't parse a Zed keymap that used `//` comments or trailing commas, and it replaced the entire file with only its own binding while reporting the binding as installed. To restore a keymap an earlier version replaced, use the `.bak` backup file described under [Enter multiline prompts](/docs/en/terminal-config#enter-multiline-prompts). + ## Plugin errors These errors come from [plugin](/docs/en/plugins) and [marketplace](/docs/en/plugin-marketplaces) configuration. For plugin problems that don't produce one of the messages on this page, such as a marketplace URL that doesn't load or a plugin that installs but doesn't appear, see [Plugin troubleshooting](/docs/en/discover-plugins#troubleshooting). @@ -2322,6 +2398,62 @@ Opening the same session's row in [agent view](/docs/en/agent-view) shows `Press * To start the stopped session fresh anyway, run `claude respawn ` with the ID from the message, or press `Enter` twice on its row in agent view * If the session did finish a response and you still see this refusal on a version before v2.1.214, an unreadable folder in `~/.claude/projects` could make the transcript scan miss the saved conversation; update to v2.1.214 or later, which tolerates unreadable folders during the scan +### Terminal host process died + +Each [background session's](/docs/en/agent-view) terminal runs in a host process under the background service, and that process died while the service still held its connection, so the session couldn't be reached. + +On Linux and WSL, the background service checks each host process every few seconds, marks the session failed when the process has exited but its connection to the service never closed, and shows the reason on its row in [agent view](/docs/en/agent-view#read-session-state): + +```text theme={null} +terminal host process died — press Enter to restart +``` + +If you open the row before the check runs, the footer shows `This session's terminal host process died (the conversation is saved) — press Enter to restart it` and the row turns failed. + +From the shell, `claude attach ` restarts a session already marked failed for a dead host, and otherwise prints the cause and exits: + +```text theme={null} +Couldn't attach to — This session's terminal host process died (the conversation is saved) — run `claude attach ` again to restart it on a fresh host. +``` + +The conversation is saved either way. + +A row running a [shell command](/docs/en/agent-view#run-a-shell-command) instead shows `terminal host process died — its output is gone; the command was not run again`, and `claude attach` prints `This command's terminal host process died — its output is gone and the command was not run again`. Claude Code never reruns the command for you. + +**What to do:** + +* In agent view, press `Enter` on the failed row; the session restarts on a fresh host process and the conversation resumes +* From the shell, run `claude attach ` again. Claude Code prints `Session 's terminal host died — restarting it on a fresh one…` and reopens the session +* You can't restart a shell-command row this way; dispatch the command again to rerun it + +Before v2.1.247, a dead host process could pass every liveness check the background service ran, so opening the session showed `opening… · esc to cancel` indefinitely and `claude attach ` waited without reporting an error. + +

+ Session isn't responding +

+ +You opened a [background session](/docs/en/agent-view) and the background service accepted the open, but no output arrived for about ten seconds, so Claude Code concludes that the process relaying the session's terminal can't deliver output, and ends the attempt instead of waiting. + +In agent view, Claude Code offers a restart in the footer: + +```text theme={null} +Press enter again to restart this session — it isn't responding (its conversation is saved and resumes). +``` + +From the shell, `claude attach ` prints the cause and exits: + +```text theme={null} +Couldn't attach to — Session isn't responding — `claude stop `, then `claude attach ` restarts it (the conversation is saved). +``` + +Claude Code never restarts a row running a [shell command](/docs/en/agent-view#run-a-shell-command) for you, because a restart would run the command again. + +**What to do:** + +* In agent view, press `Enter` on the same row again. Claude Code stops the unresponsive process and restarts the session, and the conversation resumes. Nothing is stopped without that second press +* From the shell, run `claude stop `, then `claude attach ` +* For a shell-command row, press `Ctrl+X` in agent view or run `claude stop ` to stop it; dispatch the command again to rerun it +

Session agent no longer available

@@ -2502,7 +2634,43 @@ Inside tmux, Claude Code detects a marker that arrived through the tmux server's ## Configuration warnings -Claude Code writes these messages to stderr rather than showing an error in the conversation, except where an entry notes that it writes the message to the debug log instead. It writes most of them at startup and writes the [unrecognized-model diagnostic line](#unrecognized-model-id-on-a-request) at request time. +Claude Code writes these messages to stderr rather than showing an error in the conversation, except where an entry notes that it writes the message to the debug log instead. It writes most of them at startup. Two exceptions: it writes the [unrecognized-model diagnostic line](#unrecognized-model-id-on-a-request) at request time, and the [unrecoverable interface error message](#exited-after-an-unrecoverable-interface-error) as it exits. + +

+ Fullscreen renderer didn't finish starting +

+ +A previous [fullscreen](/docs/en/fullscreen) session on this machine exited before it finished starting, so Claude Code starts this session on the classic renderer and prints one of these notices: + +```text theme={null} +Claude Code's fullscreen renderer didn't finish starting last time on this machine, so this launch is using the classic renderer. It will try fullscreen again next launch; /tui default keeps the classic renderer. + +Claude Code's fullscreen renderer has repeatedly failed to start on this machine, so it has been turned off here. Run /tui fullscreen to try it again (this also resets after an update). +``` + +**What to do:** + +* Follow [Fullscreen rendering](/docs/en/fullscreen#fullscreen-renderer-didnt-finish-starting). It says which notice you get, what Claude Code does in later sessions, and how to try fullscreen again or keep the classic renderer. +* If the session that died printed an exit message, see [Claude Code exited after an unrecoverable interface error](#exited-after-an-unrecoverable-interface-error) for what it names. + +Before v2.1.236, Claude Code printed no notice and kept starting sessions in fullscreen rendering after a failed start. + +

+ Claude Code exited after an unrecoverable interface error +

+ +Claude Code prints this message when it exits because its terminal interface hit an error it can't recover from, in either renderer. The second sentence appears only when the error happened while the [fullscreen](/docs/en/fullscreen) renderer was starting: + +```text theme={null} +Claude Code exited after an unrecoverable interface error (). It happened while the fullscreen renderer was starting, so the next launch will use the classic renderer (CLAUDE_CODE_DISABLE_ALTERNATE_SCREEN=1 forces that any time). +``` + +**What to do:** + +* Start Claude Code again. To pick the conversation back up, run `claude --resume` in the same directory. +* If the message names the fullscreen renderer, [Fullscreen rendering](/docs/en/fullscreen#fullscreen-renderer-didnt-finish-starting) says what the next launch does, which depends on how you turned fullscreen on, and how to try fullscreen again or keep the classic renderer. + +Before v2.1.236, Claude Code exited without printing a message after this kind of error. ### Workspace has not been trusted diff --git a/content/en/docs/claude-code/hooks-guide.md b/content/en/docs/claude-code/hooks-guide.md index 75547e30b..8b7ee9fea 100644 --- a/content/en/docs/claude-code/hooks-guide.md +++ b/content/en/docs/claude-code/hooks-guide.md @@ -183,7 +183,7 @@ The empty `matcher` fires on all notification types. To fire only on specific ev | Matcher | Fires when | | :--------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `permission_prompt` | Claude needs you to approve a tool use and the prompt has waited about six seconds | +| `permission_prompt` | Claude needs you to approve a tool use or a sandboxed command's [network request](/docs/en/sandboxing#network-isolation), and the prompt has waited about six seconds | | `idle_prompt` | Claude finished responding about 60 seconds ago and you haven't typed since | | `auth_success` | Authentication completes | | `elicitation_dialog` | An MCP server opens an elicitation form and you haven't typed for about six seconds | @@ -202,6 +202,8 @@ The `agent_needs_input` and `agent_completed` matchers require Claude Code v2.1. The `quota_auto_resume_fired`, `quota_auto_resume_stale`, and `quota_auto_resume_disabled` matchers require Claude Code v2.1.234 or later. +In terminal sessions, `permission_prompt` for a sandboxed command's network request requires Claude Code v2.1.246 or later. + Type `/hooks` and select `Notification` to confirm the hook is registered. For the full event schema, see the [Notification reference](/docs/en/hooks#notification). ### Auto-format code after edits @@ -467,7 +469,7 @@ To switch the session to `acceptEdits`, your hook writes this JSON to stdout: } ``` -Keep the matcher as narrow as possible. Matching on `.*` or leaving the matcher empty would auto-approve every permission prompt, including file writes and shell commands. See the [PermissionRequest reference](/docs/en/hooks#permissionrequest-decision-control) for the full set of decision fields. +Keep the matcher as narrow as possible. Matching on `.*` or leaving the matcher empty would auto-approve every tool permission prompt, including file writes and shell commands. See the [PermissionRequest reference](/docs/en/hooks#permissionrequest-decision-control) for the full set of decision fields. ## How hooks work diff --git a/content/en/docs/claude-code/hooks.md b/content/en/docs/claude-code/hooks.md index c1409a2e8..59c42f14c 100644 --- a/content/en/docs/claude-code/hooks.md +++ b/content/en/docs/claude-code/hooks.md @@ -1796,10 +1796,12 @@ If the deferred tool is no longer available when you resume, the process exits w ### PermissionRequest -Runs when Claude Code is about to ask you for permission. In sessions that can't show a prompt, such as background subagents in [non-interactive mode](/docs/en/headless), Claude Code still runs these hooks, and if no hook returns a decision, it denies the tool call. +Runs when Claude Code is about to ask you for permission to use a tool. In sessions that can't show a prompt, such as background subagents in [non-interactive mode](/docs/en/headless), Claude Code still runs these hooks, and if no hook returns a decision, it denies the tool call. Use [PermissionRequest decision control](#permissionrequest-decision-control) to allow or deny on behalf of the user. -Use this event when you need a signal the moment Claude asks for permission. The [Notification](#notification) event's `permission_prompt` type reaches you only after the prompt has waited about six seconds. +Use this event when you need a signal the moment Claude asks for permission to use a tool. Claude Code runs a [Notification](#notification) hook with the `permission_prompt` type only after the prompt has waited about six seconds. + +Claude Code doesn't run PermissionRequest hooks for a sandboxed command's [network request](/docs/en/sandboxing#network-isolation). To get a signal for that prompt, use the `permission_prompt` notification type. Matches on tool name, same values as PreToolUse. @@ -2170,7 +2172,7 @@ You receive these hook events even with desktop notifications turned off: the `p | Matcher | When it fires | | :--------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `permission_prompt` | Claude needs you to approve a tool use and the prompt has waited about six seconds | +| `permission_prompt` | Claude needs you to approve a tool use or a sandboxed command's [network request](/docs/en/sandboxing#network-isolation), and the prompt has waited about six seconds | | `idle_prompt` | Claude finished responding about 60 seconds ago and you haven't typed since | | `auth_success` | Authentication completes | | `elicitation_dialog` | An MCP server opens an elicitation form and you haven't typed for about six seconds | @@ -2187,10 +2189,12 @@ The `agent_needs_input` and `agent_completed` types require Claude Code v2.1.198 The `quota_auto_resume_fired`, `quota_auto_resume_stale`, and `quota_auto_resume_disabled` types require Claude Code v2.1.234 or later. +In terminal sessions, `permission_prompt` for a sandboxed command's network request requires Claude Code v2.1.246 or later. + The `permission_prompt`, `idle_prompt`, `elicitation_dialog`, and `elicitation_url_dialog` types share their timing with desktop notifications, so in terminal sessions you only see them when you appear to be away from the terminal: - * Expect `permission_prompt` once you haven't typed for about six seconds. The timer starts when the permission prompt appears, and each keystroke defers it. To run a hook immediately on every permission ask, use [PermissionRequest](#permissionrequest) instead. + * Expect `permission_prompt` once you haven't typed for about six seconds. The timer starts when the permission prompt appears, and each keystroke defers it. To run a hook immediately when Claude asks for permission to use a tool, use [PermissionRequest](#permissionrequest) instead. * Expect `idle_prompt` about 60 seconds after Claude finishes responding, and only if you haven't typed since. Claude Code doesn't send `idle_prompt` while it waits for a claude.ai usage limit to reset. When the wait ends on its own, one of the `quota_auto_resume_*` types fires instead. * Expect `elicitation_dialog` for an elicitation form, or `elicitation_url_dialog` for a browser URL request, once you haven't typed for about six seconds. Both share the same six-second gate as `permission_prompt`: the timer starts when the dialog appears, and each keystroke defers it. diff --git a/content/en/docs/claude-code/keybindings.md b/content/en/docs/claude-code/keybindings.md index d90b7626f..8dfd2d1cb 100644 --- a/content/en/docs/claude-code/keybindings.md +++ b/content/en/docs/claude-code/keybindings.md @@ -286,12 +286,18 @@ Actions available in the `ModelPicker` context: Actions available in the `Select` context: -| Action | Default | Description | -| :---------------- | :-------------- | :--------------- | -| `select:next` | Down, J, Ctrl+N | Next option | -| `select:previous` | Up, K, Ctrl+P | Previous option | -| `select:accept` | Enter | Accept selection | -| `select:cancel` | Escape | Cancel selection | +| Action | Default | Description | +| :---------------- | :-------------- | :---------------------------- | +| `select:next` | Down, J, Ctrl+N | Next option | +| `select:previous` | Up, K, Ctrl+P | Previous option | +| `select:pageUp` | PageUp | Move up one page of options | +| `select:pageDown` | PageDown | Move down one page of options | +| `select:first` | Home | First option | +| `select:last` | End | Last option | +| `select:accept` | Enter | Accept selection | +| `select:cancel` | Escape | Cancel selection | + +Claude Code applies your `select:pageUp`, `select:pageDown`, `select:first`, and `select:last` bindings in the `/skills` menu. In most other lists, such as the `/model` picker, Claude Code pages with PageUp and PageDown regardless of your bindings and ignores Home and End. ### Plugin actions @@ -388,6 +394,8 @@ ctrl+k ctrl+s Press Ctrl+K, release, then Ctrl+S * `tab` - Tab key * `space` - Space bar * `up`, `down`, `left`, `right` - Arrow keys +* `pageup`, `pagedown` - Page Up and Page Down keys +* `home`, `end` - Home and End keys * `backspace`, `delete` - Delete keys * `wheelup`, `wheeldown` - Mouse wheel scroll events diff --git a/content/en/docs/claude-code/mcp.md b/content/en/docs/claude-code/mcp.md index a7960d519..4aee4e0b1 100644 --- a/content/en/docs/claude-code/mcp.md +++ b/content/en/docs/claude-code/mcp.md @@ -235,7 +235,11 @@ claude mcp remove notion `claude mcp add` confirms a successful add by printing an `Added ...` line, which means the configuration was written. `claude mcp list` then shows a health status next to each server it lists, such as `✔ Connected`, `! Needs authentication`, or `✘ Failed to connect`. A failure status means Claude Code couldn't connect to that server, not that the list command failed. -Project-scoped servers from `.mcp.json` that are awaiting your approval appear in `claude mcp list` and `claude mcp get ` as ``⏸ Pending approval (run `claude` to approve)``. Run `claude` interactively to review and approve them. `claude mcp get ` shows rejected servers as `✘ Rejected (see disabledMcpjsonServers in settings)`. +The statuses in this list report a configuration decision rather than a connection attempt, so Claude Code prints them without connecting to the server: + +* ``⏸ Pending approval (run `claude` to approve)``: a project-scoped server from `.mcp.json` that you haven't approved yet. Claude Code shows it in both `claude mcp list` and `claude mcp get `. Run `claude` interactively to review and approve it. +* `✘ Rejected (see disabledMcpjsonServers in settings)`: a `.mcp.json` server that a [`disabledMcpjsonServers`](/docs/en/settings-reference#disabledmcpjsonservers) entry rejects. Claude Code shows it only in `claude mcp get `. +* `⊘ Disabled for this project (re-enable via /mcp)`: a server that the project's [`disabledMcpServers`](#disable-a-server-without-removing-it) list names. Claude Code shows it in both `claude mcp list` and `claude mcp get `. Turn the server back on from the `/mcp` panel. Before v2.1.238, both commands connected to a disabled server to health-check it and reported the connection result. WebSocket servers don't appear in `claude mcp list` output. Use `claude mcp get ` or the `/mcp` panel to check them. @@ -268,15 +272,22 @@ After discarding the entry, Claude Code fetches the server's tool list from the When a server's status is `✘ Failed to connect`, `claude mcp list` appends the failure detail to that status line, and `claude mcp get ` shows it on an `Issue:` line: the HTTP status or error code, plus any error text the server returned. The server's detail view in `/mcp` includes the same server-reported text in its `Issue:` row. Claude Code redacts credential-like text from this detail and never includes the expanded server URL, which can carry secrets. Claude Code appends no detail to a `✘ Connection error` status, because the exception text it would print there can embed that URL. Before v2.1.219, both commands showed only the bare failure status, without the status code or the server's error text. +When you complete authentication from `/mcp` and the connection still fails with an HTTP status or a transport error code, Claude Code adds that code and the origin of the URL it tried to the message it prints after the attempt. The origin is the scheme and host, plus the port when the URL names one, such as `https://mcp.example.com`. + +* The path and query never appear in that message. +* Claude Code takes the origin after `${VAR}` expansion, so a host that comes from a variable appears expanded. +* For a failure with no status or error code, Claude Code shows the error text without the origin. + A remote server whose configuration has an empty `url` shows as `not configured` in `/mcp`, in `claude mcp list`, and in the [`/plugin`](/docs/en/plugins) manager, and Claude Code doesn't attempt to connect to it. A plugin can include a placeholder entry like this for a connector you configure later, so Claude Code doesn't report it as an error or a setup issue. The server's detail view in `/mcp` reads `No URL configured for this server`; set the entry's `url` to connect it. Before v2.1.208, Claude Code reported an empty `url` as a configuration issue with a prompt to reconnect. #### Configuration warnings -Claude Code also warns when an MCP config value carries hidden leading or trailing whitespace, which often comes from pasting a token with a trailing newline. Claude Code checks `command`, `url`, each `args` entry, and the values and key names under `env` and `headers`. Claude Code shows the warning in `claude mcp list` output and in `/mcp`, naming the affected fields without echoing their values, for example `Leading or trailing whitespace in: headers.Authorization`. Claude Code doesn't trim the whitespace and uses the values exactly as written, so edit the configuration to remove it. - -Some server names are reserved for Claude Code's built-in servers: `workspace`, `claude-in-chrome`, `computer-use`, `Claude Preview`, and `Claude Browser`. If your configuration defines a server with a reserved name, Claude Code skips it at load time and shows a warning asking you to rename it. `claude mcp add` rejects a reserved name with an error. +Claude Code warns about the configuration problems below. Each entry says what Claude Code checks and how to clear the warning: -`Claude Preview` and `Claude Browser` both name the built-in server that the [Claude Code desktop app's preview pane](/docs/en/desktop#preview-your-app) uses. Before v2.1.205, `Claude Browser` wasn't reserved, so a user-configured server could register under that name. +* **Hidden whitespace**: Claude Code warns when an MCP config value carries hidden leading or trailing whitespace, which often comes from pasting a token with a trailing newline. Claude Code checks `command`, `url`, each `args` entry, and the values and key names under `env` and `headers`. Claude Code shows the warning in `claude mcp list` output and in `/mcp`, naming the affected fields without echoing their values, for example `Leading or trailing whitespace in: headers.Authorization`. Claude Code doesn't trim the whitespace and uses the values exactly as written, so edit the configuration to remove it. +* **Same name in more than one scope**: if you define the same server name in more than one [scope](#mcp-installation-scopes) with different endpoints, Claude Code warns about the conflict in `claude mcp list` output and in `/mcp`. Claude Code stores OAuth sign-ins per endpoint, so when you authenticate the definition that loads in one project, you still need to sign in separately in a project where a different definition loads. Keep the endpoint you want and remove the others with `claude mcp remove --scope `. In the warning, Claude Code quotes each scope's endpoint as written in your configuration, with [`${VAR}` references](#environment-variable-expansion-in-mcp-json) unexpanded, so it never shows a resolved value such as an API key. +* **Reserved names**: Claude Code reserves the names of its built-in servers, including `workspace`, `claude-in-chrome`, `computer-use`, `Claude Preview`, and `Claude Browser`. If your configuration defines a server with a reserved name, Claude Code skips it at load time and shows a warning asking you to rename it. `claude mcp add` rejects a reserved name with an error. `Claude Preview` and `Claude Browser` both name the built-in server that the [Claude Code desktop app's preview pane](/docs/en/desktop#preview-your-app) uses. Before v2.1.205, `Claude Browser` wasn't reserved, so a user-configured server could register under that name. +* **Missing environment variable**: if a [`${VAR}` reference](#environment-variable-expansion-in-mcp-json) in a server's configuration names a variable that isn't set and has no `:-default`, Claude Code warns in `claude mcp list` output and in `/mcp`, naming the variable, and still loads the server with the `${VAR}` text unexpanded. Set the variable or add a `${VAR:-default}` fallback. #### Tool availability @@ -534,7 +545,13 @@ The resulting `.mcp.json` file follows a standardized format: For security reasons, Claude Code prompts for approval in interactive sessions before using project-scoped servers from `.mcp.json` files. To reset those approval choices, run `claude mcp reset-project-choices`. -`claude -p` runs, [Agent SDK](/docs/en/headless) sessions, and [cloud sessions](/docs/en/claude-code-on-the-web) can't show that prompt: Claude Code loads project-scoped servers there without asking. A session you start in `bypassPermissions` mode with [`skipDangerousModePermissionPrompt`](/docs/en/settings-reference#skipdangerousmodepermissionprompt) set skips the prompt too. To keep a server out anyway, add it to [`disabledMcpjsonServers`](/docs/en/settings-reference#disabledmcpjsonservers), which blocks it in every mode, or exclude project settings entirely with [`--setting-sources`](/docs/en/cli-reference) or the SDK's `settingSources` option. [Project server approvals and workspace trust](#project-server-approvals-and-workspace-trust) covers how approvals committed to the repository interact with workspace trust. +In `claude -p` runs, [Agent SDK](/docs/en/headless) sessions, and [cloud sessions](/docs/en/claude-code-on-the-web), Claude Code can't show that prompt: it loads project-scoped servers without asking. Claude Code also skips the prompt in a session you start in `bypassPermissions` mode with [`skipDangerousModePermissionPrompt`](/docs/en/settings-reference#skipdangerousmodepermissionprompt) set. To keep a server out anyway: + +* Add it to [`disabledMcpjsonServers`](/docs/en/settings-reference#disabledmcpjsonservers), which blocks it in every permission mode. +* Exclude project settings entirely with [`--setting-sources`](/docs/en/cli-reference#cli-flags) or the SDK's `settingSources` option. +* Start the session with [`--strict-mcp-config`](/docs/en/cli-reference#cli-flags). Claude Code then uses only the MCP servers you pass with `--mcp-config`. Skipping the approval prompt for the project-scoped servers Claude Code isn't loading requires Claude Code v2.1.246 or later; before v2.1.246, a strict session still waited on approval for them, which left background sessions waiting at startup. See [Exclusive control with managed-mcp.json](/docs/en/managed-mcp#exclusive-control-with-managed-mcp-json) for what the flag does under a managed MCP file. + +[Project server approvals and workspace trust](#project-server-approvals-and-workspace-trust) covers how approvals committed to the repository interact with workspace trust. ### User scope @@ -1048,7 +1065,9 @@ Before v2.1.222, Claude Code marked connectors as needing authentication instead A server you've added in Claude Code takes [precedence](#scope-hierarchy-and-precedence) over a claude.ai connector that points at the same URL. When this happens, `/mcp` lists the connector as hidden and shows how to remove the duplicate if you'd rather use the connector. -Some Anthropic-hosted connectors, such as Microsoft 365, Gmail, and Google Calendar, don't support local OAuth from Claude Code because the upstream identity provider only accepts the redirect URL that claude.ai registered. Authenticating one of these hosts in `/mcp` shows a message directing you to connect it at Settings → Connectors on claude.ai instead. Once connected there, the connector appears in Claude Code automatically. +Some Anthropic-hosted connectors, such as Microsoft 365, Gmail, and Google Calendar, don't support local OAuth from Claude Code because the upstream identity provider only accepts the redirect URL that claude.ai registered. When a server you added with `claude mcp add` or in `.mcp.json` points at one of these hosts and you sign in to it from `/mcp` or with `claude mcp login`, Claude Code shows [`is Anthropic-hosted and doesn't support local OAuth`](/docs/en/errors#anthropic-hosted-and-doesnt-support-local-oauth), directing you to connect the service at [claude.ai/customize/connectors](https://claude.ai/customize/connectors) instead. + +After you remove your entry with `claude mcp remove ` and connect the service on claude.ai, the connector appears in Claude Code automatically. ### Organization controls on connector tools diff --git a/content/en/docs/claude-code/network-config.md b/content/en/docs/claude-code/network-config.md index 7beb025ff..94f5bf5da 100644 --- a/content/en/docs/claude-code/network-config.md +++ b/content/en/docs/claude-code/network-config.md @@ -194,7 +194,7 @@ Configure the timers with these variables, each detailed in the [environment var * `CLAUDE_BYTE_STREAM_IDLE_TIMEOUT_MS` sets the byte-level watchdog's timeout alone, clamped to between 10 seconds and 30 minutes, and takes precedence over `CLAUDE_STREAM_IDLE_TIMEOUT_MS` for that watchdog. * `API_FORCE_IDLE_TIMEOUT` set to `0` turns the body idle timeout off, and set to `1` turns it on for every provider. The watchdogs run independently of it, so to let a stream pause longer than their thresholds, also raise or disable them. -When a timer aborts a stalled stream, Claude Code handles it like any other mid-stream failure: it retries, keeps completed output with an [incomplete-response notice](/docs/en/errors#the-response-above-may-be-incomplete), or ends the turn, depending on where the response stood. +When a watchdog aborts a stalled stream, Claude Code treats it as a mid-stream failure: depending on how far the response had got, it retries the request or ends the turn with an error, keeps the completed output and shows an [incomplete-response notice](/docs/en/errors#the-response-above-may-be-incomplete), or ends the turn normally. [Automatic retries](/docs/en/errors#automatic-retries) says where each outcome applies. In a [non-interactive session](/docs/en/headless), Claude Code may first prompt Claude to continue the cut-off response; [that notice's entry](/docs/en/errors#the-response-above-may-be-incomplete) says when it does and when you still see the notice. ## Network access requirements @@ -227,6 +227,12 @@ When using [Amazon Bedrock](/docs/en/amazon-bedrock), [Google Cloud's Agent Plat When routing through an [LLM gateway](/docs/en/llm-gateway) with [`ANTHROPIC_BASE_URL`](/docs/en/llm-gateway-connect#set-the-base-url-and-credential), the [fast mode](/docs/en/fast-mode) availability check still calls `api.anthropic.com` rather than the gateway base URL. The check does honor a configured HTTP proxy, so where a network block is the cause, an allowlist entry for `api.anthropic.com` in the proxy is the fix. A network block fails the check only where the host is unreachable even through the proxy, and fast mode then reports a connectivity error. The same connectivity error appears when the check presents a gateway-issued credential that Anthropic rejects; allowlisting doesn't help there, since nothing is blocked. See [use fast mode behind proxies and LLM gateways](/docs/en/fast-mode#use-fast-mode-behind-proxies-and-llm-gateways) for the variables that restore it. +### Organization IP allowlists and proxy egress + +If your organization has [IP allowlisting](https://support.claude.com/en/articles/13200993-restrict-access-to-claude-with-ip-allowlisting) enabled for Claude, route `bridge.claudeusercontent.com` through the same proxy egress as `claude.ai` and `api.anthropic.com`, for example by placing it in the same Zscaler app segment or Netskope steering policy. If you can't route it that way, add the egress address your proxy uses for that host to your organization's IP allowlist, but only when that address is dedicated to your organization: a shared proxy egress range also admits the proxy vendor's other customers. + +Anthropic checks connections to `bridge.claudeusercontent.com` against your organization's IP allowlist using the address they arrive from. If your proxy sends traffic for that host out through an address that isn't on that allowlist, Claude Code can't connect to the [Claude in Chrome](/docs/en/chrome) extension even though the rest of Claude Code works. + ### GitHub allow lists and firewalls [Claude Code on the web](/docs/en/claude-code-on-the-web) in Anthropic-hosted environments and [Code Review](/docs/en/code-review) connect to your repositories from Anthropic-managed infrastructure; sessions in a [self-hosted environment](/docs/en/self-hosted-environments) connect from inside your network, unless the runner opts into the [Anthropic git proxy](/docs/en/self-hosted-environments-deploy#use-the-anthropic-git-proxy), which fetches from Anthropic's side. diff --git a/content/en/docs/claude-code/permission-modes.md b/content/en/docs/claude-code/permission-modes.md index dd2c3cc48..eda4030e6 100644 --- a/content/en/docs/claude-code/permission-modes.md +++ b/content/en/docs/claude-code/permission-modes.md @@ -402,7 +402,7 @@ When auto mode can't approve your session's actions, what happens depends on the * **A blocked action**: Claude Code shows a notification and lists the action in `/permissions` under the **Recently denied** tab, where you can press `r` to retry it with a manual approval. When the classifier produces [no verdict on the action](/docs/en/errors#auto-mode-cannot-determine-the-safety-of-an-action), because a safety check separate from auto mode refused the classifier's own request or its response didn't parse, Claude Code denies the action without the notification or the **Recently denied** entry. * **Repeated blocks**: if the classifier blocks an action 3 times in a row or 20 times total, auto mode pauses and Claude Code resumes prompting. Approving the prompted action resumes auto mode. These thresholds are not configurable. Any allowed action resets the consecutive counter, while the total counter persists for the session and resets only when its own limit triggers a fallback. Claude Code doesn't count a denial toward either threshold when [a safety check separate from auto mode refuses the classifier's own request](/docs/en/errors#auto-mode-cannot-determine-the-safety-of-an-action); the linked entry covers how Claude Code handles those denials. -* **Sessions that can't prompt**: a [non-interactive](/docs/en/headless) `-p` run without a [`--permission-prompt-tool`](/docs/en/cli-reference#cli-flags) has no prompt to fall back to. When repeated blocks reach a threshold, the action doesn't run and Claude keeps working, in the main conversation and in its subagents alike. The same applies when a safety check separate from auto mode refuses the classifier's request. Claude Code doesn't stop the run in either case. +* **Sessions that can't prompt**: a [non-interactive](/docs/en/headless) `-p` run without a [`--permission-prompt-tool`](/docs/en/cli-reference#cli-flags) has no prompt to fall back to. When repeated blocks reach a threshold, the action doesn't run and Claude keeps working. The same applies when [a safety check separate from auto mode refuses the classifier's request](/docs/en/errors#auto-mode-cannot-determine-the-safety-of-an-action). Claude Code doesn't stop the run in either case. * **A mode switch during a check**: if you switch permission modes while a classifier check is pending, Claude Code discards a verdict the new mode wouldn't have requested rather than applying it: you're prompted for approval instead, or the action is auto-denied in [`dontAsk` mode](#allow-only-pre-approved-tools-with-dontask-mode). Repeated blocks usually mean the classifier is missing context about your infrastructure. Use `/feedback` to report false positives, or have an administrator [configure trusted infrastructure](/docs/en/auto-mode-config). diff --git a/content/en/docs/claude-code/plugin-relevance.md b/content/en/docs/claude-code/plugin-relevance.md index bae3fdc62..34c1c9c4f 100644 --- a/content/en/docs/claude-code/plugin-relevance.md +++ b/content/en/docs/claude-code/plugin-relevance.md @@ -26,7 +26,9 @@ When a signal matches and the plugin is not already installed, Claude Code shows * **Session-start suggestion**: if the `cwd` signal matches the working directory, a one-line `plugin suggestion: @ · /plugin` notification appears before the first turn. This surface requires Claude Code v2.1.153 or later. * **`/plugin` Discover tab**: the plugin is pinned to the top of the Discover list with an annotation such as "suggested for this directory" or "suggested for stripe commands". This surface requires Claude Code v2.1.154 or later. -The spinner tip and the session-start notification are part of the spinner-tips system. Both are disabled when the user or project sets `spinnerTipsEnabled` to `false`, or when a custom `spinnerTipsOverride` is configured with `excludeDefault`. The Discover-tab pin is independent of tip settings. +The spinner tip and the session-start notification are part of the spinner-tips system. Claude Code disables both when `spinnerTipsEnabled` resolves to `false` across your settings files, or when `excludeDefault` resolves to `true` across the [`spinnerTipsOverride`](/docs/en/settings-reference#spinnertipsoverride) keys in user, `--settings`, and managed settings and those keys configure at least one tip or a `tipsFile`. + +The Discover-tab pin is independent of tip settings. Claude Code never installs a plugin automatically. The user always confirms. diff --git a/content/en/docs/claude-code/plugins-reference.md b/content/en/docs/claude-code/plugins-reference.md index 009aa26de..28ed94440 100644 --- a/content/en/docs/claude-code/plugins-reference.md +++ b/content/en/docs/claude-code/plugins-reference.md @@ -1109,6 +1109,10 @@ claude plugin update [options] | `-y, --yes` | Accept a command the plugin's marketplace declares, without the confirmation prompt: the command that produces a plugin with a [`command` source](/docs/en/plugin-marketplaces#command-sources), or the [`headersHelper`](/docs/en/plugin-marketplaces#authenticate-archive-downloads) that authenticates an archive download. Accepting a `headersHelper` requires Claude Code v2.1.238 or later. Claude Code still prints the command first. Required when stdin or stdout isn't a TTY. Has no effect inside a Claude Code session, so run the command from your own terminal | | | `-h, --help` | Display help for command | | + + Claude Code resolves a bare plugin name against your installed plugins. When installed plugins from different marketplaces share the name, Claude Code refuses the update and lists the qualified `plugin-name@marketplace-name` commands to run instead. Before v2.1.246, Claude Code accepted only the qualified form and rejected a bare name as not found. + + *** ### plugin list @@ -1241,7 +1245,7 @@ This shows: * `Invalid JSON syntax: Unexpected token } in JSON at position 142`: check for missing commas, extra commas, or unquoted strings * `Plugin has an invalid manifest file at .claude-plugin/plugin.json. Validation errors: name: Invalid input: expected string, received undefined`: a required field is missing -* `Plugin has a corrupt manifest file at .claude-plugin/plugin.json. JSON parse error: ...`: JSON syntax error +* `Plugin has a corrupt manifest file at .claude-plugin/plugin.json. JSON parse error: ...`: JSON syntax error. Before v2.1.246, Claude Code also produced this error for a `plugin.json` saved as UTF-8 with a leading byte-order mark (BOM), even when the JSON was otherwise valid. **Plugin loading errors**: diff --git a/content/en/docs/claude-code/plugins.md b/content/en/docs/claude-code/plugins.md index ef97db7b1..189ba7d6d 100644 --- a/content/en/docs/claude-code/plugins.md +++ b/content/en/docs/claude-code/plugins.md @@ -134,7 +134,7 @@ This quickstart walks you through creating a plugin with a custom skill. You'll Greet the user named "$ARGUMENTS" warmly and ask how you can help them today. Make the greeting personal and encouraging. ``` - Run `/reload-plugins` to pick up the changes. The skills count in the summary covers only `commands/` directories, so it can report `0 skills` even though the skill you just edited reloaded. Then try the skill with your name: + Run `/reload-plugins` to pick up the changes. Then try the skill with your name: ```shell theme={null} /my-first-plugin:hello Alex diff --git a/content/en/docs/claude-code/security-guidance.md b/content/en/docs/claude-code/security-guidance.md index f6343fceb..c94b5c7a7 100644 --- a/content/en/docs/claude-code/security-guidance.md +++ b/content/en/docs/claude-code/security-guidance.md @@ -200,7 +200,7 @@ To remove it from your user scope: /plugin uninstall security-guidance@claude-plugins-official ``` -If the plugin was enabled through a project's `.claude/settings.json`, disabling it from `/plugin` writes an override to your `.claude/settings.local.json` rather than editing the checked-in file, so the plugin stays off for you while teammates are unaffected. The same dialog also offers to uninstall the plugin for everyone by removing it from the shared `.claude/settings.json`. If it was enabled through [managed settings](/docs/en/admin-setup), only an administrator can disable it. +If the plugin was enabled through a project's `.claude/settings.json`, uninstalling it from `/plugin` writes an override to your `.claude/settings.local.json` rather than editing the checked-in file, so the plugin stays off for you while teammates are unaffected. The same dialog also offers to uninstall the plugin for everyone by removing it from the shared `.claude/settings.json`. If it was enabled through [managed settings](/docs/en/admin-setup), only an administrator can disable it. ## How the plugin integrates with Claude Code diff --git a/content/en/docs/claude-code/server-managed-settings.md b/content/en/docs/claude-code/server-managed-settings.md index 40cafd92b..21d2b9a3f 100644 --- a/content/en/docs/claude-code/server-managed-settings.md +++ b/content/en/docs/claude-code/server-managed-settings.md @@ -227,13 +227,12 @@ With a saved claude.ai login: * If you sign out and back in, or switch to another organization and later return, Claude Code doesn't show the dialog again while those settings are unchanged, unless another account approved them for that organization in the same configuration directory in between. * If you sign in to the same organization with a different account, Claude Code shows the dialog again even when the settings are unchanged. That account's approval replaces the previous one, so when you switch back, Claude Code shows the dialog once more. -If an interactive session can't show the dialog, Claude Code doesn't apply the delivered settings and keeps the last-approved settings; the dialog appears in the next session that can show it. Requires Claude Code v2.1.211 or later. +Claude Code can't always show the dialog. Each case below says which settings apply when it can't and when you next see the dialog: -If an error closes the dialog before you answer, Claude Code doesn't apply the delivered settings and keeps the last-approved settings; Claude Code shows the dialog again in the next session that can show it. - - - A non-interactive run, such as `claude -p` or an Agent SDK session, can't show the dialog. When the delivered settings would require approval, Claude Code applies them for that run only: it doesn't record them as approved or write them to the [local cache](#fetch-and-caching-behavior), and the next interactive session shows the dialog. Until a user approves in an interactive session, each non-interactive run fetches the settings again at startup. Before v2.1.207, a non-interactive run saved the settings as approved, so later interactive sessions never showed the dialog for them. - +* **An interactive session that can't show the dialog**: Claude Code doesn't apply the delivered settings and keeps the last-approved settings. The dialog appears in the next session that can show it. Requires Claude Code v2.1.211 or later. +* **`claude install` or `claude update`**: Claude Code doesn't show the dialog during either command. The command runs with the last-approved settings, and the dialog appears in your next interactive session. If Claude Code waits for the settings fetch at startup, such as with [`forceRemoteSettingsRefresh`](#enforce-fail-closed-startup) set or on a [Claude apps gateway](/docs/en/claude-apps-gateway) deployment, it shows the dialog during the command instead, and an install run from a pipe fails; see [`Raw mode is not supported` during install](/docs/en/troubleshoot-install#raw-mode-is-not-supported-during-install). Before v2.1.246, Claude Code tried to show the dialog during these commands too. +* **An error closes the dialog before you answer**: Claude Code doesn't apply the delivered settings and keeps the last-approved settings. It shows the dialog again in the next session that can show it. +* **A non-interactive run**, such as `claude -p` or an Agent SDK session: Claude Code can't show the dialog, so when the delivered settings would require approval, it applies them for that run only. It doesn't record them as approved or write them to the [local cache](#fetch-and-caching-behavior), and the next interactive session shows the dialog. Until a user approves in an interactive session, each non-interactive run fetches the settings again at startup. Before v2.1.207, a non-interactive run saved the settings as approved, so later interactive sessions never showed the dialog for them. #### Environment variables and the approval dialog diff --git a/content/en/docs/claude-code/settings-reference.md b/content/en/docs/claude-code/settings-reference.md index 4da059b5a..c0b0c95fb 100644 --- a/content/en/docs/claude-code/settings-reference.md +++ b/content/en/docs/claude-code/settings-reference.md @@ -662,6 +662,7 @@ scope: "Which settings files can set the key: user (~/.claude/settings.json), pr | [`fallbackModel`](#fallbackmodel) | Name [backup models](/docs/en/model-config#fallback-model-chains) for when the primary is overloaded | Model and responses | Any file | | [`fastMode`](#fastmode) | Turn [fast mode](/docs/en/fast-mode) on for sessions where it's available | Model and responses | Any file | | [`fastModePerSessionOptIn`](#fastmodepersessionoptin) | Require people to turn [fast mode](/docs/en/fast-mode) on each session | Model and responses | Any file | +| [`feedbackDrafts`](#feedbackdrafts) | Control whether Claude queues [feedback drafts](/docs/en/tools-reference#sendfeedback-tool-behavior) for you to review | Privacy and telemetry | User or managed | | [`feedbackSurveyRate`](#feedbacksurveyrate) | Change how often the [session quality survey](/docs/en/data-usage#session-quality-surveys) appears | Privacy and telemetry | Any file | | [`fileCheckpointingEnabled`](#filecheckpointingenabled) | Turn off or on the file snapshots that [`/rewind`](/docs/en/checkpointing) restores | Memory and context | Any file | | [`fileSuggestion`](#filesuggestion) | Supply [`@` file autocomplete](/docs/en/interactive-mode#quick-commands) from your own command | Interface and terminal | Any file | @@ -763,7 +764,7 @@ scope: "Which settings files can set the key: user (~/.claude/settings.json), pr | [`skipWebFetchPreflight`](#skipwebfetchpreflight) | Skip the [WebFetch hostname check](/docs/en/tools-reference#webfetch-tool-behavior) when Anthropic is unreachable | Privacy and telemetry | Any file | | [`spellcheck`](#spellcheck) | Underline misspelled words in the prompt input with a [spell checker](/docs/en/interactive-mode#check-spelling-as-you-type) you install | Interface and terminal | User or managed | | [`spinnerTipsEnabled`](#spinnertipsenabled) | Hide tips in the spinner while Claude works | Interface and terminal | Any file | -| [`spinnerTipsOverride`](#spinnertipsoverride) | Replace or extend spinner tips with your own strings | Interface and terminal | Any file | +| [`spinnerTipsOverride`](#spinnertipsoverride) | Add your own tips to the spinner rotation, or replace the built-in tips | Interface and terminal | Any file | | [`spinnerVerbs`](#spinnerverbs) | Add or replace the verbs shown while a turn runs | Interface and terminal | Any file | | [`sshConfigs`](#sshconfigs) | Add [SSH connections](/docs/en/desktop#pre-configure-ssh-connections-for-your-team) to the Desktop environment dropdown | Remote, desktop, and notifications | User or managed | | [`sshHostAllowlist`](#sshhostallowlist) | Limit which hosts [Desktop SSH sessions](/docs/en/desktop#restrict-which-ssh-hosts-users-can-connect-to) can reach | Remote, desktop, and notifications | Managed | @@ -3058,23 +3059,66 @@ While Claude works, the spinner line rotates through short tips about Claude Cod ### `spinnerTipsOverride` -Replace or extend the [spinner tips](#spinnertipsenabled), the short hints Claude Code rotates through while Claude works, with your own strings, such as a team reminder to run a review skill. Set `excludeDefault` to `true` and list at least one tip to show only your tips; when it's `false` or absent, or `tips` is empty, Claude Code keeps the built-in tips and adds yours. +Add your own tips to the [spinner tips](#spinnertipsenabled) that Claude Code shows while Claude works, or replace the built-in tips with yours. Claude Code puts your tips in the same rotation as the built-in ones: it picks the tip that has gone unshown the longest, skips tips still in their cooldown, and breaks ties by priority. -* **Scope**: [`Any file`](#scopes) -* **Type**: object with a `tips` array of strings and an optional `excludeDefault` Boolean +If you set [`spinnerTipsEnabled`](#spinnertipsenabled) to `false`, Claude Code hides all tips, yours included. + +* **Scope**: [`Any file`](#scopes). Claude Code honors tip objects, `tipsFile`, `label`, and `excludeDefault` from user settings, the `--settings` flag, and managed settings; from project and local settings it reads plain string tips only. +* **Type**: object with `tips`, `tipsFile`, `label`, and `excludeDefault` fields, each optional * **Default**: unset, so Claude Code shows only the built-in tips -This example replaces the built-in tips with a single tip of your own: +Tip objects, `tipsFile`, `label`, and the Scope line's rule that project and local settings contribute plain strings only require Claude Code v2.1.247 or later. On earlier versions, a project or local file's `excludeDefault` applies too. + +Each `tips` entry is a plain string or an object with these fields: + +| Field | Required | Description | +| :----------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | Yes | Up to 64 letters, digits, `.`, `_`, or `-`. Claude Code keys the tip's show history on it, so the tip's cooldown survives reordering the list. Of two entries with the same id, Claude Code uses the first | +| `text` | Yes | The tip, one line of up to 500 characters. Claude Code strips ANSI escapes and control characters and collapses whitespace | +| `cooldownSessions` | No | Sessions Claude Code waits before showing the tip again, `0` to `1000`, default `0` | +| `priority` | No | Order among tips that have gone unshown equally long, higher first, `-10` to `10`, default `0` | + +Claude Code reads a plain string as a tip with those defaults and a position-based id, so its show history resets when you reorder the list. Give a tip an `id` to keep its history across edits. + +Claude Code reads at most 200 tips across `tips` and `tipsFile`, and drops an invalid entry with a debug warning instead of rejecting the settings file. + +Use the remaining fields to name a tips file, set the prefix, and hide the built-in tips: + +* `tipsFile`: an absolute or `~/` path to a local JSON file holding an array of the same entries, or an object with a `tips` array, up to 256 KB. Claude Code reads the file once per process, so it loads your edits at the next start. You can't set it through [server-managed settings](/docs/en/server-managed-settings); deploy inline `tips` there, or deploy the path in an on-disk `managed-settings.json`. +* `label`: the prefix Claude Code shows before tips from user, `--settings`, and managed settings, up to 40 characters. The default is `Tip`, the same prefix as the built-in tips, and tips from project and local settings always use it. +* `excludeDefault`: set it to `true` to hide the built-in tips and show only yours. When Claude Code can't load any of your tips, for example because `tipsFile` doesn't exist or every entry is invalid, it keeps the built-in rotation instead of an empty spinner. + +When more than one settings file sets the key, Claude Code shows tips from all of them and takes `tipsFile`, `label`, and `excludeDefault` from whichever of managed settings, the `--settings` flag, and user settings is the highest-precedence one that sets each. + +This example, in your user settings, adds a plain string tip and an object tip to the rotation under the `Acme tip` prefix: ```json settings.json theme={null} { "spinnerTipsOverride": { - "excludeDefault": true, - "tips": ["Run /review before opening a PR"] + "label": "Acme tip", + "tips": [ + "Run /review before opening a PR", + { + "id": "gateway-errors", + "text": "Seeing 5xx errors? Check the gateway status page first", + "cooldownSessions": 5, + "priority": 2 + } + ] } } ``` +Each field in the example changes one thing about how Claude Code shows the tips: + +* `label`: Claude Code shows both tips as `Acme tip: ...` instead of `Tip: ...`. +* The plain string: Claude Code gives it the defaults, so it can come up again in the very next session. +* `id`: Claude Code keys the second tip's show history on `gateway-errors`, so its cooldown still applies after you add or reorder tips. +* `cooldownSessions`: after Claude Code shows the `gateway-errors` tip, it doesn't show that tip again until five sessions later. +* `priority`: when the `gateway-errors` tip and another tip have gone unshown for the same number of sessions, for example when neither has been shown yet, Claude Code shows `gateway-errors` first. The plain string has the default priority, `0`. + +While Claude works, Claude Code shows your tips in the spinner with your prefix, such as `Acme tip: Run /review before opening a PR`. + ### `spinnerVerbs` While a turn is in progress, the spinner shows a rotating verb such as "Accomplishing", "Architecting", or "Baking". Use this key to add your own verbs to that rotation or replace the built-in list with yours. @@ -5141,7 +5185,7 @@ The desktop app ignores any other value, and a value that isn't a Boolean, such ## Privacy and telemetry -Control how long Claude Code keeps session data and what it sends. The switches that turn off usage metrics and error reports are environment variables, not settings keys: set `DISABLE_TELEMETRY`, `DISABLE_ERROR_REPORTING`, or `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` in the [`env`](#env) key or in the shell. [Telemetry services](/docs/en/data-usage#telemetry-services) says what each one stops. The session survey is the exception: [`feedbackSurveyRate`](#feedbacksurveyrate) below turns it off from a settings file. +Control how long Claude Code keeps session data and what it sends. The switches that turn off usage metrics and error reports are environment variables, not settings keys: set `DISABLE_TELEMETRY`, `DISABLE_ERROR_REPORTING`, or `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` in the [`env`](#env) key or in the shell. [Telemetry services](/docs/en/data-usage#telemetry-services) says what each one stops. Two exceptions turn off from a settings file: [`feedbackDrafts`](#feedbackdrafts) below for Claude-drafted feedback, and [`feedbackSurveyRate`](#feedbacksurveyrate) below for the session survey. ### `cleanupPeriodDays` @@ -5159,6 +5203,26 @@ Set how many days Claude Code keeps [session transcripts and other application d Setting `0` fails validation, so pick a large value such as `3650` for long retention. To stop Claude Code from writing transcripts at all, see [Plaintext storage](/docs/en/claude-directory#plaintext-storage). +### `feedbackDrafts` + +Control [Claude-drafted feedback](/docs/en/tools-reference#sendfeedback-tool-behavior): whether Claude can queue feedback drafts for you to review, and whether Claude Code shows a card when Claude queues one. + +* **Scope**: [`User or managed`](#scopes) +* **Type**: string, one of `"notify"`, `"quiet"`, or `"off"` + * `"notify"`: Claude Code shows a card above the prompt when Claude queues a draft, up to [three cards in a session](/docs/en/tools-reference#what-you-see-when-claude-drafts) by default + * `"quiet"`: Claude drafts without a card. You see the count of queued drafts in the prompt footer and review them in `/feedback` + * `"off"`: Claude Code removes the SendFeedback tool, so Claude can't queue drafts +* **Default**: `"notify"` +* **Per-session overrides**: [`CLAUDE_CODE_SEND_FEEDBACK`](/docs/en/env-vars) set to `0` turns the feature off for one session + +```json settings.json theme={null} +{ + "feedbackDrafts": "quiet" +} +``` + +Appears in `/config` as **Claude-drafted feedback**, which writes this key to your user settings. You see the `/config` row only in sessions [where Claude can draft feedback](/docs/en/tools-reference#sessions-without-claude-drafted-feedback); setting `"off"` doesn't hide it, so you can turn the feature back on from the same row. A value in managed settings takes precedence over your user setting, so when an administrator sets this key, the row shows the managed value and changing it has no effect. Claude Code ignores this key in project and local settings. + ### `feedbackSurveyRate` Set the probability that the [session quality survey](/docs/en/data-usage#session-quality-surveys) appears when a session is eligible for it. Set `0` to keep the survey from appearing. diff --git a/content/en/docs/claude-code/skills.md b/content/en/docs/claude-code/skills.md index 226615ede..6146de4ad 100644 --- a/content/en/docs/claude-code/skills.md +++ b/content/en/docs/claude-code/skills.md @@ -373,7 +373,7 @@ The table below shows where the command name comes from for each layout: | Plugin `skills/` subdirectory | Frontmatter `name` or the directory name, namespaced by plugin | `my-plugin/skills/review/SKILL.md` → `/my-plugin:review`, or `/my-plugin:fancy` with `name: fancy` | | Plugin root `SKILL.md` | Frontmatter `name`, with the plugin directory name as a fallback | `my-plugin/SKILL.md` with `name: review` → `/my-plugin:review`. See [Path behavior rules](/docs/en/plugins-reference#path-behavior-rules) | -In a plugin skill, the frontmatter `name` replaces the directory name in the last segment of the command, so `my-plugin/skills/review/SKILL.md` with `name: fancy` becomes `/my-plugin:fancy`. The bare `/fancy` also invokes the skill unless another command already uses that name. Before v2.1.216, the frontmatter name replaced the whole command name, so the menu showed `/fancy` without the plugin prefix and `/my-plugin:fancy` didn't autocomplete. +In a plugin skill, the frontmatter `name` replaces the directory name in the last segment of the command, so `my-plugin/skills/review/SKILL.md` with `name: fancy` becomes `/my-plugin:fancy`. The bare `/fancy` also invokes the skill unless another command already uses that name. If the `name` you write already starts with the plugin's own prefix, Claude Code doesn't add the prefix again on v2.1.246 or later. For example, `name: my-plugin:fancy` still becomes `/my-plugin:fancy`. From v2.1.216 through v2.1.245, Claude Code doubled the prefix when the `name` already carried it. In [non-interactive sessions](/docs/en/headless), Claude Code doesn't reserve the names `help` and `feedback` for their terminal-only built-in commands, so a plugin skill with one of those names keeps its bare command there. Claude Code still reserves the name of every other terminal-only built-in, such as `/login`, even though the command can't run in those sessions. In those sessions Claude Code also skips a synced skill named `help` or `feedback`, because it [skips a synced skill](#when-a-synced-skill-name-matches-another-command) whose name matches any built-in command whether or not that command can run. From v2.1.216 through v2.1.220, `help` and `feedback` were reserved too, so a plugin skill with one of those names was invocable only by its namespaced command in non-interactive sessions. @@ -558,19 +558,19 @@ To access individual arguments by position, use `$ARGUMENTS[N]` or the shorter ` ```yaml theme={null} --- name: migrate-component -description: Migrate a component from one framework to another +description: Migrate a component from one language to another --- Migrate the $ARGUMENTS[0] component from $ARGUMENTS[1] to $ARGUMENTS[2]. Preserve all existing behavior and tests. ``` -Running `/migrate-component SearchBar React Vue` replaces `$ARGUMENTS[0]` with `SearchBar`, `$ARGUMENTS[1]` with `React`, and `$ARGUMENTS[2]` with `Vue`. The same skill using the `$N` shorthand: +Running `/migrate-component SearchBar JavaScript TypeScript` replaces `$ARGUMENTS[0]` with `SearchBar`, `$ARGUMENTS[1]` with `JavaScript`, and `$ARGUMENTS[2]` with `TypeScript`. The same skill using the `$N` shorthand: ```yaml theme={null} --- name: migrate-component -description: Migrate a component from one framework to another +description: Migrate a component from one language to another --- Migrate the $0 component from $1 to $2. diff --git a/content/en/docs/claude-code/slack.md b/content/en/docs/claude-code/slack.md index 7dc6a5024..f355aff72 100644 --- a/content/en/docs/claude-code/slack.md +++ b/content/en/docs/claude-code/slack.md @@ -177,7 +177,7 @@ for more details. ### "Claude Code is not enabled for your account" -This error means your Claude account has no cloud environment yet, not that an admin needs to enable anything. Sign in at [claude.ai/code](https://claude.ai/code) once with the same account you connected to Slack. The first visit creates your default cloud environment, and the error clears on your next mention. Each user must do this individually. +This error means your Claude account has no cloud environment yet. Sign in at [claude.ai/code](https://claude.ai/code) once with the same account you connected to Slack and finish [web onboarding](/docs/en/web-quickstart#connect-github), which creates your default cloud environment or asks you to create it. The error clears on your next mention. Each user must do this individually. ### Sessions not starting diff --git a/content/en/docs/claude-code/slash-commands.md b/content/en/docs/claude-code/slash-commands.md index 226615ede..6146de4ad 100644 --- a/content/en/docs/claude-code/slash-commands.md +++ b/content/en/docs/claude-code/slash-commands.md @@ -373,7 +373,7 @@ The table below shows where the command name comes from for each layout: | Plugin `skills/` subdirectory | Frontmatter `name` or the directory name, namespaced by plugin | `my-plugin/skills/review/SKILL.md` → `/my-plugin:review`, or `/my-plugin:fancy` with `name: fancy` | | Plugin root `SKILL.md` | Frontmatter `name`, with the plugin directory name as a fallback | `my-plugin/SKILL.md` with `name: review` → `/my-plugin:review`. See [Path behavior rules](/docs/en/plugins-reference#path-behavior-rules) | -In a plugin skill, the frontmatter `name` replaces the directory name in the last segment of the command, so `my-plugin/skills/review/SKILL.md` with `name: fancy` becomes `/my-plugin:fancy`. The bare `/fancy` also invokes the skill unless another command already uses that name. Before v2.1.216, the frontmatter name replaced the whole command name, so the menu showed `/fancy` without the plugin prefix and `/my-plugin:fancy` didn't autocomplete. +In a plugin skill, the frontmatter `name` replaces the directory name in the last segment of the command, so `my-plugin/skills/review/SKILL.md` with `name: fancy` becomes `/my-plugin:fancy`. The bare `/fancy` also invokes the skill unless another command already uses that name. If the `name` you write already starts with the plugin's own prefix, Claude Code doesn't add the prefix again on v2.1.246 or later. For example, `name: my-plugin:fancy` still becomes `/my-plugin:fancy`. From v2.1.216 through v2.1.245, Claude Code doubled the prefix when the `name` already carried it. In [non-interactive sessions](/docs/en/headless), Claude Code doesn't reserve the names `help` and `feedback` for their terminal-only built-in commands, so a plugin skill with one of those names keeps its bare command there. Claude Code still reserves the name of every other terminal-only built-in, such as `/login`, even though the command can't run in those sessions. In those sessions Claude Code also skips a synced skill named `help` or `feedback`, because it [skips a synced skill](#when-a-synced-skill-name-matches-another-command) whose name matches any built-in command whether or not that command can run. From v2.1.216 through v2.1.220, `help` and `feedback` were reserved too, so a plugin skill with one of those names was invocable only by its namespaced command in non-interactive sessions. @@ -558,19 +558,19 @@ To access individual arguments by position, use `$ARGUMENTS[N]` or the shorter ` ```yaml theme={null} --- name: migrate-component -description: Migrate a component from one framework to another +description: Migrate a component from one language to another --- Migrate the $ARGUMENTS[0] component from $ARGUMENTS[1] to $ARGUMENTS[2]. Preserve all existing behavior and tests. ``` -Running `/migrate-component SearchBar React Vue` replaces `$ARGUMENTS[0]` with `SearchBar`, `$ARGUMENTS[1]` with `React`, and `$ARGUMENTS[2]` with `Vue`. The same skill using the `$N` shorthand: +Running `/migrate-component SearchBar JavaScript TypeScript` replaces `$ARGUMENTS[0]` with `SearchBar`, `$ARGUMENTS[1]` with `JavaScript`, and `$ARGUMENTS[2]` with `TypeScript`. The same skill using the `$N` shorthand: ```yaml theme={null} --- name: migrate-component -description: Migrate a component from one framework to another +description: Migrate a component from one language to another --- Migrate the $0 component from $1 to $2. diff --git a/content/en/docs/claude-code/terminal-config.md b/content/en/docs/claude-code/terminal-config.md index 9f73d9f18..79467b2b5 100644 --- a/content/en/docs/claude-code/terminal-config.md +++ b/content/en/docs/claude-code/terminal-config.md @@ -34,6 +34,11 @@ For VS Code, Cursor, Devin Desktop, Alacritty, and Zed, `/terminal-setup` writes In VS Code, Cursor, and Devin Desktop, `/terminal-setup` also updates two editor settings: it sets `terminal.integrated.gpuAcceleration` to `"off"` to prevent garbled text in the integrated terminal, and it sets `terminal.integrated.mouseWheelScrollSensitivity` for smoother scrolling in [fullscreen mode](/docs/en/fullscreen). To undo the GPU acceleration change, set it back to `"auto"` and reload the editor window. Before v2.1.157, `/terminal-setup` left GPU acceleration unchanged. +In Zed, `/terminal-setup` updates your `keymap.json` in place: + +* If the keymap already has bindings and none of them is a Terminal `shift-enter`, Claude Code first backs it up to a copy in the same directory, such as `keymap.json.1a2b3c4d.bak`, then merges the Shift+Enter binding into your keymap, keeping your other keybindings and comments +* If Claude Code can't read or parse the keymap, can't back it up, or can't verify the merged result, it [leaves the file unchanged and prints the keybinding block to add yourself](/docs/en/errors#terminal-setup-left-your-zed-keymap-unchanged) + If you are running inside tmux, Shift+Enter also requires the [tmux configuration below](#configure-tmux) even when the outer terminal supports it. To bind newline to a different key, or to swap behavior so Enter inserts a newline and Shift+Enter submits, map the `chat:newline` and `chat:submit` actions in your [keybindings file](/docs/en/keybindings). diff --git a/content/en/docs/claude-code/tools-reference.md b/content/en/docs/claude-code/tools-reference.md index 770f06be2..3852dfe7d 100644 --- a/content/en/docs/claude-code/tools-reference.md +++ b/content/en/docs/claude-code/tools-reference.md @@ -45,6 +45,7 @@ To add custom tools, connect an [MCP server](/docs/en/mcp). To extend Claude wit | `RemoteTrigger` | Creates, updates, runs, and lists [Routines](/docs/en/routines) on claude.ai. Backs the `/schedule` command. The [`RemoteTrigger` input reference](/docs/en/agent-sdk/typescript#remotetrigger) documents every action and the organization policies that remove the tool. Routines live on claude.ai and require a Pro, Max, Team, or Enterprise plan, so this tool is not accessible from Amazon Bedrock, Claude Platform on AWS, Google Cloud's Agent Platform, or Microsoft Foundry. Also unavailable when you turn off [feature-flag fetching](/docs/en/env-vars#features-that-need-feature-flag-fetching) | No | | `ReportFindings` | Reports code-review findings as a structured list, with a file, summary, and failure scenario per finding, so Claude Code can render them instead of printing them as text. Claude calls it when active code-review instructions tell it to. Requires Claude Code v2.1.196 or later. As of v2.1.199, a finding can also carry an optional `category` slug, such as `correctness` or `test-coverage`, shown next to the file location in the rendered list | No | | `ScheduleWakeup` | Reschedules the next iteration of a [self-paced `/loop`](/docs/en/scheduled-tasks#let-claude-choose-the-interval). Claude calls this at the end of each iteration to pick when the next one runs, between one minute and one hour out; you don't call it directly. To end the loop instead, Claude calls it with `stop: true`, which cancels the pending wakeup. The `stop` field requires Claude Code v2.1.202 or later. The pending wakeup appears in `session_crons` in [Stop hook input](/docs/en/hooks#stop-input). Not available on Amazon Bedrock, Claude Platform on AWS, Google Cloud's Agent Platform, or Microsoft Foundry, where a `/loop` prompt with no interval runs on a fixed schedule instead. The same happens when you turn off [feature-flag fetching](/docs/en/env-vars#features-that-need-feature-flag-fetching) | No | +| `SendFeedback` | Drafts a feedback report about Claude Code, covering a product problem or Claude's own behavior in the session, and queues it on your machine for you to review. Claude Code sends nothing until you choose to send the draft. See [SendFeedback tool behavior](#sendfeedback-tool-behavior). Requires Claude Code v2.1.238 or later | No | | `SendMessage` | Sends a message to another agent: an [agent team](/docs/en/agent-teams) teammate, a [subagent it resumes](/docs/en/sub-agents#resume-subagents) by agent ID or name, or one of your other Claude Code sessions, on this machine or beyond it. Messaging other sessions requires Claude Code v2.1.224 or later; [cross-session messaging](/docs/en/cross-session-messaging) covers which sessions Claude can reach and each case's requirements. A receiver never treats a message from another agent as your consent or approval. Claude can include an optional `summary` input, typically 5-10 words, that Claude Code shows as a one-line preview. When Claude omits it on a [plain-text message](/docs/en/cross-session-messaging#limitations), Claude Code uses the first line of the message as the summary. Claude Code truncates a summary longer than 200 characters with an ellipsis. With the `notify_when_idle` input, Claude can ask one of your other sessions on this machine to [send one notice when it next goes idle or exits](/docs/en/cross-session-messaging#get-a-notice-when-another-session-goes-idle). Requires Claude Code v2.1.236 or later in both sessions | No | | `SendUserFile` | Sends files from the session to you with an optional caption, so a generated report, diagram, screenshot, or built artifact reaches your device instead of only being mentioned in the transcript. As of v2.1.196, the optional `display` input controls presentation: `render` opens the file inline in the client, `attach` shows a download card only, and when unset the client decides by file type. Available when a [Remote Control](/docs/en/remote-control) client is connected or the session runs in a managed cloud environment such as [Claude Code on the web](/docs/en/claude-code-on-the-web). Delivery runs through Anthropic-hosted infrastructure, so the tool is not available on Amazon Bedrock, Google Cloud's Agent Platform, or Microsoft Foundry | No | | `ShareOnboardingGuide` | Uploads `ONBOARDING.md` and returns a share link teammates can open in Claude Code. Called from `/team-onboarding` after the guide is written. Available to claude.ai subscribers on Pro, Max, Team, and Enterprise plans | Yes | @@ -429,6 +430,64 @@ Read handles several file types beyond plain text: Read only reads files, not directories. Claude lists directory contents with a shell command such as `ls`. +## SendFeedback tool behavior + +Claude-drafted feedback is a feedback report about Claude Code that Claude writes for you. It requires Claude Code v2.1.238 or later. Claude Code saves each draft on your machine under `~/.claude/feedback/drafts/`, and nothing reaches Anthropic until you send it. Claude drafts one with the SendFeedback tool when: + +* A tool or command keeps failing +* It can't help with something you asked for +* You point out a mistake it made, or it notices one +* You ask it to file feedback + +### What you see when Claude drafts + +After Claude queues a draft, you see a card above your prompt with the draft's title. Press `1` to review the draft, press `2` twice to send it as written, or press `0` to dismiss it. A dismissed draft stays in your queue. After you dismiss a card, Claude Code asks whether to turn Claude-drafted feedback off. It stops asking once you've declined twice. + +By default, you see at most three cards in a session; Anthropic can adjust that limit from the server without a release. After the limit, and whenever you set [`feedbackDrafts`](/docs/en/settings-reference#feedbackdrafts) to `quiet`, you see only a count of queued drafts in the prompt footer. + +### Review and edit a draft + +Run `/feedback` with no argument to open your queue. It lists every queued draft from all your sessions, including drafts whose cards you dismissed or never saw. Select a draft to open it for review, where you can: + +* Edit the title, area, and details +* Set **Send transcript** to `yes` or `no`. When the transcript from the session where Claude queued the draft is still available, it starts at `yes`, which sends that conversation to Anthropic; `no` sends the report only +* Send the draft, discard it, or leave it in the queue for later + +To write a report yourself instead, press `w` for the standard feedback dialog. `/feedback` with text after it, and `/bug`, open that dialog directly. + +### Send a draft + +When you send a draft, Claude Code submits it the same way as a `/feedback` report, with the same [retention](/docs/en/data-usage#feedback-using-the-%2Ffeedback-command), and deletes the draft from your machine. When you send from the card, it shows `✓ Sent`; when you send from the queue, it closes with a receipt ID. + +The report carries: + +* Your title, area, and details +* Environment info, such as your Claude Code version, operating system, and model +* The IDs of recent API requests +* The conversation transcript, when you left **Send transcript** at `yes` in the review screen. Sending from the card never includes the transcript + +Claude Code keeps your working directory in the local draft so it can find the transcript, and doesn't send the directory. + +In [organizations with zero data retention](/docs/en/zero-data-retention#features-disabled-under-zdr), Claude Code leaves the tool out, as it does for `/feedback`. If a session in such an organization still offers the tool, drafts stay on your machine, and sending fails with `Feedback collection is not available for organizations with custom data retention policies.` + +### Discard or keep a draft + +When you discard a draft, Claude Code deletes it from your machine. A draft you leave in the queue expires after 30 days, or after [`cleanupPeriodDays`](/docs/en/settings-reference#cleanupperioddays) when that's shorter. The queue holds 10 drafts across all your sessions, and when Claude queues an eleventh, Claude Code deletes the oldest. When you run `/exit` with drafts from the session still in the queue, Claude Code asks whether to review them or discard them before exiting. + +### Turn Claude-drafted feedback off + +Set **Claude-drafted feedback** to `off` in `/config`, which writes the [`feedbackDrafts`](/docs/en/settings-reference#feedbackdrafts) setting, or set [`CLAUDE_CODE_SEND_FEEDBACK=0`](/docs/en/env-vars) for one session. With either, Claude can't queue drafts. To keep drafting on without cards, set `feedbackDrafts` to `quiet` instead. Administrators can set `feedbackDrafts` in [managed settings](/docs/en/managed-settings), which takes precedence over your own setting. + +### Sessions without Claude-drafted feedback + +Claude Code includes the tool in interactive terminal sessions on your own machine that use the Claude API rather than a cloud provider. It leaves the tool out of: + +* Non-interactive `-p` runs and [Agent SDK](/docs/en/agent-sdk/overview) sessions, which have no screen to review the queue on +* Cloud sessions such as [Claude Code on the web](/docs/en/claude-code-on-the-web), which can't write to the queue on your machine +* Sessions on [Amazon Bedrock](/docs/en/amazon-bedrock), [Claude Platform on AWS](/docs/en/claude-platform-on-aws), [Google Cloud's Agent Platform](/docs/en/google-vertex-ai), or [Microsoft Foundry](/docs/en/microsoft-foundry) +* Sessions where you set [`CLAUDE_CODE_SEND_FEEDBACK=0`](/docs/en/env-vars) or [`DISABLE_FEEDBACK_COMMAND=1`](/docs/en/env-vars), set `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` to any non-empty value, or turned off [feature-flag fetching](/docs/en/env-vars#features-that-need-feature-flag-fetching) +* Organizations that have turned off product feedback, and [organizations with zero data retention](/docs/en/zero-data-retention#features-disabled-under-zdr) + ## Task tool availability In Claude Code v2.1.233 and later, the following tools aren't available on Opus 4.8, Sonnet 5, Fable 5, Mythos 5, or later versions of those families unless you opt in: `TodoWrite`, `TaskCreate`, `TaskGet`, `TaskUpdate`, and `TaskList`. Those models keep track of multi-step work without a written checklist, and the tools' definitions and reminders take up context, so Claude Code leaves them out. Without them, Claude adds nothing to the [task list](/docs/en/interactive-mode#task-list) while it works. On any other model, such as Opus 4.7, Claude Code provides the four Task tools by default and `TodoWrite` only when you set [`CLAUDE_CODE_ENABLE_TASKS=0`](/docs/en/env-vars). diff --git a/content/en/docs/claude-code/troubleshoot-install.md b/content/en/docs/claude-code/troubleshoot-install.md index c724dd43c..c875ff6df 100644 --- a/content/en/docs/claude-code/troubleshoot-install.md +++ b/content/en/docs/claude-code/troubleshoot-install.md @@ -19,6 +19,7 @@ Match the error message or symptom you're seeing to a fix: | `curl: (22) The requested URL returned error: 403` | [Install script returned 403](#install-script-returns-html-instead-of-a-shell-script) | | `curl: (23)` or `curl: (56) Failure writing output to destination` | [Check connectivity or use an alternative installer](#curl-56-failure-writing-output-to-destination) | | `Killed` during install on Linux, or `Installation was killed before it could finish (exit code 137)` | [Free memory or add swap space](#install-killed-on-low-memory-linux-servers) | +| `Raw mode is not supported` during install | [Rerun the installer](#raw-mode-is-not-supported-during-install) | | `TLS connect error` or `SSL/TLS secure channel` | [Update CA certificates](#tls-or-ssl-connection-errors) | | `Failed to fetch version` or can't reach download server | [Check network and proxy settings](#check-network-connectivity) | | `irm is not recognized` or `&& is not valid` | [Use the right command for your shell](#wrong-install-command-on-windows) | @@ -638,6 +639,30 @@ When installing Claude Code in a Docker container, installing as root into `/` c 2. **Give Docker more memory** if using Docker Desktop. Build containers share the memory allocated to the Docker Desktop virtual machine, so open **Settings > Resources** in Docker Desktop, raise the memory limit, and rerun the build. +### `Raw mode is not supported` during install + +When your organization's [server-managed settings](/docs/en/server-managed-settings) include changes that need [security approval](/docs/en/server-managed-settings#security-approval-dialogs), Claude Code versions before 2.1.246 try to show the approval dialog during `claude install`. The dialog needs a terminal on stdin. When the installer runs `claude install` from a pipe, as `curl -fsSL https://claude.ai/install.sh | bash` does, stdin is the pipe rather than a terminal, so the install fails with an error containing `Raw mode is not supported`. + +Claude Code v2.1.246 and later don't show the dialog during `claude install` or `claude update`. The command runs with the settings you last approved, and Claude Code shows the dialog in your next interactive session. If your organization's startup configuration [waits for the settings fetch](/docs/en/server-managed-settings#enforce-fail-closed-startup), such as when it sets `forceRemoteSettingsRefresh`, the dialog still appears during these commands, and an install run from a pipe still fails. + +In every other configuration, rerunning the installer gets past this error, because the script runs the latest release's `install` command even when you ask it to install an older version. Rerun the command for your platform: + + + + ```bash theme={null} + curl -fsSL https://claude.ai/install.sh | bash + ``` + + + + ```powershell theme={null} + irm https://claude.ai/install.ps1 | iex + ``` + + + +`claude --version` prints the version the rerun installed. + ### `claude update` or `claude doctor` hangs `claude update` and `claude doctor` scan your shell configuration files for an outdated `claude` alias: `~/.zshrc`, `~/.bashrc`, and `~/.config/fish/config.fish`, plus on macOS the first of `~/.bash_profile`, `~/.bash_login`, or `~/.profile` that exists. If you set `ZDOTDIR`, the Zsh file is `$ZDOTDIR/.zshrc` instead. When one of those paths is a directory, Claude Code skips it and both commands complete normally. Before v2.1.214, a directory at one of those paths made both commands hang and left the System diagnostics section of `/status` blank. `claude doctor` hung with no output; `claude update` hung right after printing `Checking for updates`. diff --git a/content/en/docs/claude-code/web-quickstart.md b/content/en/docs/claude-code/web-quickstart.md index af3c2088c..c34f2c4ff 100644 --- a/content/en/docs/claude-code/web-quickstart.md +++ b/content/en/docs/claude-code/web-quickstart.md @@ -52,19 +52,30 @@ See the [terminal quickstart](/docs/en/quickstart), [Desktop app](/docs/en/deskt ## Connect GitHub -Setup is a one-time process. If you already use the GitHub CLI, you can [do this from your terminal](#connect-from-your-terminal) instead of the browser. +Connecting GitHub is a one-time step. If you already use the GitHub CLI, you can [do this from your terminal](#connect-from-your-terminal) instead of the browser. + + + On Team and Enterprise plans, the **Sign in with GitHub** step works only after an [Owner](/docs/en/server-managed-settings#access-control) of your Claude organization turns on the GitHub connector at [**Admin settings > Connectors**](https://claude.ai/admin-settings/connectors). Until then, that step shows "GitHub access is required for Claude Code on the web" instead of a sign-in button. After the connector is on, reload [claude.ai/code](https://claude.ai/code) and start again from the first step. A second toggle, [Quick web setup](/docs/en/claude-code-on-the-web#github-authentication-options) at [**Admin settings > Claude Code**](https://claude.ai/admin-settings/claude-code), is optional: with it on, `/web-setup` works and onboarding creates the environment for members. + - Go to [claude.ai/code](https://claude.ai/code) and sign in with your Anthropic account. + Go to [claude.ai/code](https://claude.ai/code) and sign in with your claude.ai account. On macOS or Windows, the first screen offers the Claude Code desktop app and other ways to install Claude Code. To stay in the browser, click **Continue on web** at the bottom of the page. - - After signing in, claude.ai/code prompts you to connect GitHub. Follow the prompt to install the Claude GitHub App and grant it access to your repositories. Cloud sessions work with existing GitHub repositories, so to start a new project, [create an empty repository on GitHub](https://github.com/new) first. + + After you sign in, claude.ai/code prompts you to connect GitHub. Follow the prompt, and claude.ai/code sends you to GitHub's authorization page. Approve the authorization request, and GitHub returns you to claude.ai/code. Cloud sessions work with existing GitHub repositories and can reach any repository your GitHub account can see. To start a new project, [create an empty repository on GitHub](https://github.com/new) first. + + When Quick web setup is off, which it is by default on Team and Enterprise plans, claude.ai/code then asks you to install the Claude GitHub App on your repositories unless it's already installed. Install it if you want [Auto-fix](/docs/en/claude-code-on-the-web#auto-fix-pull-requests), which lets Claude respond to CI failures and review comments on pull requests in those repositories; otherwise click **Skip**. Either way, sessions can reach the same repositories. - - If you don't have an environment yet, onboarding creates a [cloud environment](/docs/en/cloud-environments) named **Default** for you when you finish connecting GitHub; if onboarding shows an environment form instead, keep its defaults to create the same **Default** environment. The environment controls what network access Claude has during sessions and what runs when a new session is created. **Default** uses [`Trusted` network access](/docs/en/cloud-environments#access-levels): sessions reach [common package registries](/docs/en/cloud-environments#default-allowed-domains) and other allowlisted domains, and nothing else through the session's network. See [Installed tools](/docs/en/cloud-environments#installed-tools) for what's available without any configuration. + + A [cloud environment](/docs/en/cloud-environments) is the saved configuration that controls what network access Claude has during sessions and what runs when a session starts. What happens after you connect GitHub depends on your plan: + + * **Pro and Max**: onboarding creates an environment named **Default** for you. + * **Team and Enterprise**: onboarding shows a **Create your first cloud environment** form. Leave the prefilled name and network access unchanged and click **Create & finish** to create the **Default** environment. If an Owner has turned on [Quick web setup](/docs/en/claude-code-on-the-web#github-authentication-options), onboarding creates **Default** for you instead. + + **Default** uses [`Trusted` network access](/docs/en/cloud-environments#access-levels): sessions reach [common package registries](/docs/en/cloud-environments#default-allowed-domains) and other allowlisted domains, and nothing else through the session's network. See [Installed tools](/docs/en/cloud-environments#installed-tools) for what's available without any configuration. For a first project, the **Default** environment works as is. To change its network access, add environment variables, or run a [setup script](/docs/en/cloud-environments#setup-scripts) before sessions start, [edit it or create additional environments](/docs/en/cloud-environments#configure-your-environment). @@ -72,7 +83,7 @@ Setup is a one-time process. If you already use the GitHub CLI, you can [do this ### Connect from your terminal -If you already use the GitHub CLI (`gh`), you can set up Claude Code on the web without opening a browser. This requires the [Claude Code CLI](/docs/en/quickstart). `/web-setup` reads your local `gh` token, links it to your Claude account, and creates a default cloud environment if you don't have one. +If you already use the GitHub CLI (`gh`), you can set up Claude Code on the web without opening a browser. This requires the [Claude Code CLI](/docs/en/quickstart). `/web-setup` reads your local `gh` token, links it to your claude.ai account, and creates the **Default** cloud environment if you don't have one. On Team and Enterprise plans, `/web-setup` is available only after an Owner turns on [Quick web setup](/docs/en/claude-code-on-the-web#github-authentication-options). Organizations with [Zero Data Retention](/docs/en/zero-data-retention) enabled cannot use `/web-setup` or other cloud session features. If the GitHub CLI isn't installed or authenticated, `/web-setup` opens the browser onboarding flow instead. @@ -195,13 +206,9 @@ If `/web-setup` responds with "Not signed in to Claude. Run /login first.", the `/web-setup` runs inside the Claude Code CLI, not your shell. Launch `claude` first, then type `/web-setup` at the prompt. -If you typed it inside Claude Code and the command menu shows `No commands match "/web-setup"`, or submitting it returns `Unknown command: /web-setup`, the command is hidden because a requirement isn't met. The cause is usually that you're authenticated with an API key or third-party provider instead of a claude.ai subscription. Run `/login` to sign in with your claude.ai account. Team and Enterprise Owners can also [disable `/web-setup`](/docs/en/claude-code-on-the-web#github-authentication-options) for their organization, which hides the command. In that case, use the browser flow above instead. - -On Team and Enterprise plans, the command is also hidden when any of the following apply: +If you typed it inside Claude Code and the command menu shows `No commands match "/web-setup"`, or submitting it returns `Unknown command: /web-setup`, the command is hidden because a requirement isn't met. The cause is usually that you're authenticated with an API key or third-party provider instead of a claude.ai subscription. Run `/login` to sign in with your claude.ai account. -* an administrator has disabled Claude Code on the web for your organization -* an administrator has disabled the [Quick web setup toggle](/docs/en/claude-code-on-the-web#github-authentication-options) -* your Enterprise organization has [Zero Data Retention](/docs/en/zero-data-retention) enabled, which makes Claude Code on the web unavailable +On Team and Enterprise plans, the command is hidden by default: the [Quick web setup toggle](/docs/en/claude-code-on-the-web#github-authentication-options) is off until an Owner turns it on. While it's off, [connect GitHub from the browser](#connect-github) instead. The command is also hidden when an administrator has disabled Claude Code on the web for your organization, or when your Enterprise organization has [Zero Data Retention](/docs/en/zero-data-retention) enabled, which makes Claude Code on the web unavailable. ### "Could not create a cloud environment" or "No cloud environment available" when using `--cloud` diff --git a/content/en/docs/claude-code/workflows.md b/content/en/docs/claude-code/workflows.md index 59c550c4d..35aa1b836 100644 --- a/content/en/docs/claude-code/workflows.md +++ b/content/en/docs/claude-code/workflows.md @@ -245,7 +245,7 @@ use a workflow to run npx tsc --noEmit and keep fixing the reported errors until Discover the files to migrate, transform each one in an isolated copy so edits don't conflict, and verify each result. ```text wrap theme={null} -use a workflow to migrate every component under src/components/ from styled-components to Tailwind, working on each file in its own isolated copy +use a workflow to migrate every component under src/components/ from JavaScript to TypeScript, working on each file in its own isolated copy ``` ### Review every changed file and write one summary diff --git a/content/en/docs/claude-code/zero-data-retention.md b/content/en/docs/claude-code/zero-data-retention.md index 962296fca..0701acba1 100644 --- a/content/en/docs/claude-code/zero-data-retention.md +++ b/content/en/docs/claude-code/zero-data-retention.md @@ -57,6 +57,7 @@ When ZDR is enabled for a Claude Code organization on Claude for Enterprise, cer | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | [Claude Code on the Web](/docs/en/claude-code-on-the-web) | Requires server-side storage of conversation history. | | [Cloud sessions](/docs/en/desktop#cloud-sessions) from the Desktop app | Requires persistent session data that includes prompts and completions. | +| [Claude Tag](/docs/en/claude-tag) | Retains channel memory and session transcripts. | | [Artifacts](/docs/en/artifacts) | Requires storing published page content on Anthropic-operated infrastructure. | | Feedback submission (`/feedback`, `/bug`, `/share`) | Submitting feedback sends conversation data to Anthropic. | | [Remote Control](/docs/en/remote-control) | Stores the session transcript on Anthropic servers to sync the conversation across devices. | diff --git a/content/en/home.md b/content/en/home.md index eac5201bd..d9cffbe79 100644 --- a/content/en/home.md +++ b/content/en/home.md @@ -95,7 +95,7 @@ with Claude" - Try the API in Playground + Try the API in playground diff --git a/content/en/intro.md b/content/en/intro.md index 20a0b2fb7..3c6bfd283 100644 --- a/content/en/intro.md +++ b/content/en/intro.md @@ -75,7 +75,7 @@ Anthropic provides developer tools to help you build and scale applications with - Explore and understand the API in your browser with Playground. + Explore and understand the API in your browser with playground. diff --git a/content/en/manage-claude/admin-api.md b/content/en/manage-claude/admin-api.md index 35eebd63e..612d3a0bf 100644 --- a/content/en/manage-claude/admin-api.md +++ b/content/en/manage-claude/admin-api.md @@ -8,7 +8,7 @@ description: Manage organization members, workspaces, invites, and API keys prog **The Admin API is unavailable for individual accounts.** To collaborate with teammates and add members, set up your organization in **Console → Settings → Organization**. -The [Admin API](https://platform.claude.com/docs/en/api/admin) allows you to programmatically manage your organization's resources, including organization members, workspaces, and API keys. This provides programmatic control over administrative tasks that would otherwise require manual configuration in the [Claude Console](https://platform.claude.com/). +The [Admin API](https://platform.claude.com/docs/en/api/admin) lets you manage your organization's members, workspaces, invites, and API keys programmatically instead of by hand in the [Claude Console](https://platform.claude.com/). **The Admin API requires special access** @@ -20,177 +20,1330 @@ The [Admin API](https://platform.claude.com/docs/en/api/admin) allows you to pro - **Claude Enterprise:** Claude Enterprise (claude.ai) organizations use the Admin API too, with a scoped API key created in claude.ai. Of the endpoints on this page, only members and invites are available to them, alongside Claude-Enterprise-only endpoints: groups and custom-role reads, and [spend limits](https://platform.claude.com/docs/en/manage-claude/spend-limits-api). See [User management](https://platform.claude.com/docs/en/manage-claude/user-management) for Claude Enterprise. + **Claude Enterprise:** Claude Enterprise (claude.ai) organizations call the Admin API with a scoped API key created in claude.ai. From this page, only the members and invites endpoints apply to them. They also get Enterprise-only endpoints: group and custom-role reads, and [spend limits](https://platform.claude.com/docs/en/manage-claude/spend-limits-api). See [User management](https://platform.claude.com/docs/en/manage-claude/user-management). - **Claude Platform on AWS:** Most of the Admin API is not available on Claude Platform on AWS. Workspace endpoints (create, get, list, update, and archive on `/v1/organizations/workspaces`) are available. Other endpoints including organization members, workspace members, invites, API keys, usage reports, cost reports, and rate limit reports are not available. See [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws) for details. + **Claude Platform on AWS:** Only the workspace endpoints (create, get, list, update, and archive on `/v1/organizations/workspaces`) are available on Claude Platform on AWS. Organization members, workspace members, invites, API keys, and the usage, cost, and rate limit reports aren't. See [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws). ## Authentication -Authenticate with either credential. An Admin API key covers most endpoints; the service-account, federation-issuer, and federation-rule endpoints accept only an `org:admin` OAuth token. The following examples call the [organization info endpoint](https://platform.claude.com/docs/en/manage-claude/admin-api#accessing-organization-info) both ways. +Authenticate with either credential. An Admin API key covers most endpoints. The service-account, federation-issuer, and federation-rule endpoints accept only an `org:admin` OAuth token. The following examples call the [organization info endpoint](https://platform.claude.com/docs/en/manage-claude/admin-api#accessing-organization-info) both ways. + +The Python, TypeScript, C#, Go, Java, PHP, and Ruby SDKs expose the Admin API under `client.beta.organization`, and the `ant` CLI under `ant beta:organization`. The examples on this page use the default client, which reads an Admin API key from `ANTHROPIC_API_KEY` or an OAuth bearer token from `ANTHROPIC_AUTH_TOKEN`. SDK list methods in Python, TypeScript, C#, Go, and Java return an iterator that fetches more pages on demand, so `limit` sets the page size, not the total. The PHP, Ruby, and curl examples return one page. In the CLI, `--limit` caps the results on the member, invite, workspace, workspace-member, and API-key lists. For each endpoint's parameters and responses, see the [Admin API reference](https://platform.claude.com/docs/en/api/admin). ### OAuth bearer token -Log in with the [`ant` CLI](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/quickstart) under a dedicated profile, requesting the `org:admin` scope (see [Admin access](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/authentication#admin-access)), then export the bearer token. A dedicated profile keeps your routine commands from running with elevated access: +Log in with the [`ant` CLI](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/quickstart) under a dedicated profile with the `org:admin` scope (see [Admin access](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/authentication#admin-access)), then export the bearer token. `--profile admin` stores the `org:admin` credential under its own profile and makes it the CLI's active profile. The exported variable applies to every SDK and CLI call in that shell. Use a shell you reserve for administration, unset the variable when you're done, and switch the CLI back with `ant profile activate default`: + +```bash CLI +ant auth login --profile admin --scope "org:admin" +export ANTHROPIC_AUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token) +``` + +Interactive tokens are short-lived. If requests start returning 401, re-run the `export` command to refresh the token. + +The SDKs and the `ant` CLI read `ANTHROPIC_AUTH_TOKEN` automatically. Leave `ANTHROPIC_API_KEY` unset in the same shell so they send the bearer token. Automated workloads skip the login: they authenticate through workload identity federation, and the SDKs and CLI perform the token exchange from the federation environment variables. See [Bootstrap a workload to manage WIF](https://platform.claude.com/docs/en/manage-claude/wif-admin-api#bootstrap-a-workload-to-manage-wif). + +Call the Admin API with the exported token: + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization retrieve + ``` + + ```python Python + client = anthropic.Anthropic() + + organization = client.beta.organization.retrieve() + + print(f"id: {organization.id}") + print(f"name: {organization.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const organization = await client.beta.organization.retrieve(); + + console.log(`id: ${organization.id}`); + console.log(`name: ${organization.name}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var organization = await client.Beta.Organization.Retrieve(); + + Console.WriteLine($"id: {organization.ID}"); + Console.WriteLine($"name: {organization.Name}"); + ``` + + ```go Go + client := anthropic.NewClient() + + organization, err := client.Beta.Organization.Get(context.Background()) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", organization.ID) + fmt.Printf("name: %s\n", organization.Name) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var organization = client.beta().organization().retrieve(); + + IO.println("id: " + organization.id()); + IO.println("name: " + organization.name()); + ``` + + ```php PHP + $client = new Client(); + + $organization = $client->beta->organization->retrieve(); + + echo "id: {$organization->id}\n"; + echo "name: {$organization->name}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + organization = client.beta.organization.retrieve + + puts "id: #{organization.id}" + puts "name: #{organization.name}" + ``` + + +An `org:admin` token grants access to the whole organization, regardless of the workspace the underlying profile or [federation rule](https://platform.claude.com/docs/en/manage-claude/admin-api#federation-rules) is bound to. + +For CI and other non-interactive workloads, mint the token with Workload Identity Federation instead of logging in interactively. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api#workload-ci-and-automation). + +### Admin API key + +To create an Admin API key for your organization type, see [Create an Admin API key](https://platform.claude.com/docs/en/manage-claude/admin-api-keys). + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization retrieve + ``` + + ```python Python + client = anthropic.Anthropic() + + organization = client.beta.organization.retrieve() + + print(f"id: {organization.id}") + print(f"name: {organization.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const organization = await client.beta.organization.retrieve(); + + console.log(`id: ${organization.id}`); + console.log(`name: ${organization.name}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var organization = await client.Beta.Organization.Retrieve(); + + Console.WriteLine($"id: {organization.ID}"); + Console.WriteLine($"name: {organization.Name}"); + ``` + + ```go Go + client := anthropic.NewClient() + + organization, err := client.Beta.Organization.Get(context.Background()) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", organization.ID) + fmt.Printf("name: %s\n", organization.Name) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var organization = client.beta().organization().retrieve(); + + IO.println("id: " + organization.id()); + IO.println("name: " + organization.name()); + ``` + + ```php PHP + $client = new Client(); + + $organization = $client->beta->organization->retrieve(); + + echo "id: {$organization->id}\n"; + echo "name: {$organization->name}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + organization = client.beta.organization.retrieve + + puts "id: #{organization.id}" + puts "name: #{organization.name}" + ``` + + +## How the Admin API works + +Authenticate with either credential from [Authentication](https://platform.claude.com/docs/en/manage-claude/admin-api#authentication), then manage the following resources: + +* Organization members and their roles +* Organization invites +* Workspaces and their members +* API keys +* Service accounts, federation issuers, and federation rules (`org:admin` OAuth token only) + +Common uses include automating onboarding and offboarding, managing workspace access, and auditing API keys. + +## Organization roles and permissions + +There are five organization-level roles. For details, see [API Console roles and permissions](https://support.claude.com/en/articles/10186004-api-console-roles-and-permissions). + +| Role | Permissions | +| ------------------ | ------------------------------------------------------------------------------ | +| user | Can use playground | +| claude\_code\_user | Can use playground and [Claude Code](https://code.claude.com/docs/en/overview) | +| developer | Can use playground and manage API keys | +| billing | Can use playground and manage billing details | +| admin | Can do all of the preceding, plus manage users | + +Organization owners and primary owners have all admin permissions and can also manage admins. All references to the admin role on this page also apply to owners and primary owners. + +## Key concepts + +### Organization members + +List [organization members](https://platform.claude.com/docs/en/api/admin-api/users/get-user), update their roles, and remove them. + +List the members of your organization: + + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/users?limit=10" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:users list --limit 10 + ``` + + ```python Python + client = anthropic.Anthropic() + + users = client.beta.organization.users.list(limit=10) + + # Automatically fetches more pages as needed. + for user in users: + print(f"{user.id}: {user.email} ({user.role})") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const users = await client.beta.organization.users.list({ limit: 10 }); + + for await (const user of users) { + console.log(`${user.id}: ${user.email} (${user.role})`); + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var page = await client.Beta.Organization.Users.List(new() { Limit = 10 }); + + await foreach (var user in page.Paginate()) + { + Console.WriteLine($"{user.ID}: {user.Email} ({user.Role.Raw()})"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + users := client.Beta.Organization.Users.ListAutoPaging(context.Background(), anthropic.BetaOrganizationUserListParams{ + Limit: anthropic.Int(10), + }) + + for users.Next() { + user := users.Current() + fmt.Printf("%s: %s (%s)\n", user.ID, user.Email, user.Role) + } + if err := users.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.users.UserListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = UserListParams.builder() + .limit(10) + .build(); + var users = client.beta().organization().users().list(params); + + for (var user : users.autoPager()) { + IO.println(user.id() + ": " + user.email() + " (" + user.role().asString() + ")"); + } + } + ``` + + ```php PHP + $client = new Client(); + + $users = $client->beta->organization->users->list(limit: 10); + + foreach ($users->getItems() as $user) { + echo "{$user->id}: {$user->email} ({$user->role})\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + users = client.beta.organization.users.list(limit: 10) + + users.data.each do |user| + puts "#{user.id}: #{user.email} (#{user.role})" + end + ``` + + +Update a member's role: + + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/users/user_01XyDMpzjS89pFZXqSFUBDr6" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{"role": "developer"}' + ``` + + ```bash CLI + ant beta:organization:users update \ + --user-id user_01XyDMpzjS89pFZXqSFUBDr6 \ + --role developer + ``` + + ```python Python + client = anthropic.Anthropic() + + user = client.beta.organization.users.update( + "user_01XyDMpzjS89pFZXqSFUBDr6", role="developer" + ) + + print(f"id: {user.id}") + print(f"role: {user.role}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const user = await client.beta.organization.users.update("user_01XyDMpzjS89pFZXqSFUBDr6", { + role: "developer" + }); + + console.log(`id: ${user.id}`); + console.log(`role: ${user.role}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.Users; + // ... + + AnthropicClient client = new(); + + var user = await client.Beta.Organization.Users.Update( + "user_01XyDMpzjS89pFZXqSFUBDr6", + new() { Role = Role.Developer } + ); + + Console.WriteLine($"id: {user.ID}"); + Console.WriteLine($"role: {user.Role.Raw()}"); + ``` + + ```go Go + client := anthropic.NewClient() + + user, err := client.Beta.Organization.Users.Update( + context.Background(), + "user_01XyDMpzjS89pFZXqSFUBDr6", + anthropic.BetaOrganizationUserUpdateParams{ + Role: anthropic.BetaOrganizationUserUpdateParamsRoleDeveloper, + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", user.ID) + fmt.Printf("role: %s\n", user.Role) + ``` + + ```java Java + import com.anthropic.models.beta.organization.users.UserUpdateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = UserUpdateParams.builder() + .role(UserUpdateParams.Role.DEVELOPER) + .build(); + var user = client.beta().organization().users() + .update("user_01XyDMpzjS89pFZXqSFUBDr6", params); + + IO.println("id: " + user.id()); + IO.println("role: " + user.role().asString()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\Users\UserUpdateParams\Role; + // ... + + $client = new Client(); + + $user = $client->beta->organization->users->update( + userID: 'user_01XyDMpzjS89pFZXqSFUBDr6', + role: Role::DEVELOPER, + ); + + echo "id: {$user->id}\n"; + echo "role: {$user->role}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + user_id = "user_01XyDMpzjS89pFZXqSFUBDr6" + user = client.beta.organization.users.update(user_id, role: :developer) + + puts "id: #{user.id}" + puts "role: #{user.role}" + ``` + + +Remove a member from the organization: + + + ```bash cURL + curl -X DELETE "https://api.anthropic.com/v1/organizations/users/user_01XyDMpzjS89pFZXqSFUBDr6" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:users remove --user-id user_01XyDMpzjS89pFZXqSFUBDr6 + ``` + + ```python Python + client = anthropic.Anthropic() + + removed_user = client.beta.organization.users.remove("user_01XyDMpzjS89pFZXqSFUBDr6") + + print(f"id: {removed_user.id}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const removedUser = await client.beta.organization.users.remove( + "user_01XyDMpzjS89pFZXqSFUBDr6" + ); + + console.log(`id: ${removedUser.id}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var removedUser = await client.Beta.Organization.Users.Remove("user_01XyDMpzjS89pFZXqSFUBDr6"); + + Console.WriteLine($"id: {removedUser.ID}"); + ``` + + ```go Go + client := anthropic.NewClient() + + removedUser, err := client.Beta.Organization.Users.Remove(context.Background(), "user_01XyDMpzjS89pFZXqSFUBDr6") + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", removedUser.ID) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var removedUser = client.beta().organization().users() + .remove("user_01XyDMpzjS89pFZXqSFUBDr6"); + + IO.println("id: " + removedUser.id()); + ``` + + ```php PHP + $client = new Client(); + + $removedUser = $client->beta->organization->users->remove( + userID: 'user_01XyDMpzjS89pFZXqSFUBDr6', + ); + + echo "id: {$removedUser->id}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + user_id = "user_01XyDMpzjS89pFZXqSFUBDr6" + removed_user = client.beta.organization.users.remove(user_id) + + puts "id: #{removed_user.id}" + ``` + + +### Organization invites + +Invite users to your organization and manage pending [invites](https://platform.claude.com/docs/en/api/admin-api/invites/get-invite). + +Invite a user to your organization: + + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/invites" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "email": "user@example.com", + "role": "developer" + }' + ``` + + ```bash CLI + ant beta:organization:invites create --email user@example.com --role developer + ``` + + ```python Python + client = anthropic.Anthropic() + + invite = client.beta.organization.invites.create( + email="user@example.com", role="developer" + ) + + print(f"id: {invite.id}") + print(f"email: {invite.email}") + print(f"status: {invite.status}") + print(f"expires_at: {invite.expires_at}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const invite = await client.beta.organization.invites.create({ + email: "user@example.com", + role: "developer" + }); + + console.log(`id: ${invite.id}`); + console.log(`email: ${invite.email}`); + console.log(`status: ${invite.status}`); + console.log(`expires_at: ${invite.expires_at}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.Invites; + // ... + + AnthropicClient client = new(); + + var invite = await client.Beta.Organization.Invites.Create(new() + { + Email = "user@example.com", + Role = Role.Developer + }); + + Console.WriteLine($"id: {invite.ID}"); + Console.WriteLine($"email: {invite.Email}"); + Console.WriteLine($"status: {invite.Status.Raw()}"); + Console.WriteLine($"expires_at: {invite.ExpiresAt:O}"); + ``` + + ```go Go + client := anthropic.NewClient() + + invite, err := client.Beta.Organization.Invites.New(context.Background(), anthropic.BetaOrganizationInviteNewParams{ + Email: "user@example.com", + Role: anthropic.BetaOrganizationInviteNewParamsRoleDeveloper, + }) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", invite.ID) + fmt.Printf("email: %s\n", invite.Email) + fmt.Printf("status: %s\n", invite.Status) + fmt.Printf("expires_at: %s\n", invite.ExpiresAt.Format(time.RFC3339)) + ``` + + ```java Java + import com.anthropic.models.beta.organization.invites.InviteCreateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = InviteCreateParams.builder() + .email("user@example.com") + .role(InviteCreateParams.Role.DEVELOPER) + .build(); + var invite = client.beta().organization().invites().create(params); + + IO.println("id: " + invite.id()); + IO.println("email: " + invite.email()); + IO.println("status: " + invite.status().asString()); + IO.println("expires_at: " + invite.expiresAt()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\Invites\InviteCreateParams\Role; + // ... + + $client = new Client(); + + $invite = $client->beta->organization->invites->create( + email: 'user@example.com', + role: Role::DEVELOPER, + ); + + echo "id: {$invite->id}\n"; + echo "email: {$invite->email}\n"; + echo "status: {$invite->status}\n"; + echo "expires_at: {$invite->expiresAt->format(DATE_ATOM)}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + invite = client.beta.organization.invites.create(email: "user@example.com", role: :developer) + + puts "id: #{invite.id}" + puts "email: #{invite.email}" + puts "status: #{invite.status}" + puts "expires_at: #{invite.expires_at.iso8601}" + ``` + + +List pending invites: + + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:invites list --limit 10 + ``` + + ```python Python + client = anthropic.Anthropic() + + invites = client.beta.organization.invites.list(limit=10) + + # Automatically fetches more pages as needed. + for invite in invites: + print(f"{invite.id}: {invite.email} ({invite.status})") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const invites = await client.beta.organization.invites.list({ limit: 10 }); + + for await (const invite of invites) { + console.log(`${invite.id}: ${invite.email} (${invite.status})`); + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var page = await client.Beta.Organization.Invites.List(new() { Limit = 10 }); + + await foreach (var invite in page.Paginate()) + { + Console.WriteLine($"{invite.ID}: {invite.Email} ({invite.Status.Raw()})"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + invites := client.Beta.Organization.Invites.ListAutoPaging(context.Background(), anthropic.BetaOrganizationInviteListParams{ + Limit: anthropic.Int(10), + }) + + for invites.Next() { + invite := invites.Current() + fmt.Printf("%s: %s (%s)\n", invite.ID, invite.Email, invite.Status) + } + if err := invites.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.invites.InviteListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = InviteListParams.builder() + .limit(10) + .build(); + var invites = client.beta().organization().invites().list(params); + + for (var invite : invites.autoPager()) { + IO.println(invite.id() + ": " + invite.email() + " (" + invite.status().asString() + ")"); + } + } + ``` + + ```php PHP + $client = new Client(); + + $invites = $client->beta->organization->invites->list(limit: 10); + + foreach ($invites->getItems() as $invite) { + echo "{$invite->id}: {$invite->email} ({$invite->status})\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + invites = client.beta.organization.invites.list(limit: 10) + + invites.data.each do |invite| + puts "#{invite.id}: #{invite.email} (#{invite.status})" + end + ``` + + +Delete an invite: + + + ```bash cURL + curl -X DELETE "https://api.anthropic.com/v1/organizations/invites/invite_015gWxHNr6h6TdRPZTmuCGnn" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:invites delete --invite-id invite_015gWxHNr6h6TdRPZTmuCGnn + ``` + + ```python Python + client = anthropic.Anthropic() + + deleted_invite = client.beta.organization.invites.delete( + "invite_015gWxHNr6h6TdRPZTmuCGnn" + ) + + print(f"id: {deleted_invite.id}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const deletedInvite = await client.beta.organization.invites.delete( + "invite_015gWxHNr6h6TdRPZTmuCGnn" + ); + + console.log(`id: ${deletedInvite.id}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var deletedInvite = await client.Beta.Organization.Invites.Delete( + "invite_015gWxHNr6h6TdRPZTmuCGnn" + ); + + Console.WriteLine($"id: {deletedInvite.ID}"); + ``` + + ```go Go + client := anthropic.NewClient() -```bash CLI -ant auth login --profile admin --scope "org:admin" -export ANTHROPIC_OAUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token) -``` + deletedInvite, err := client.Beta.Organization.Invites.Delete(context.Background(), "invite_015gWxHNr6h6TdRPZTmuCGnn") + if err != nil { + log.Fatal(err) + } -Interactive tokens are short-lived; if requests start returning 401, re-run the `export` command, which refreshes the token automatically. + fmt.Printf("id: %s\n", deletedInvite.ID) + ``` -Call the Admin API with the exported token: + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); -```bash cURL -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \ - --header "anthropic-version: 2023-06-01" \ - --header "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" -``` + var deletedInvite = client.beta().organization().invites() + .delete("invite_015gWxHNr6h6TdRPZTmuCGnn"); -An `org:admin` token grants access to the whole organization, regardless of the workspace the underlying profile or [federation rule](https://platform.claude.com/docs/en/manage-claude/admin-api#federation-rules) is bound to. + IO.println("id: " + deletedInvite.id()); + ``` -For CI and other non-interactive workloads, mint the token with Workload Identity Federation instead of logging in interactively. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api#workload-ci-and-automation). + ```php PHP + $client = new Client(); -### Admin API key + $deletedInvite = $client->beta->organization->invites->delete( + inviteID: 'invite_015gWxHNr6h6TdRPZTmuCGnn', + ); -To create an Admin API key for your organization type, see [Create an Admin API key](https://platform.claude.com/docs/en/manage-claude/admin-api-keys). + echo "id: {$deletedInvite->id}\n"; + ``` -```bash cURL -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/me" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + ```ruby Ruby + client = Anthropic::Client.new -## How the Admin API works + invite_id = "invite_015gWxHNr6h6TdRPZTmuCGnn" + deleted_invite = client.beta.organization.invites.delete(invite_id) -When you use the Admin API: + puts "id: #{deleted_invite.id}" + ``` + -1. You make requests using either credential from the [Authentication](https://platform.claude.com/docs/en/manage-claude/admin-api#authentication) section +### Workspaces -2. The API allows you to manage: +See [Workspaces](https://platform.claude.com/docs/en/manage-claude/workspaces) for Console and API examples. - * Organization members and their roles - * Organization member invites - * Workspaces and their members - * API keys - * Service accounts, federation issuers, and federation rules (these endpoints require an `org:admin` OAuth token; Admin API keys are not accepted) +### Workspace members -This is useful for: +Manage [user access to specific workspaces](https://platform.claude.com/docs/en/api/admin-api/workspace_members/get-workspace-member): -* Automating user onboarding/offboarding -* Programmatically managing workspace access -* Monitoring and managing API key usage +Add a member to a workspace: -## Organization roles and permissions + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/members" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "user_id": "user_01XyDMpzjS89pFZXqSFUBDr6", + "workspace_role": "workspace_developer" + }' + ``` -There are five organization-level roles. See more details in the [API Console roles and permissions](https://support.claude.com/en/articles/10186004-api-console-roles-and-permissions) article. + ```bash CLI + ant beta:organization:workspaces:members add \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ \ + --user-id user_01XyDMpzjS89pFZXqSFUBDr6 \ + --workspace-role workspace_developer + ``` -| Role | Permissions | -| ------------------ | ------------------------------------------------------------------------------ | -| user | Can use Playground | -| claude\_code\_user | Can use Playground and [Claude Code](https://code.claude.com/docs/en/overview) | -| developer | Can use Playground and manage API keys | -| billing | Can use Playground and manage billing details | -| admin | Can do all of the preceding, plus manage users | + ```python Python + client = anthropic.Anthropic() -Organization owners and primary owners have all admin permissions and can additionally manage admins. All references to the admin role on this page also apply to owners and primary owners. + member = client.beta.organization.workspaces.members.add( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + user_id="user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_role="workspace_developer", + ) -## Key concepts + print(f"user_id: {member.user_id}") + print(f"workspace_role: {member.workspace_role}") + ``` -### Organization members + ```typescript TypeScript + const client = new Anthropic(); -You can list [organization members](https://platform.claude.com/docs/en/api/admin-api/users/get-user), update member roles, and remove members. + const member = await client.beta.organization.workspaces.members.add( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + { + user_id: "user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_role: "workspace_developer" + } + ); + + console.log(`user_id: ${member.user_id}`); + console.log(`workspace_role: ${member.workspace_role}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.Workspaces; + + AnthropicClient client = new(); + + var member = await client.Beta.Organization.Workspaces.Members.Add( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + new() + { + UserID = "user_01XyDMpzjS89pFZXqSFUBDr6", + WorkspaceRole = BetaNoBillingWorkspaceRole.WorkspaceDeveloper + } + ); + + Console.WriteLine($"user_id: {member.UserID}"); + Console.WriteLine($"workspace_role: {member.WorkspaceRole.Raw()}"); + ``` + + ```go Go + client := anthropic.NewClient() + + member, err := client.Beta.Organization.Workspaces.Members.Add( + context.Background(), + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + anthropic.BetaOrganizationWorkspaceMemberAddParams{ + UserID: "user_01XyDMpzjS89pFZXqSFUBDr6", + WorkspaceRole: anthropic.BetaNoBillingWorkspaceRoleWorkspaceDeveloper, + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("user_id: %s\n", member.UserID) + fmt.Printf("workspace_role: %s\n", member.WorkspaceRole) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.BetaNoBillingWorkspaceRole; + import com.anthropic.models.beta.organization.workspaces.members.MemberAddParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = MemberAddParams.builder() + .userId("user_01XyDMpzjS89pFZXqSFUBDr6") + .workspaceRole(BetaNoBillingWorkspaceRole.WORKSPACE_DEVELOPER) + .build(); + var member = client.beta().organization().workspaces().members() + .add("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", params); + + IO.println("user_id: " + member.userId()); + IO.println("workspace_role: " + member.workspaceRole().asString()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\Workspaces\NoBillingWorkspaceRole; + // ... + + $client = new Client(); + + $member = $client->beta->organization->workspaces->members->add( + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + userID: 'user_01XyDMpzjS89pFZXqSFUBDr6', + workspaceRole: NoBillingWorkspaceRole::WORKSPACE_DEVELOPER, + ); + + echo "user_id: {$member->userID}\n"; + echo "workspace_role: {$member->workspaceRole}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace_id = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + member = client.beta.organization.workspaces.members.add( + workspace_id, + user_id: "user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_role: :workspace_developer + ) + + puts "user_id: #{member.user_id}" + puts "workspace_role: #{member.workspace_role}" + ``` + + +List the members of a workspace: ```bash cURL - # List organization members - curl "https://api.anthropic.com/v1/organizations/users?limit=10" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" + curl "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/members?limit=10" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:workspaces:members list \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ \ + --limit 10 + ``` + + ```python Python + client = anthropic.Anthropic() - # Update member role - curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \ - --header "anthropic-version: 2023-06-01" \ - --header "content-type: application/json" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \ - --data '{"role": "developer"}' + members = client.beta.organization.workspaces.members.list( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", limit=10 + ) - # Remove member - curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" + # Automatically fetches more pages as needed. + for member in members: + print(f"{member.user_id}: {member.workspace_role}") ``` - -### Organization invites + ```typescript TypeScript + const client = new Anthropic(); -You can invite users to organizations and manage those [invites](https://platform.claude.com/docs/en/api/admin-api/invites/get-invite). + const members = await client.beta.organization.workspaces.members.list( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + { limit: 10 } + ); + + for await (const member of members) { + console.log(`${member.user_id}: ${member.workspace_role}`); + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var page = await client.Beta.Organization.Workspaces.Members.List( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + new() { Limit = 10 } + ); + + await foreach (var member in page.Paginate()) + { + Console.WriteLine($"{member.UserID}: {member.WorkspaceRole.Raw()}"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + members := client.Beta.Organization.Workspaces.Members.ListAutoPaging( + context.Background(), + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + anthropic.BetaOrganizationWorkspaceMemberListParams{ + Limit: anthropic.Int(10), + }, + ) + + for members.Next() { + member := members.Current() + fmt.Printf("%s: %s\n", member.UserID, member.WorkspaceRole) + } + if err := members.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.members.MemberListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = MemberListParams.builder() + .limit(10) + .build(); + var members = client.beta().organization().workspaces().members() + .list("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", params); + + for (var member : members.autoPager()) { + IO.println(member.userId() + ": " + member.workspaceRole().asString()); + } + } + ``` + + ```php PHP + $client = new Client(); + + $members = $client->beta->organization->workspaces->members->list( + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + limit: 10, + ); + + foreach ($members->getItems() as $member) { + echo "{$member->userID}: {$member->workspaceRole}\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace_id = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + members = client.beta.organization.workspaces.members.list(workspace_id, limit: 10) + + members.data.each do |member| + puts "#{member.user_id}: #{member.workspace_role}" + end + ``` +
+ +Update a workspace member's role: ```bash cURL - # Create invite - curl --request POST "https://api.anthropic.com/v1/organizations/invites" \ - --header "anthropic-version: 2023-06-01" \ - --header "content-type: application/json" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \ - --data '{ - "email": "newuser@domain.com", - "role": "developer" - }' + curl "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/members/user_01XyDMpzjS89pFZXqSFUBDr6" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{"workspace_role": "workspace_admin"}' + ``` - # List invites - curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" + ```bash CLI + ant beta:organization:workspaces:members update \ + --user-id user_01XyDMpzjS89pFZXqSFUBDr6 \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ \ + --workspace-role workspace_admin + ``` - # Delete invite - curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" + ```python Python + client = anthropic.Anthropic() + + member = client.beta.organization.workspaces.members.update( + "user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + workspace_role="workspace_admin", + ) + + print(f"user_id: {member.user_id}") + print(f"workspace_role: {member.workspace_role}") ``` - -### Workspaces + ```typescript TypeScript + const client = new Anthropic(); -For a comprehensive guide to workspaces, including Console and API examples, see [Workspaces](https://platform.claude.com/docs/en/manage-claude/workspaces). + const member = await client.beta.organization.workspaces.members.update( + "user_01XyDMpzjS89pFZXqSFUBDr6", + { + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + workspace_role: "workspace_admin" + } + ); -### Workspace members + console.log(`user_id: ${member.user_id}`); + console.log(`workspace_role: ${member.workspace_role}`); + ``` -Manage [user access to specific workspaces](https://platform.claude.com/docs/en/api/admin-api/workspace_members/get-workspace-member): + ```csharp C# + using Anthropic.Models.Beta.Organization.Workspaces; + + AnthropicClient client = new(); + + var member = await client.Beta.Organization.Workspaces.Members.Update( + "user_01XyDMpzjS89pFZXqSFUBDr6", + new() + { + WorkspaceID = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + WorkspaceRole = BetaWorkspaceRole.WorkspaceAdmin + } + ); + + Console.WriteLine($"user_id: {member.UserID}"); + Console.WriteLine($"workspace_role: {member.WorkspaceRole.Raw()}"); + ``` + + ```go Go + client := anthropic.NewClient() + + member, err := client.Beta.Organization.Workspaces.Members.Update( + context.Background(), + "user_01XyDMpzjS89pFZXqSFUBDr6", + anthropic.BetaOrganizationWorkspaceMemberUpdateParams{ + WorkspaceID: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + WorkspaceRole: anthropic.BetaWorkspaceRoleWorkspaceAdmin, + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("user_id: %s\n", member.UserID) + fmt.Printf("workspace_role: %s\n", member.WorkspaceRole) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.BetaWorkspaceRole; + import com.anthropic.models.beta.organization.workspaces.members.MemberUpdateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = MemberUpdateParams.builder() + .workspaceId("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ") + .workspaceRole(BetaWorkspaceRole.WORKSPACE_ADMIN) + .build(); + var member = client.beta().organization().workspaces().members() + .update("user_01XyDMpzjS89pFZXqSFUBDr6", params); + + IO.println("user_id: " + member.userId()); + IO.println("workspace_role: " + member.workspaceRole().asString()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\Workspaces\WorkspaceRole; + // ... + + $client = new Client(); + + $member = $client->beta->organization->workspaces->members->update( + userID: 'user_01XyDMpzjS89pFZXqSFUBDr6', + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + workspaceRole: WorkspaceRole::WORKSPACE_ADMIN, + ); + + echo "user_id: {$member->userID}\n"; + echo "workspace_role: {$member->workspaceRole}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + user_id = "user_01XyDMpzjS89pFZXqSFUBDr6" + member = client.beta.organization.workspaces.members.update( + user_id, + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + workspace_role: :workspace_admin + ) + + puts "user_id: #{member.user_id}" + puts "workspace_role: #{member.workspace_role}" + ``` + + +Remove a member from a workspace: ```bash cURL - # Add member to workspace - curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \ - --header "anthropic-version: 2023-06-01" \ - --header "content-type: application/json" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \ - --data '{ - "user_id": "user_xxx", - "workspace_role": "workspace_developer" - }' + curl -X DELETE "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/members/user_01XyDMpzjS89pFZXqSFUBDr6" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` - # List workspace members - curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" - - # Update member role - curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \ - --header "anthropic-version: 2023-06-01" \ - --header "content-type: application/json" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \ - --data '{ - "workspace_role": "workspace_admin" - }' + ```bash CLI + ant beta:organization:workspaces:members remove \ + --user-id user_01XyDMpzjS89pFZXqSFUBDr6 \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ + ``` + + ```python Python + client = anthropic.Anthropic() + + removed_member = client.beta.organization.workspaces.members.remove( + "user_01XyDMpzjS89pFZXqSFUBDr6", workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ) - # Remove member from workspace - curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" + print(f"user_id: {removed_member.user_id}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const removedMember = await client.beta.organization.workspaces.members.remove( + "user_01XyDMpzjS89pFZXqSFUBDr6", + { workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } + ); + + console.log(`user_id: ${removedMember.user_id}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var removedMember = await client.Beta.Organization.Workspaces.Members.Remove( + "user_01XyDMpzjS89pFZXqSFUBDr6", + new() { WorkspaceID = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } + ); + + Console.WriteLine($"user_id: {removedMember.UserID}"); + ``` + + ```go Go + client := anthropic.NewClient() + + removedMember, err := client.Beta.Organization.Workspaces.Members.Remove( + context.Background(), + "user_01XyDMpzjS89pFZXqSFUBDr6", + anthropic.BetaOrganizationWorkspaceMemberRemoveParams{ + WorkspaceID: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("user_id: %s\n", removedMember.UserID) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.members.MemberRemoveParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = MemberRemoveParams.builder() + .workspaceId("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ") + .build(); + var removedMember = client.beta().organization().workspaces().members() + .remove("user_01XyDMpzjS89pFZXqSFUBDr6", params); + + IO.println("user_id: " + removedMember.userId()); + } + ``` + + ```php PHP + $client = new Client(); + + $removedMember = $client->beta->organization->workspaces->members->remove( + userID: 'user_01XyDMpzjS89pFZXqSFUBDr6', + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + ); + + echo "user_id: {$removedMember->userID}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + user_id = "user_01XyDMpzjS89pFZXqSFUBDr6" + removed_member = client.beta.organization.workspaces.members.remove( + user_id, + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ) + + puts "user_id: #{removed_member.user_id}" ``` @@ -198,28 +1351,278 @@ Manage [user access to specific workspaces](https://platform.claude.com/docs/en/ Monitor and manage [API keys](https://platform.claude.com/docs/en/api/admin/api_keys/list). Each key in the response includes its `expires_at` timestamp (`null` for keys without an [expiration](https://platform.claude.com/docs/en/manage-claude/authentication#key-expiration)): +List the active API keys in a workspace: + + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:api-keys list \ + --limit 10 \ + --status active \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ + ``` + + ```python Python + client = anthropic.Anthropic() + + api_keys = client.beta.organization.api_keys.list( + limit=10, status="active", workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ) + + # Automatically fetches more pages as needed. + for api_key in api_keys: + print(f"{api_key.id}: {api_key.name} ({api_key.status})") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const apiKeys = await client.beta.organization.apiKeys.list({ + limit: 10, + status: "active", + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }); + + for await (const apiKey of apiKeys) { + console.log(`${apiKey.id}: ${apiKey.name} (${apiKey.status})`); + } + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.ApiKeys; + + AnthropicClient client = new(); + + var page = await client.Beta.Organization.ApiKeys.List(new() + { + Limit = 10, + Status = ApiKeyListParamsStatus.Active, + WorkspaceID = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + }); + + await foreach (var apiKey in page.Paginate()) + { + Console.WriteLine($"{apiKey.ID}: {apiKey.Name} ({apiKey.Status.Raw()})"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + apiKeys := client.Beta.Organization.APIKeys.ListAutoPaging(context.Background(), anthropic.BetaOrganizationAPIKeyListParams{ + Limit: anthropic.Int(10), + Status: anthropic.BetaOrganizationAPIKeyListParamsStatusActive, + WorkspaceID: anthropic.String("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"), + }) + + for apiKeys.Next() { + apiKey := apiKeys.Current() + fmt.Printf("%s: %s (%s)\n", apiKey.ID, apiKey.Name, apiKey.Status) + } + if err := apiKeys.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.apikeys.ApiKeyListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = ApiKeyListParams.builder() + .limit(10) + .status(ApiKeyListParams.Status.ACTIVE) + .workspaceId("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ") + .build(); + var apiKeys = client.beta().organization().apiKeys().list(params); + + for (var apiKey : apiKeys.autoPager()) { + IO.println(apiKey.id() + ": " + apiKey.name() + " (" + apiKey.status().asString() + ")"); + } + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\APIKeys\APIKeyListParams\Status; + // ... + + $client = new Client(); + + $apiKeys = $client->beta->organization->apiKeys->list( + limit: 10, + status: Status::ACTIVE, + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + ); + + foreach ($apiKeys->getItems() as $apiKey) { + echo "{$apiKey->id}: {$apiKey->name} ({$apiKey->status})\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + api_keys = client.beta.organization.api_keys.list( + limit: 10, + status: :active, + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ) + + api_keys.data.each do |api_key| + puts "#{api_key.id}: #{api_key.name} (#{api_key.status})" + end + ``` + + +Rename or deactivate an API key: + ```bash cURL - # List API keys - curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" - - # Update API key - curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \ - --header "anthropic-version: 2023-06-01" \ - --header "content-type: application/json" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \ - --data '{ + curl "https://api.anthropic.com/v1/organizations/api_keys/apikey_01Rj2N8SVvo6BePZj99NhmiT" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ "status": "inactive", "name": "New Key Name" }' ``` + + ```bash CLI + ant beta:organization:api-keys update \ + --api-key-id apikey_01Rj2N8SVvo6BePZj99NhmiT \ + --status inactive \ + --name "New Key Name" + ``` + + ```python Python + client = anthropic.Anthropic() + + api_key = client.beta.organization.api_keys.update( + "apikey_01Rj2N8SVvo6BePZj99NhmiT", status="inactive", name="New Key Name" + ) + + print(f"id: {api_key.id}") + print(f"name: {api_key.name}") + print(f"status: {api_key.status}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const apiKey = await client.beta.organization.apiKeys.update( + "apikey_01Rj2N8SVvo6BePZj99NhmiT", + { + status: "inactive", + name: "New Key Name" + } + ); + + console.log(`id: ${apiKey.id}`); + console.log(`name: ${apiKey.name}`); + console.log(`status: ${apiKey.status}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.ApiKeys; + + AnthropicClient client = new(); + + var apiKey = await client.Beta.Organization.ApiKeys.Update( + "apikey_01Rj2N8SVvo6BePZj99NhmiT", + new() + { + Status = Status.Inactive, + Name = "New Key Name" + } + ); + + Console.WriteLine($"id: {apiKey.ID}"); + Console.WriteLine($"name: {apiKey.Name}"); + Console.WriteLine($"status: {apiKey.Status.Raw()}"); + ``` + + ```go Go + client := anthropic.NewClient() + + apiKey, err := client.Beta.Organization.APIKeys.Update( + context.Background(), + "apikey_01Rj2N8SVvo6BePZj99NhmiT", + anthropic.BetaOrganizationAPIKeyUpdateParams{ + Status: anthropic.BetaOrganizationAPIKeyUpdateParamsStatusInactive, + Name: anthropic.String("New Key Name"), + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", apiKey.ID) + fmt.Printf("name: %s\n", apiKey.Name) + fmt.Printf("status: %s\n", apiKey.Status) + ``` + + ```java Java + import com.anthropic.models.beta.organization.apikeys.ApiKeyUpdateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = ApiKeyUpdateParams.builder() + .status(ApiKeyUpdateParams.Status.INACTIVE) + .name("New Key Name") + .build(); + var apiKey = client.beta().organization().apiKeys() + .update("apikey_01Rj2N8SVvo6BePZj99NhmiT", params); + + IO.println("id: " + apiKey.id()); + IO.println("name: " + apiKey.name()); + IO.println("status: " + apiKey.status().asString()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\APIKeys\APIKeyUpdateParams\Status; + // ... + + $client = new Client(); + + $apiKey = $client->beta->organization->apiKeys->update( + apiKeyID: 'apikey_01Rj2N8SVvo6BePZj99NhmiT', + status: Status::INACTIVE, + name: 'New Key Name', + ); + + echo "id: {$apiKey->id}\n"; + echo "name: {$apiKey->name}\n"; + echo "status: {$apiKey->status}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + api_key_id = "apikey_01Rj2N8SVvo6BePZj99NhmiT" + api_key = client.beta.organization.api_keys.update( + api_key_id, + status: :inactive, + name: "New Key Name" + ) + + puts "id: #{api_key.id}" + puts "name: #{api_key.name}" + puts "status: #{api_key.status}" + ``` ### Service accounts -Create and manage service accounts (`svac_...`), the non-human identities that [Workload Identity Federation](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation) tokens act as. Admin API keys are not accepted on the service-account, federation-issuer, or federation-rule endpoints; use an `org:admin` OAuth token. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api#service-accounts). +Create and manage service accounts (`svac_...`), the non-human identities that [Workload Identity Federation](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation) tokens act as. These endpoints, like the federation-issuer and federation-rule endpoints, require an `org:admin` OAuth token. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api#service-accounts). ### Federation issuers @@ -231,15 +1634,85 @@ Manage the rules (`fdrl_...`) that map issuer tokens to service accounts and sco ## Accessing organization info -Get information about your organization programmatically with the `/v1/organizations/me` endpoint. +The `/v1/organizations/me` endpoint returns the organization that your credential belongs to: -For example: + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/me" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` -```bash cURL -curl "https://api.anthropic.com/v1/organizations/me" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + ```bash CLI + ant beta:organization retrieve + ``` + + ```python Python + client = anthropic.Anthropic() + + organization = client.beta.organization.retrieve() + + print(f"id: {organization.id}") + print(f"name: {organization.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const organization = await client.beta.organization.retrieve(); + + console.log(`id: ${organization.id}`); + console.log(`name: ${organization.name}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var organization = await client.Beta.Organization.Retrieve(); + + Console.WriteLine($"id: {organization.ID}"); + Console.WriteLine($"name: {organization.Name}"); + ``` + + ```go Go + client := anthropic.NewClient() + + organization, err := client.Beta.Organization.Get(context.Background()) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", organization.ID) + fmt.Printf("name: %s\n", organization.Name) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var organization = client.beta().organization().retrieve(); + + IO.println("id: " + organization.id()); + IO.println("name: " + organization.name()); + ``` + + ```php PHP + $client = new Client(); + + $organization = $client->beta->organization->retrieve(); + + echo "id: {$organization->id}\n"; + echo "name: {$organization->name}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + organization = client.beta.organization.retrieve + + puts "id: #{organization.id}" + puts "name: #{organization.name}" + ``` + ```json { @@ -249,9 +1722,7 @@ curl "https://api.anthropic.com/v1/organizations/me" \ } ``` -This endpoint is useful for programmatically determining which organization an Admin API key belongs to. - -For complete parameter details and response schemas, see the [Organization Info API reference](https://platform.claude.com/docs/en/api/admin-api/organization/get-me). +For parameter details and response schemas, see the [Organization Info API reference](https://platform.claude.com/docs/en/api/admin-api/organization/get-me). ## Usage and cost reports @@ -267,14 +1738,12 @@ Read the rate limits configured for your organization and its workspaces with th ## Compliance API -Retrieve audit and activity data for your organization with the [Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api). Admin API keys can read the Activity Feed only; for full access, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api-access). +Retrieve audit and activity data for your organization with the [Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api). Admin API keys can read only the Activity Feed. For full access, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api-access). ## Best practices -To effectively use the Admin API: - * Use meaningful names and descriptions for workspaces and API keys -* Implement proper error handling for failed operations +* Handle errors from failed operations * Regularly audit member roles and permissions * Clean up unused workspaces and expired invites * Monitor API key usage, audit each key's [`expires_at`](https://platform.claude.com/docs/en/manage-claude/authentication#key-expiration), and rotate keys periodically @@ -287,19 +1756,19 @@ To effectively use the Admin API: - No, new API keys can only be created through the Claude Console for security reasons. The Admin API can only manage existing API keys. + No. You create API keys in the Claude Console. The Admin API can only read, rename, and change the status of existing keys. - API keys persist in their current state as they are scoped to the organization, not to individual users. + They're unaffected. API keys belong to the organization, not to individual users. - No, organization members with the admin role cannot be removed through the API for security reasons. + No. The API can't remove members with the admin role. - Organization invites expire after 21 days. There is currently no way to modify this expiration period. + Invites expire after 21 days. The expiration period isn't configurable. diff --git a/content/en/manage-claude/api-and-data-retention.md b/content/en/manage-claude/api-and-data-retention.md index ff1abb7c3..6e677a020 100644 --- a/content/en/manage-claude/api-and-data-retention.md +++ b/content/en/manage-claude/api-and-data-retention.md @@ -30,7 +30,7 @@ Under a ZDR arrangement, Anthropic does not store customer prompts or responses ### What ZDR does not cover -* **Claude Console:** Any usage in the Claude Console, including Playground. +* **Claude Console:** Any usage in the Claude Console, including playground. * **Claude Managed Agents:** Claude Managed Agents is a stateful resource; session transcripts persist until you delete them. * **Claude consumer products:** Claude Free, Pro, and Max plans, including when customers on those plans use Claude's web, desktop, or mobile apps or Claude Code. * **Claude Teams and Claude Enterprise product interfaces:** These interfaces are not ZDR-eligible. The exception is Claude Code used through Claude Enterprise with ZDR enabled; see [What ZDR covers](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#what-zdr-covers). diff --git a/content/en/manage-claude/cmek-aws-kms.md b/content/en/manage-claude/cmek-aws-kms.md index 8811845bc..eb326c078 100644 --- a/content/en/manage-claude/cmek-aws-kms.md +++ b/content/en/manage-claude/cmek-aws-kms.md @@ -134,24 +134,159 @@ How you register the key depends on which product you use. Create an external key configuration through the Admin API. - For organizations on [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), the external key endpoints are not yet available. Register, validate, and attach your key in the Claude Console instead. + For organizations on [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), the external key endpoints are not yet available. Register and attach your key in the Claude Console instead. There is no separate validation step: the key is implicitly validated when you attach it to a workspace (the attach call performs an encrypt/decrypt round), so a key policy problem surfaces at attach time rather than at registration. - ```bash - curl -sS https://api.anthropic.com/v1/organizations/external_keys \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -d '{ - "display_name": "", - "geo": "us", - "provider_config": { - "type": "aws", - "kms_arn": "", - "role_arn": "arn:aws:iam::915198916910:role/anthropic-cmek-client-us" + + ```bash cURL + curl -sS "https://api.anthropic.com/v1/organizations/external_keys" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "display_name": "", + "geo": "us", + "provider_config": { + "type": "aws", + "kms_arn": "" + } + }' + ``` + + ```bash CLI + ant beta:organization:external-keys create <<'YAML' + display_name: "" + geo: us + provider_config: + type: aws + kms_arn: "" + YAML + ``` + + ```python Python + client = anthropic.Anthropic() + + external_key = client.beta.organization.external_keys.create( + display_name="", + geo="us", + provider_config={"type": "aws", "kms_arn": ""}, + ) + + print(f"id: {external_key.id}") + print(f"display_name: {external_key.display_name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const externalKey = await client.beta.organization.externalKeys.create({ + display_name: "", + geo: "us", + provider_config: { + type: "aws", + kms_arn: "" } - }' - ``` + }); + + console.log(`id: ${externalKey.id}`); + console.log(`display_name: ${externalKey.display_name}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.ExternalKeys; + + AnthropicClient client = new(); + + var externalKey = await client.Beta.Organization.ExternalKeys.Create(new() + { + DisplayName = "", + Geo = Geo.Us, + ProviderConfig = new BetaAwsExternalKeyConfig + { + KmsArn = "" + } + }); + + Console.WriteLine($"id: {externalKey.ID}"); + Console.WriteLine($"display_name: {externalKey.DisplayName}"); + ``` + + ```go Go + client := anthropic.NewClient() + + externalKey, err := client.Beta.Organization.ExternalKeys.New(context.Background(), anthropic.BetaOrganizationExternalKeyNewParams{ + DisplayName: anthropic.String(""), + Geo: anthropic.BetaOrganizationExternalKeyNewParamsGeoUs, + ProviderConfig: anthropic.BetaOrganizationExternalKeyNewParamsProviderConfigUnion{ + OfAWS: &anthropic.BetaAWSExternalKeyConfigParam{ + KMSARN: "", + }, + }, + }) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", externalKey.ID) + fmt.Printf("display_name: %s\n", externalKey.DisplayName) + ``` + + ```java Java + import com.anthropic.models.beta.organization.externalkeys.BetaAwsExternalKeyConfig; + import com.anthropic.models.beta.organization.externalkeys.ExternalKeyCreateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = ExternalKeyCreateParams.builder() + .displayName("") + .geo(ExternalKeyCreateParams.Geo.US) + .providerConfig(BetaAwsExternalKeyConfig.builder() + .kmsArn("") + .build()) + .build(); + var externalKey = client.beta().organization().externalKeys().create(params); + + IO.println("id: " + externalKey.id()); + IO.println("display_name: " + externalKey.displayName().orElseThrow()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\ExternalKeys\ExternalKeyCreateParams\Geo; + // ... + + $client = new Client(); + + $externalKey = $client->beta->organization->externalKeys->create( + displayName: '', + geo: Geo::US, + providerConfig: [ + 'type' => 'aws', + 'kmsARN' => '', + ], + ); + + echo "id: {$externalKey->id}\n"; + echo "display_name: {$externalKey->displayName}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + external_key = client.beta.organization.external_keys.create( + display_name: "", + geo: :us, + provider_config: { + type: :aws, + kms_arn: "" + } + ) + + puts "id: #{external_key.id}" + puts "display_name: #{external_key.display_name}" + ``` + The response contains the external key ID: @@ -167,13 +302,86 @@ How you register the key depends on which product you use. Trigger an encrypt and decrypt round-trip against your key. - ```bash - curl -sS -X POST https://api.anthropic.com/v1/organizations/external_keys/ekey_/validate \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -d '{}' - ``` + + ```bash cURL + curl -sS -X POST "https://api.anthropic.com/v1/organizations/external_keys/ekey_/validate" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:external-keys validate --external-key-id "ekey_" + ``` + + ```python Python + client = anthropic.Anthropic() + + validation = client.beta.organization.external_keys.validate("ekey_") + + print(f"status: {validation.status}") + print(f"error: {validation.error}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const validation = await client.beta.organization.externalKeys.validate("ekey_"); + + console.log(`status: ${validation.status}`); + console.log(`error: ${validation.error}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var validation = await client.Beta.Organization.ExternalKeys.Validate("ekey_"); + + Console.WriteLine($"status: {validation.Status.Raw()}"); + Console.WriteLine($"error: {validation.Error}"); + ``` + + ```go Go + client := anthropic.NewClient() + + validation, err := client.Beta.Organization.ExternalKeys.Validate(context.Background(), "ekey_") + if err != nil { + log.Fatal(err) + } + + fmt.Printf("status: %s\n", validation.Status) + fmt.Printf("error: %s\n", validation.Error) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var validation = client.beta().organization().externalKeys().validate("ekey_"); + + IO.println("status: " + validation.status().asString()); + IO.println("error: " + validation.error().orElse("")); + ``` + + ```php PHP + $client = new Client(); + + $validation = $client->beta->organization->externalKeys->validate( + externalKeyID: 'ekey_', + ); + + echo "status: {$validation->status}\n"; + echo "error: {$validation->error}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + external_key_id = "ekey_" + validation = client.beta.organization.external_keys.validate(external_key_id) + + puts "status: #{validation.status}" + puts "error: #{validation.error}" + ``` + A successful response looks like this: @@ -192,15 +400,116 @@ How you register the key depends on which product you use. Once the key is validated, attach it to a new workspace before you send any requests to that workspace. For a workspace that already receives requests, the key can take [up to a day to take effect](https://platform.claude.com/docs/en/manage-claude/cmek#how-it-works). - ```bash - curl -sS -X POST https://api.anthropic.com/v1/organizations/workspaces/ \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -d '{ - "external_key_id": "ekey_" - }' - ``` + + ```bash cURL + curl -sS -X POST "https://api.anthropic.com/v1/organizations/workspaces/" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "external_key_id": "ekey_" + }' + ``` + + ```bash CLI + ant beta:organization:workspaces update \ + --workspace-id "" \ + --external-key-id "ekey_" + ``` + + ```python Python + client = anthropic.Anthropic() + + workspace = client.beta.organization.workspaces.update( + "", external_key_id="ekey_" + ) + + print(f"id: {workspace.id}") + print(f"external_key_id: {workspace.external_key_id}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const workspace = await client.beta.organization.workspaces.update("", { + external_key_id: "ekey_" + }); + + console.log(`id: ${workspace.id}`); + console.log(`external_key_id: ${workspace.external_key_id}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var workspace = await client.Beta.Organization.Workspaces.Update("", new() + { + ExternalKeyID = "ekey_" + }); + + Console.WriteLine($"id: {workspace.ID}"); + Console.WriteLine($"external_key_id: {workspace.ExternalKeyID}"); + ``` + + ```go Go + client := anthropic.NewClient() + + workspace, err := client.Beta.Organization.Workspaces.Update( + context.Background(), + "", + anthropic.BetaOrganizationWorkspaceUpdateParams{ + ExternalKeyID: anthropic.String("ekey_"), + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", workspace.ID) + fmt.Printf("external_key_id: %s\n", workspace.ExternalKeyID) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.WorkspaceUpdateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = WorkspaceUpdateParams.builder() + .externalKeyId("ekey_") + .build(); + var workspace = client.beta().organization().workspaces().update("", params); + + IO.println("id: " + workspace.id()); + IO.println("external_key_id: " + workspace.externalKeyId().orElseThrow()); + } + ``` + + ```php PHP + $client = new Client(); + + $workspace = $client->beta->organization->workspaces->update( + workspaceID: '', + externalKeyID: 'ekey_', + ); + + echo "id: {$workspace->id}\n"; + echo "external_key_id: {$workspace->externalKeyID}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace_id = "" + workspace = client.beta.organization.workspaces.update( + workspace_id, + external_key_id: "ekey_" + ) + + puts "id: #{workspace.id}" + puts "external_key_id: #{workspace.external_key_id}" + ``` + diff --git a/content/en/manage-claude/cmek-azure-key-vault.md b/content/en/manage-claude/cmek-azure-key-vault.md index eb3beb344..5073086c3 100644 --- a/content/en/manage-claude/cmek-azure-key-vault.md +++ b/content/en/manage-claude/cmek-azure-key-vault.md @@ -147,22 +147,177 @@ How you register the key depends on which product you use. Create an external key configuration through the Admin API. - ```bash - curl -sS https://api.anthropic.com/v1/organizations/external_keys \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -d '{ - "display_name": "", - "geo": "us", - "provider_config": { - "type": "azure", - "vault_uri": "https://.vault.azure.net/", - "key_name": "", - "tenant_id": "" + + ```bash cURL + curl -sS "https://api.anthropic.com/v1/organizations/external_keys" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "display_name": "", + "geo": "us", + "provider_config": { + "type": "azure", + "vault_uri": "https://.vault.azure.net/", + "key_name": "", + "tenant_id": "" + } + }' + ``` + + ```bash CLI + ant beta:organization:external-keys create <<'YAML' + display_name: "" + geo: us + provider_config: + type: azure + vault_uri: "https://.vault.azure.net/" + key_name: "" + tenant_id: "" + YAML + ``` + + ```python Python + client = anthropic.Anthropic() + + external_key = client.beta.organization.external_keys.create( + display_name="", + geo="us", + provider_config={ + "type": "azure", + "vault_uri": "https://.vault.azure.net/", + "key_name": "", + "tenant_id": "", + }, + ) + + print(f"id: {external_key.id}") + print(f"display_name: {external_key.display_name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const externalKey = await client.beta.organization.externalKeys.create({ + display_name: "", + geo: "us", + provider_config: { + type: "azure", + vault_uri: "https://.vault.azure.net/", + key_name: "", + tenant_id: "" } - }' - ``` + }); + + console.log(`id: ${externalKey.id}`); + console.log(`display_name: ${externalKey.display_name}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.ExternalKeys; + + AnthropicClient client = new(); + + var externalKey = await client.Beta.Organization.ExternalKeys.Create(new() + { + DisplayName = "", + Geo = Geo.Us, + ProviderConfig = new BetaAzureExternalKeyConfigParam + { + VaultUri = "https://.vault.azure.net/", + KeyName = "", + TenantID = "" + } + }); + + Console.WriteLine($"id: {externalKey.ID}"); + Console.WriteLine($"display_name: {externalKey.DisplayName}"); + ``` + + ```go Go + client := anthropic.NewClient() + + externalKey, err := client.Beta.Organization.ExternalKeys.New(context.Background(), anthropic.BetaOrganizationExternalKeyNewParams{ + DisplayName: anthropic.String(""), + Geo: anthropic.BetaOrganizationExternalKeyNewParamsGeoUs, + ProviderConfig: anthropic.BetaOrganizationExternalKeyNewParamsProviderConfigUnion{ + OfAzure: &anthropic.BetaAzureExternalKeyConfigParam{ + VaultURI: "https://.vault.azure.net/", + KeyName: "", + TenantID: "", + }, + }, + }) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", externalKey.ID) + fmt.Printf("display_name: %s\n", externalKey.DisplayName) + ``` + + ```java Java + import com.anthropic.models.beta.organization.externalkeys.BetaAzureExternalKeyConfigParam; + import com.anthropic.models.beta.organization.externalkeys.ExternalKeyCreateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = ExternalKeyCreateParams.builder() + .displayName("") + .geo(ExternalKeyCreateParams.Geo.US) + .providerConfig(BetaAzureExternalKeyConfigParam.builder() + .vaultUri("https://.vault.azure.net/") + .keyName("") + .tenantId("") + .build()) + .build(); + var externalKey = client.beta().organization().externalKeys().create(params); + + IO.println("id: " + externalKey.id()); + IO.println("display_name: " + externalKey.displayName().orElseThrow()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\ExternalKeys\ExternalKeyCreateParams\Geo; + // ... + + $client = new Client(); + + $externalKey = $client->beta->organization->externalKeys->create( + displayName: '', + geo: Geo::US, + providerConfig: [ + 'type' => 'azure', + 'vaultURI' => 'https://.vault.azure.net/', + 'keyName' => '', + 'tenantID' => '', + ], + ); + + echo "id: {$externalKey->id}\n"; + echo "display_name: {$externalKey->displayName}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + external_key = client.beta.organization.external_keys.create( + display_name: "", + geo: :us, + provider_config: { + type: :azure, + vault_uri: "https://.vault.azure.net/", + key_name: "", + tenant_id: "" + } + ) + + puts "id: #{external_key.id}" + puts "display_name: #{external_key.display_name}" + ``` + The response contains the external key ID: @@ -178,12 +333,85 @@ How you register the key depends on which product you use. Trigger an encrypt and decrypt round-trip against your key. This confirms that Anthropic can authenticate to your tenant and perform wrap and unwrap operations. - ```bash - curl -sS -X POST https://api.anthropic.com/v1/organizations/external_keys/ekey_/validate \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" -d '{}' - ``` + + ```bash cURL + curl -sS -X POST "https://api.anthropic.com/v1/organizations/external_keys/ekey_/validate" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:external-keys validate --external-key-id "ekey_" + ``` + + ```python Python + client = anthropic.Anthropic() + + validation = client.beta.organization.external_keys.validate("ekey_") + + print(f"status: {validation.status}") + print(f"error: {validation.error}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const validation = await client.beta.organization.externalKeys.validate("ekey_"); + + console.log(`status: ${validation.status}`); + console.log(`error: ${validation.error}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var validation = await client.Beta.Organization.ExternalKeys.Validate("ekey_"); + + Console.WriteLine($"status: {validation.Status.Raw()}"); + Console.WriteLine($"error: {validation.Error}"); + ``` + + ```go Go + client := anthropic.NewClient() + + validation, err := client.Beta.Organization.ExternalKeys.Validate(context.Background(), "ekey_") + if err != nil { + log.Fatal(err) + } + + fmt.Printf("status: %s\n", validation.Status) + fmt.Printf("error: %s\n", validation.Error) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var validation = client.beta().organization().externalKeys().validate("ekey_"); + + IO.println("status: " + validation.status().asString()); + IO.println("error: " + validation.error().orElse("")); + ``` + + ```php PHP + $client = new Client(); + + $validation = $client->beta->organization->externalKeys->validate( + externalKeyID: 'ekey_', + ); + + echo "status: {$validation->status}\n"; + echo "error: {$validation->error}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + validation = client.beta.organization.external_keys.validate("ekey_") + + puts "status: #{validation.status}" + puts "error: #{validation.error}" + ``` + A successful response looks like this: @@ -201,15 +429,115 @@ How you register the key depends on which product you use. Once the key is validated, attach it to a new workspace before you send any requests to that workspace. For a workspace that already receives requests, the key can take [up to a day to take effect](https://platform.claude.com/docs/en/manage-claude/cmek#how-it-works). - ```bash - curl -sS -X POST https://api.anthropic.com/v1/organizations/workspaces/ \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -d '{ - "external_key_id": "ekey_" - }' - ``` + + ```bash cURL + curl -sS -X POST "https://api.anthropic.com/v1/organizations/workspaces/" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "external_key_id": "ekey_" + }' + ``` + + ```bash CLI + ant beta:organization:workspaces update \ + --workspace-id "" \ + --external-key-id "ekey_" + ``` + + ```python Python + client = anthropic.Anthropic() + + workspace = client.beta.organization.workspaces.update( + "", external_key_id="ekey_" + ) + + print(f"id: {workspace.id}") + print(f"external_key_id: {workspace.external_key_id}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const workspace = await client.beta.organization.workspaces.update("", { + external_key_id: "ekey_" + }); + + console.log(`id: ${workspace.id}`); + console.log(`external_key_id: ${workspace.external_key_id}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var workspace = await client.Beta.Organization.Workspaces.Update("", new() + { + ExternalKeyID = "ekey_" + }); + + Console.WriteLine($"id: {workspace.ID}"); + Console.WriteLine($"external_key_id: {workspace.ExternalKeyID}"); + ``` + + ```go Go + client := anthropic.NewClient() + + workspace, err := client.Beta.Organization.Workspaces.Update( + context.Background(), + "", + anthropic.BetaOrganizationWorkspaceUpdateParams{ + ExternalKeyID: anthropic.String("ekey_"), + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", workspace.ID) + fmt.Printf("external_key_id: %s\n", workspace.ExternalKeyID) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.WorkspaceUpdateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = WorkspaceUpdateParams.builder() + .externalKeyId("ekey_") + .build(); + var workspace = client.beta().organization().workspaces().update("", params); + + IO.println("id: " + workspace.id()); + IO.println("external_key_id: " + workspace.externalKeyId().orElseThrow()); + } + ``` + + ```php PHP + $client = new Client(); + + $workspace = $client->beta->organization->workspaces->update( + workspaceID: '', + externalKeyID: 'ekey_', + ); + + echo "id: {$workspace->id}\n"; + echo "external_key_id: {$workspace->externalKeyID}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace = client.beta.organization.workspaces.update( + "", + external_key_id: "ekey_" + ) + + puts "id: #{workspace.id}" + puts "external_key_id: #{workspace.external_key_id}" + ``` + diff --git a/content/en/manage-claude/cmek-google-cloud-kms.md b/content/en/manage-claude/cmek-google-cloud-kms.md index ada0dc309..d933f9d82 100644 --- a/content/en/manage-claude/cmek-google-cloud-kms.md +++ b/content/en/manage-claude/cmek-google-cloud-kms.md @@ -140,20 +140,157 @@ How you register the key depends on which product you use. Create an external key configuration through the Admin API, using the resource name from the Note the full key resource name step under Encryption key setup. - ```bash - curl -sS https://api.anthropic.com/v1/organizations/external_keys \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -d '{ - "display_name": "", - "geo": "us", - "provider_config": { - "type": "gcp", - "key_name": "projects//locations//keyRings//cryptoKeys/" + + ```bash cURL + curl -sS "https://api.anthropic.com/v1/organizations/external_keys" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "display_name": "", + "geo": "us", + "provider_config": { + "type": "gcp", + "key_name": "projects//locations//keyRings//cryptoKeys/" + } + }' + ``` + + ```bash CLI + ant beta:organization:external-keys create <<'YAML' + display_name: "" + geo: us + provider_config: + type: gcp + key_name: "projects//locations//keyRings//cryptoKeys/" + YAML + ``` + + ```python Python + client = anthropic.Anthropic() + + external_key = client.beta.organization.external_keys.create( + display_name="", + geo="us", + provider_config={ + "type": "gcp", + "key_name": "projects//locations//keyRings//cryptoKeys/", + }, + ) + + print(f"id: {external_key.id}") + print(f"display_name: {external_key.display_name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const externalKey = await client.beta.organization.externalKeys.create({ + display_name: "", + geo: "us", + provider_config: { + type: "gcp", + key_name: + "projects//locations//keyRings//cryptoKeys/" } - }' - ``` + }); + + console.log(`id: ${externalKey.id}`); + console.log(`display_name: ${externalKey.display_name}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.ExternalKeys; + + AnthropicClient client = new(); + + var externalKey = await client.Beta.Organization.ExternalKeys.Create(new() + { + DisplayName = "", + Geo = Geo.Us, + ProviderConfig = new BetaGcpExternalKeyConfig + { + KeyName = "projects//locations//keyRings//cryptoKeys/" + } + }); + + Console.WriteLine($"id: {externalKey.ID}"); + Console.WriteLine($"display_name: {externalKey.DisplayName}"); + ``` + + ```go Go + client := anthropic.NewClient() + + externalKey, err := client.Beta.Organization.ExternalKeys.New(context.Background(), anthropic.BetaOrganizationExternalKeyNewParams{ + DisplayName: anthropic.String(""), + Geo: anthropic.BetaOrganizationExternalKeyNewParamsGeoUs, + ProviderConfig: anthropic.BetaOrganizationExternalKeyNewParamsProviderConfigUnion{ + OfGCP: &anthropic.BetaGCPExternalKeyConfigParam{ + KeyName: "projects//locations//keyRings//cryptoKeys/", + }, + }, + }) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", externalKey.ID) + fmt.Printf("display_name: %s\n", externalKey.DisplayName) + ``` + + ```java Java + import com.anthropic.models.beta.organization.externalkeys.ExternalKeyCreateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = ExternalKeyCreateParams.builder() + .displayName("") + .geo(ExternalKeyCreateParams.Geo.US) + .gcpProviderConfig("projects//locations//keyRings//cryptoKeys/") + .build(); + var externalKey = client.beta().organization().externalKeys().create(params); + + IO.println("id: " + externalKey.id()); + IO.println("display_name: " + externalKey.displayName().orElseThrow()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\ExternalKeys\ExternalKeyCreateParams\Geo; + // ... + + $client = new Client(); + + $externalKey = $client->beta->organization->externalKeys->create( + displayName: '', + geo: Geo::US, + providerConfig: [ + 'type' => 'gcp', + 'keyName' => 'projects//locations//keyRings//cryptoKeys/', + ], + ); + + echo "id: {$externalKey->id}\n"; + echo "display_name: {$externalKey->displayName}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + external_key = client.beta.organization.external_keys.create( + display_name: "", + geo: :us, + provider_config: { + type: :gcp, + key_name: "projects//locations//keyRings//cryptoKeys/" + } + ) + + puts "id: #{external_key.id}" + puts "display_name: #{external_key.display_name}" + ``` + The response contains the external key ID: @@ -169,13 +306,86 @@ How you register the key depends on which product you use. Trigger an encrypt and decrypt round-trip against your key. - ```bash - curl -sS -X POST https://api.anthropic.com/v1/organizations/external_keys/ekey_/validate \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -d '{}' - ``` + + ```bash cURL + curl -sS -X POST "https://api.anthropic.com/v1/organizations/external_keys/ekey_/validate" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:external-keys validate --external-key-id "ekey_" + ``` + + ```python Python + client = anthropic.Anthropic() + + validation = client.beta.organization.external_keys.validate("ekey_") + + print(f"status: {validation.status}") + print(f"error: {validation.error}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const validation = await client.beta.organization.externalKeys.validate("ekey_"); + + console.log(`status: ${validation.status}`); + console.log(`error: ${validation.error}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var validation = await client.Beta.Organization.ExternalKeys.Validate("ekey_"); + + Console.WriteLine($"status: {validation.Status.Raw()}"); + Console.WriteLine($"error: {validation.Error}"); + ``` + + ```go Go + client := anthropic.NewClient() + + validation, err := client.Beta.Organization.ExternalKeys.Validate(context.Background(), "ekey_") + if err != nil { + log.Fatal(err) + } + + fmt.Printf("status: %s\n", validation.Status) + fmt.Printf("error: %s\n", validation.Error) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var validation = client.beta().organization().externalKeys().validate("ekey_"); + + IO.println("status: " + validation.status().asString()); + IO.println("error: " + validation.error().orElse("")); + ``` + + ```php PHP + $client = new Client(); + + $validation = $client->beta->organization->externalKeys->validate( + externalKeyID: 'ekey_', + ); + + echo "status: {$validation->status}\n"; + echo "error: {$validation->error}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + external_key_id = "ekey_" + validation = client.beta.organization.external_keys.validate(external_key_id) + + puts "status: #{validation.status}" + puts "error: #{validation.error}" + ``` + A successful response looks like this: @@ -193,15 +403,116 @@ How you register the key depends on which product you use. Once the key is validated, attach it to a new workspace before you send any requests to that workspace. For a workspace that already receives requests, the key can take [up to a day to take effect](https://platform.claude.com/docs/en/manage-claude/cmek#how-it-works). - ```bash - curl -sS -X POST https://api.anthropic.com/v1/organizations/workspaces/ \ - -H "x-api-key: " \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -d '{ - "external_key_id": "ekey_" - }' - ``` + + ```bash cURL + curl -sS -X POST "https://api.anthropic.com/v1/organizations/workspaces/" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "external_key_id": "ekey_" + }' + ``` + + ```bash CLI + ant beta:organization:workspaces update \ + --workspace-id "" \ + --external-key-id "ekey_" + ``` + + ```python Python + client = anthropic.Anthropic() + + workspace = client.beta.organization.workspaces.update( + "", external_key_id="ekey_" + ) + + print(f"id: {workspace.id}") + print(f"external_key_id: {workspace.external_key_id}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const workspace = await client.beta.organization.workspaces.update("", { + external_key_id: "ekey_" + }); + + console.log(`id: ${workspace.id}`); + console.log(`external_key_id: ${workspace.external_key_id}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var workspace = await client.Beta.Organization.Workspaces.Update("", new() + { + ExternalKeyID = "ekey_" + }); + + Console.WriteLine($"id: {workspace.ID}"); + Console.WriteLine($"external_key_id: {workspace.ExternalKeyID}"); + ``` + + ```go Go + client := anthropic.NewClient() + + workspace, err := client.Beta.Organization.Workspaces.Update( + context.Background(), + "", + anthropic.BetaOrganizationWorkspaceUpdateParams{ + ExternalKeyID: anthropic.String("ekey_"), + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", workspace.ID) + fmt.Printf("external_key_id: %s\n", workspace.ExternalKeyID) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.WorkspaceUpdateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = WorkspaceUpdateParams.builder() + .externalKeyId("ekey_") + .build(); + var workspace = client.beta().organization().workspaces().update("", params); + + IO.println("id: " + workspace.id()); + IO.println("external_key_id: " + workspace.externalKeyId().orElseThrow()); + } + ``` + + ```php PHP + $client = new Client(); + + $workspace = $client->beta->organization->workspaces->update( + workspaceID: '', + externalKeyID: 'ekey_', + ); + + echo "id: {$workspace->id}\n"; + echo "external_key_id: {$workspace->externalKeyID}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace_id = "" + workspace = client.beta.organization.workspaces.update( + workspace_id, + external_key_id: "ekey_" + ) + + puts "id: #{workspace.id}" + puts "external_key_id: #{workspace.external_key_id}" + ``` + diff --git a/content/en/manage-claude/cmek.md b/content/en/manage-claude/cmek.md index 93693240e..f97b2618e 100644 --- a/content/en/manage-claude/cmek.md +++ b/content/en/manage-claude/cmek.md @@ -41,7 +41,7 @@ Anthropic calls your key management service from its standard public IP range. I CMEK is currently available in US regions only, and all encryption operations are processed in US regions. -On [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), CMEK is available with AWS KMS keys only; Google Cloud KMS and Azure Key Vault keys cannot be registered. Create, validate, and attach keys in the Claude Console; the `external_keys` API endpoints are not currently available on Claude Platform on AWS. The key must be in the same AWS region as the workspace it is attached to. +On [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), CMEK is available with AWS KMS keys only; Google Cloud KMS and Azure Key Vault keys cannot be registered. Create and attach keys in the Claude Console; the `external_keys` API endpoints are not currently available on Claude Platform on AWS. There is no separate validation step: the key is implicitly validated when you attach it to a workspace (the attach call performs an encrypt/decrypt round), so a key policy problem surfaces at attach time rather than at registration. The key must be in the same AWS region as the workspace it is attached to. For minimal latency, choose a region close to Anthropic's US infrastructure: @@ -68,6 +68,7 @@ What CMEK covers depends on which product you use. * Chat attachments and project attachments. * Claude Code on the CLI, including message content. * Cowork in Claude Desktop. +* Compliance API [local session transcripts](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-local-sessions) captured from sessions on users' machines. If your key cannot be used, the messages endpoint returns [503 Service Unavailable](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-sessions-temporarily-unavailable) instead of transcript content. Session metadata is still listed. * Office agents. * Claude in Chrome. @@ -81,7 +82,7 @@ Some features are turned off or substantially modified when CMEK is enabled. Thi * Playground in the Claude Console is disabled. * Portions of the Compliance API that return raw content, such as prompts, responses, and files, are disabled. -* Other beta and research preview features may not be covered by CMEK. +* Other beta and research preview features might not be covered by CMEK. **Claude Enterprise** @@ -90,7 +91,6 @@ Some features are turned off or substantially modified when CMEK is enabled. Thi * Certain analytics are degraded: admin analytics for claude.ai skills and connectors (under claude.ai/analytics/usage and through the [Claude Enterprise Analytics API](https://platform.claude.com/docs/en/manage-claude/analytics-api)), Claude smart reports (under claude.ai/analytics/insights), and Claude Code contribution metrics (under claude.ai/analytics/claude-code). * Audit log exports are disabled. * Signed URLs for temporary file exchanges are disabled. These back organization data exports in claude.ai and Claude Code Remote file flows such as screenshot updates. -* Compliance API [local session transcripts](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-local-sessions) (Cowork and Claude Code on users' machines) currently return no message content. Session metadata is listed as usual, and the local session messages endpoint (`GET /v1/compliance/apps/sessions/local/{session_id}/messages`) returns each message with its content marked unavailable; see [Retrieve a local session transcript](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-a-local-session-transcript) for the response shape. ### Encrypted with Anthropic key @@ -106,7 +106,7 @@ These features remain available, but their data is not encrypted under your key. **Claude Enterprise** * Claude Code Desktop, Claude Code on the web, and Claude in Slack. Anthropic recommends disabling any of these that are not appropriate for your use case in the admin console. -* Beta and research preview features may not be covered by CMEK and can break in CMEK organizations, for example, Claude Security and Claude Design. +* Beta and research preview features might not be covered by CMEK and can break in CMEK organizations, for example, Claude Security and Claude Design. * On-demand data export under **Settings** > **Privacy**. * [Personal preferences - Instructions for Claude section](https://claude.ai/new#settings/general) and Cowork Global instructions. These are set at the account level and shared across all of a user's organizations. @@ -146,7 +146,8 @@ Outside of [CSAM screening](https://support.claude.com/en/articles/9020328-csam- * **No retroactive encryption:** CMEK only protects data written after your key takes effect (see [How it works](https://platform.claude.com/docs/en/manage-claude/cmek#how-it-works)). * **Latency:** Operations that wrap or unwrap data keys make a round-trip to your key management service, which can add a small amount of latency to actions that read or write data at rest. * **Revocation delay:** Key revocation can take up to 1 hour (the cache TTL). Requests already in flight during that window may continue to succeed. -* **KMS costs:** CMEK requires a key in a third-party key management service (AWS KMS, Google Cloud KMS, or Azure Key Vault), which may incur separate charges billed by your KMS provider. +* **KMS costs:** CMEK requires a key in a third-party key management service (AWS KMS, Google Cloud KMS, or Azure Key Vault), which might incur separate charges billed by your KMS provider. +* **Claude Code telemetry behind a gateway:** When Claude Code connects through an LLM gateway or proxy (a custom `ANTHROPIC_BASE_URL`), CMEK does not apply to Claude Code's operational telemetry. To turn this telemetry off, set the `DISABLE_TELEMETRY` environment variable to `1`, as described under [Telemetry services](https://code.claude.com/docs/en/data-usage#telemetry-services) in the Claude Code documentation. ## Configure your provider diff --git a/content/en/manage-claude/compliance-api.md b/content/en/manage-claude/compliance-api.md index 088ba4438..7fba631dc 100644 --- a/content/en/manage-claude/compliance-api.md +++ b/content/en/manage-claude/compliance-api.md @@ -4,7 +4,7 @@ url: https://platform.claude.com/docs/en/manage-claude/compliance-api description: Programmatic access to your organization's Claude activity, chats, files, projects, Claude Cowork and Claude Code sessions, and users for compliance, audit, and governance. --- -The Compliance API gives Claude Enterprise and Claude Console customers programmatic access to their organization's Activity Feed. For Claude Enterprise organizations, it also covers the directory of users, roles, and groups across every linked organization; the effective settings in force for each organization; the underlying chats, files, and projects in claude.ai organizations; and Cowork and Claude Code sessions. Security, legal, and compliance teams use it to audit activity, retrieve or delete content, and feed events into downstream tooling. +The Compliance API gives Claude Enterprise and Claude Console customers programmatic access to their organization's Activity Feed. For Claude Enterprise organizations, it also covers the directory of users, roles, and groups across every linked organization; the effective settings in force for each organization; the underlying chats, files, and projects in claude.ai organizations; and Cowork, Claude Code, Claude Science, and Claude for Microsoft 365 sessions. Security, legal, and compliance teams use it to audit activity, retrieve or delete content, and feed events into downstream tooling. Two key types unlock the Compliance API. A **Compliance Access Key** (created in claude.ai) reaches every endpoint, and an **Admin API key** (created in Claude Console) reaches the Activity Feed only. See [Which key do you need?](https://platform.claude.com/docs/en/manage-claude/compliance-api-access#which-key-do-you-need) for the full key-type comparison. @@ -54,7 +54,7 @@ Every endpoint lives under `/v1/compliance/*` on `https://api.anthropic.com` and The Activity Feed (`GET /v1/compliance/activities`) is available to any key that carries the `read:compliance_activities` scope; see [Query the Activity Feed](https://platform.claude.com/docs/en/manage-claude/compliance-activity-feed) for filters, pagination, and the full `Activity` object. The remaining endpoints require a Compliance Access Key carrying the relevant scope. -A Claude Enterprise tenant has one parent organization (the top-level container that centralizes identity) with linked organizations of two kinds: claude.ai organizations, where users chat and store content, and Claude Console organizations, where users manage Claude API workloads. For a key that covers the parent organization, the directory endpoints (organizations, users, roles, and groups) return data from every linked organization of either kind. The content endpoints (chats, files, projects, project attachments, and sessions) serve Claude Enterprise data only. The chat, file, and project endpoints return claude.ai chats, files, and projects. The session endpoints return transcripts of Cowork and Claude Code sessions on users' machines (local sessions), captured while users are signed in with their Claude Enterprise account. They also return transcripts of Cowork sessions started on claude.ai web or mobile, which run in the cloud in Anthropic-managed environments (remote sessions). A standalone Claude Console organization (one with no parent organization) is not part of a Claude Enterprise tenant; it uses Admin API keys and can query the Activity Feed only. +A Claude Enterprise tenant has one parent organization (the top-level container that centralizes identity) with linked organizations of two kinds: claude.ai organizations, where users chat and store content, and Claude Console organizations, where users manage Claude API workloads. For a key that covers the parent organization, the directory endpoints (organizations, users, roles, and groups) return data from every linked organization of either kind. The content endpoints (chats, files, projects, project attachments, and sessions) serve Claude Enterprise data only. The chat, file, and project endpoints return claude.ai chats, files, and projects. The session endpoints return transcripts of Cowork, Claude Code, Claude Science, and Claude for Microsoft 365 sessions on users' machines (local sessions), captured while users are signed in with their Claude Enterprise account. They also return transcripts of Cowork sessions started on claude.ai web or mobile, which run in the cloud in Anthropic-managed environments (remote sessions). A standalone Claude Console organization (one with no parent organization) is not part of a Claude Enterprise tenant; it uses Admin API keys and can query the Activity Feed only. All `/v1/compliance/*` endpoints share a rate limit of 600 requests per minute per parent organization (for a standalone Claude Console organization, per organization). The local session endpoints count only against that shared limit, and the remote session endpoints carry a second request budget on top. See [429 Too Many Requests](https://platform.claude.com/docs/en/manage-claude/compliance-errors#429-too-many-requests) for the response headers and retry contract. diff --git a/content/en/manage-claude/compliance-content-data.md b/content/en/manage-claude/compliance-content-data.md index a0b484cf7..249d3a655 100644 --- a/content/en/manage-claude/compliance-content-data.md +++ b/content/en/manage-claude/compliance-content-data.md @@ -14,7 +14,7 @@ description: Access chat content, file attachments, and projects for claude.ai o **Prerequisite:** None for listing chats organization-wide. To filter the chat list to specific users, you need user IDs from [List organization users](https://platform.claude.com/docs/en/manage-claude/compliance-org-data#list-organization-users). The other endpoints on this page take resource IDs directly. -The endpoints on this page expose Claude Enterprise chat content, file uploads, projects, and project attachments to compliance reviewers. They support eDiscovery (electronic discovery) exports, data loss prevention (DLP) enforcement, and account-deletion responses. Chat, file, and project content is retained for as long as your organization's retention policy allows. Chats that a user has soft-deleted in claude.ai remain visible through the Compliance API with `deleted_at` populated; chats that have been hard-deleted (through the Compliance API itself, or after the organization's retention window expires) are not retrievable. +The endpoints on this page expose Claude Enterprise chat content, file uploads, projects, and project attachments to compliance reviewers. They support eDiscovery (electronic discovery) exports, data loss prevention (DLP) enforcement, and account-deletion responses. Chat, file, and project content is retained for as long as your organization's retention policy allows. When a user deletes a chat in claude.ai, its message content, attached files, tool-generated files, and artifacts are deleted with it. The Compliance API still lists the chat, with `deleted_at` populated and an empty `name`, and returns its messages without their content. Chats that have been hard-deleted (through the Compliance API itself, or after the organization's retention window expires) are not retrievable. Both scopes are granted only on Compliance Access Keys (`sk-ant-api01-...`) created in claude.ai; see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api-access) to provision one. The `read:compliance_user_data` scope covers retrieval; `delete:compliance_user_data` is required only for the delete endpoints. The chat, file, project, and attachment endpoints are not available to Admin API keys (`sk-ant-admin01-...`); calls authenticated with an Admin API key return [403 Forbidden](https://platform.claude.com/docs/en/manage-claude/compliance-errors#403-forbidden). @@ -24,7 +24,7 @@ Endpoints on this page paginate two ways; see [Paginate results](https://platfor Use [List chats](https://platform.claude.com/docs/en/api/compliance/apps/chats/list) to page through chat metadata, then [Get chat messages](https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list) to fetch the full message content of one chat. -The chat list endpoint defaults to organization-wide scope: leave off `user_ids[]` to include every chat under your parent organization. Add `order_by=updated_at` to sort by last update time. This combination is the recommended way to export chats and keep an export current, because one paginated loop picks up both new and modified chats for every user without enumerating users first. The following request lists chats updated since a given date. +The chat list endpoint defaults to organization-wide scope: leave off `user_ids[]` to include every chat under your parent organization. Add `order_by=updated_at` to sort by last update time. This combination is the recommended way to export chats and keep an export current, because one paginated loop picks up new chats, modified chats, and chats deleted in claude.ai for every user without enumerating users first. The following request lists chats updated since a given date. ```bash cURL curl --fail-with-body -sS -G \ @@ -62,7 +62,7 @@ curl --fail-with-body -sS -G \ Results sort ascending by the `order_by` field, oldest first, with ties broken by `id`. Pagination uses the standard `first_id`/`last_id`/`has_more` cursor fields described in [Paginate results](https://platform.claude.com/docs/en/manage-claude/compliance-activity-feed#paginate-results). To walk forward toward newer chats, pass the response's `last_id` back as `after_id` on the next request. -That forward walk is also how you keep an export current across runs: persist the final page's `last_id` and resume from it as `after_id` on the next run. Because the list is ordered by `updated_at`, a chat that changes after your saved cursor reappears ahead of it, so each incremental run returns both brand-new chats and older chats that have since been modified. Process results idempotently, keyed by chat `id`, to handle those reappearances. +That forward walk is also how you keep an export current across runs: persist the final page's `last_id` and resume from it as `after_id` on the next run. Because the list is ordered by `updated_at`, a chat that changes after your saved cursor reappears ahead of it, so each incremental run returns both brand-new chats and older chats that have since been modified or deleted in claude.ai. Process results idempotently, keyed by chat `id`, to handle those reappearances. A chat that comes back with `deleted_at` populated has no content left to fetch, so treat it as deleted rather than updated. A few constraints apply to these organization-wide queries. Cursors are opaque and bound to the sort key, so an `after_id` issued under one `order_by` value is rejected with a 400 error under the other. Time-filter bounds must match the sort key too: pair `updated_at.*` bounds with `order_by=updated_at`, and `created_at.*` bounds with the default `order_by=created_at`. Backward pagination with `before_id` is not supported, and the `project_ids[]` filter is not available. See [List chats](https://platform.claude.com/docs/en/api/compliance/apps/chats/list) for the full filter reference. @@ -119,7 +119,10 @@ The messages endpoint returns the chat's metadata plus a `chat_messages` array s { "id": "claude_file_01UaT9wBcDfGhJkLmNpQrSv7", "filename": "dashboard_mockup_v1.pdf", - "mime_type": "application/pdf" + "mime_type": "application/pdf", + "size_bytes": 482133, + "md5": "56367e4d2705cc9c025ad07424e944f0", + "created_at": "2026-04-10T08:09:10Z" } ] }, @@ -137,7 +140,9 @@ The messages endpoint returns the chat's metadata plus a `chat_messages` array s { "id": "claude_gen_file_01TbR8wAcCeFhJkLnPqStUvX", "filename": "requirements_summary.csv", - "mime_type": "text/csv" + "mime_type": "text/csv", + "size_bytes": 2048, + "md5": "89968669461d95416549937168269d6b" } ], "artifacts": [ @@ -156,7 +161,7 @@ The messages endpoint returns the chat's metadata plus a `chat_messages` array s } ``` -`files`, `generated_files`, and `artifacts` can each be `null` on a given message. `files` are binary uploads (PDFs, images, spreadsheets) the user attached to the message. `generated_files` are binary files the assistant created during the conversation through tool use (for example, PDFs, spreadsheets, or slide decks). `artifacts` are versioned documents (for example, code or markdown) the assistant generated or updated in its response; an artifact can be revised across multiple assistant turns in the same chat, and each revision appears as a new `version_id` under the same artifact `id`. Pass each entry's `id` (or `version_id` for artifacts) to the matching content endpoint in [Retrieve files and artifacts](https://platform.claude.com/docs/en/manage-claude/compliance-content-data#retrieve-files-and-artifacts) to download it. +`files`, `generated_files`, and `artifacts` can each be `null` on a given message. `files` are the files and text attachments (for example, PDFs, images, spreadsheets, documents, and pasted text) the user attached to the message, as claude.ai stored them. `generated_files` are binary files the assistant created during the conversation through tool use (for example, PDFs, spreadsheets, or slide decks). `artifacts` are versioned documents (for example, code or markdown) the assistant generated or updated in its response; an artifact can be revised across multiple assistant turns in the same chat, and each revision appears as a new `version_id` under the same artifact `id`. Pass each entry's `id` (or `version_id` for artifacts) to the matching content endpoint in [Retrieve files and artifacts](https://platform.claude.com/docs/en/manage-claude/compliance-content-data#retrieve-files-and-artifacts) to download it. ## Retrieve files and artifacts @@ -166,7 +171,7 @@ Pick the endpoint that matches your ID type and the data you need. The same file | You have | You want | Use this endpoint | | ------------------------------ | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `claude_file_*` ID | The file's binary content | [Download file content](https://platform.claude.com/docs/en/api/compliance/apps/chats/files/download) | +| `claude_file_*` ID | The file's content | [Download file content](https://platform.claude.com/docs/en/api/compliance/apps/chats/files/download) | | `claude_file_*` ID | The file's metadata only | [Get file metadata](https://platform.claude.com/docs/en/api/compliance/apps/chats/files/retrieve) | | `claude_gen_file_*` ID | A tool-generated file's binary content | [Download a Claude-generated file](https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/download) | | `claude_gen_file_*` ID | A tool-generated file's metadata only | [Get generated-file metadata](https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/retrieve) | @@ -175,11 +180,13 @@ Pick the endpoint that matches your ID type and the data you need. The same file | `claude_proj_doc_*` ID | A project document's plain-text content | [Get project document content](https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/retrieve) | | `claude_proj_doc_*` ID | A project document's metadata only | [Get project document metadata](https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/metadata) | -The file content endpoint streams the original upload as a chunked binary response with these headers: +The file content endpoint streams the content that claude.ai stored for the file as a chunked binary response. That content is not always identical to the file the user uploaded. Images can be served as a processed copy rather than the uploaded bytes. Some documents attached to chats (for example, Word files, PowerPoint files, and some PDFs) are stored as the text claude.ai extracted from them. For these documents, the endpoint returns the extracted text under the original file name, and the original document is not available through the Compliance API. The `size_bytes` and `md5` fields describe the stored content rather than the uploaded file. The file name and `mime_type` can still name the uploaded document's format. Identify a file's format from the returned bytes, not from its name or declared type. + +The response carries these headers: * `Content-Disposition: attachment; filename*=utf-8''` carries the original upload file name in RFC 5987 extended form. The extended form is used for every file name, not only non-ASCII ones. -* `Content-Type` carries the upload's MIME type. -* `Content-MD5` carries the file's MD5 digest, base64-encoded as specified in RFC 1864. +* `Content-Type` carries the MIME type recorded for the stored content, which for a document stored as extracted text can still name the original document format. +* `Content-MD5` carries the MD5 digest of the served bytes, base64-encoded as specified in RFC 1864. * `Transfer-Encoding: chunked` is always set. ```bash cURL @@ -209,7 +216,7 @@ Project results are sorted by creation date ascending. Attachment results are so A project attachment is one of two distinct shapes, identified by the `type` discriminator on each entry: -Entries with `type` of `project_file` are binary uploads (PDFs, images, spreadsheets) whose IDs start with `claude_file_`; download them with [Download file content](https://platform.claude.com/docs/en/api/compliance/apps/chats/files/download). Entries with `type` of `project_doc` are plain-text documents (always `text/plain`) whose IDs start with `claude_proj_doc_`; fetch them with [Get project document content](https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/retrieve). +Entries with `type` of `project_file` are file uploads (PDFs, images, spreadsheets) whose IDs start with `claude_file_`; download them with [Download file content](https://platform.claude.com/docs/en/api/compliance/apps/chats/files/download). Entries with `type` of `project_doc` are plain-text documents (always `text/plain`) whose IDs start with `claude_proj_doc_`, including documents such as Word files that claude.ai converts to text when they are added to a project; fetch them with [Get project document content](https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/retrieve). A consumer that walks the attachment list must branch on `type` and call the matching content endpoint for each entry. The following request lists one page of attachments; paginate by passing `next_page` back as the `page` parameter until `has_more` is `false`. @@ -229,6 +236,8 @@ curl --fail-with-body -sS -G \ "created_at": "2026-04-10T08:09:10Z", "filename": "dashboard_mockup_v1.pdf", "mime_type": "application/pdf", + "size_bytes": 482133, + "md5": "56367e4d2705cc9c025ad07424e944f0", "type": "project_file" }, { @@ -250,7 +259,7 @@ curl --fail-with-body -sS -G \ Every successful delete is permanent and immediate. There is no recovery window. -The Compliance API exposes hard-delete endpoints for chats, files, project documents, and entire projects. A hard-deleted chat cannot be restored, and it stops appearing in list responses afterward (whereas a chat soft-deleted from claude.ai still appears with `deleted_at` populated). +The Compliance API exposes hard-delete endpoints for chats, files, project documents, and entire projects. A hard-deleted chat cannot be restored, and it stops appearing in list responses afterward. * [Delete chat](https://platform.claude.com/docs/en/api/compliance/apps/chats/delete): also removes the chat's messages and any files attached to those messages. * [Delete file](https://platform.claude.com/docs/en/api/compliance/apps/chats/files/delete): handles both chat files and project files. diff --git a/content/en/manage-claude/compliance-errors.md b/content/en/manage-claude/compliance-errors.md index 06cb9ac25..11f47392d 100644 --- a/content/en/manage-claude/compliance-errors.md +++ b/content/en/manage-claude/compliance-errors.md @@ -36,7 +36,7 @@ The following table tells you at a glance whether to retry. Each section that fo | [409 Conflict](https://platform.claude.com/docs/en/manage-claude/compliance-errors#409-conflict) | No | The request conflicts with the resource's current state; resolve the conflict (such as detaching child resources), then retry. | | [429 Too Many Requests](https://platform.claude.com/docs/en/manage-claude/compliance-errors#429-too-many-requests) | Yes, after `retry-after` | Wait the seconds in `retry-after`, then retry; do not advance your cursor. | | [500 Internal Server Error](https://platform.claude.com/docs/en/manage-claude/compliance-errors#500-internal-server-error) | Depends on `x-should-retry` | Check the `x-should-retry` response header before retrying. | -| [502, 503, 504, 529](https://platform.claude.com/docs/en/manage-claude/compliance-errors#500-internal-server-error) | Yes, with backoff | Transient; retry with exponential backoff. Exception: one local session 503 is data-dependent and can persist; see [Local sessions temporarily unavailable](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-sessions-temporarily-unavailable). | +| [502, 503, 504, 529](https://platform.claude.com/docs/en/manage-claude/compliance-errors#500-internal-server-error) | Yes, with backoff | Transient; retry with exponential backoff. Exception: some local session 503s are not transient. See [Local sessions temporarily unavailable](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-sessions-temporarily-unavailable). | ## 400 Bad Request @@ -90,7 +90,7 @@ Invalid `after_id`. No activity found for `after_id` "activity_invalid123" The directory, project, and session endpoints (organizations, users, roles, role permissions, groups, group members, projects, project attachments, local and remote sessions, and session messages) paginate with an opaque `page` token rather than `after_id` and `before_id`. The same advice applies: pass the `next_page` value from the previous response unchanged, and stop when `has_more` is `false` (or, on the session endpoints, which return no `has_more`, when `next_page` is `null`). A malformed `page` token returns the same 400 `invalid_request_error` as a malformed `after_id` or `before_id`. -The two paginated local session endpoints (the list and the messages endpoint) return the following 400 `invalid_request_error` for any `page` value they cannot decode, for example a token that was truncated or altered after you stored it, or one issued by a different endpoint or under a different parent organization. On the local session messages endpoint (`GET /v1/compliance/apps/sessions/local/{session_id}/messages`), each `page` cursor is also bound to the session and `order` it was issued for, so a cursor issued for a different session or sort order returns the same body: +The two paginated local session endpoints (the list and the messages endpoint) return the following 400 `invalid_request_error` for any `page` value they cannot decode, for example, a token that was truncated or altered after you stored it, or one issued by a different endpoint or under a different parent organization. On the local session messages endpoint (`GET /v1/compliance/apps/sessions/local/{session_id}/messages`), each `page` cursor is also bound to the session and `order` it was issued for, so a cursor issued for a different session or sort order returns the same body: ```text wrap The page parameter is not a valid cursor for this request. @@ -205,7 +205,7 @@ The endpoint resolved but the resource ID does not exist or has already been del Chat claude_chat_01H5CWunD7RpVJ5bHa8RCkja not found. ``` -**Cause:** The chat ID in the path does not match a chat readable through the Compliance API. The chat might have been hard-deleted through a previous Compliance API call or removed by your organization's retention policy, or it might belong to an organization the calling key cannot read. Chats that a user soft-deleted in claude.ai do not return 404; they remain readable with `deleted_at` populated. +**Cause:** The chat ID in the path does not match a chat readable through the Compliance API. The chat might have been hard-deleted through a previous Compliance API call or removed by your organization's retention policy, or it might belong to an organization the calling key cannot read. Chats that a user deleted in claude.ai do not return 404; they remain readable, with `deleted_at` populated, but without their message content. **Fix:** Confirm the chat ID against a recent `claude_chat_created` or `claude_chat_viewed` activity. If the activity is recent and the read still fails, the chat has been hard-deleted (through this API or by retention-policy expiry) or belongs to an organization outside your key's scope. @@ -357,7 +357,7 @@ If you poll the [Activity Feed](https://platform.claude.com/docs/en/manage-claud A 500 from the Compliance API carries an `x-should-retry: false` response header when the failure is deterministic. Anthropic SDKs honor this header automatically. If you use a generic HTTP retry library that retries on every 5xx, suppress retries when `x-should-retry` is `false`; retrying this error fails identically on every attempt. -A 500 without the `x-should-retry: false` header is transient: retry with exponential backoff (start at 1 second, double up to 60 seconds). The same applies to 502, 503, 504, and 529 responses. One local session 503, described next, is data-dependent rather than transient. See [Errors](https://platform.claude.com/docs/en/api/errors) for the platform-wide retry semantics. +A 500 without the `x-should-retry: false` header is transient: retry with exponential backoff (start at 1 second, double up to 60 seconds). The same applies to 502, 503, 504, and 529 responses. The exception is a small set of local session 503s, described next, that depend on an organization's settings or encryption key rather than on load. See [Errors](https://platform.claude.com/docs/en/api/errors) for the platform-wide retry semantics. ### Local sessions temporarily unavailable @@ -375,9 +375,19 @@ Captured content is temporarily unavailable. Try again shortly. The local-sessions index cannot currently evaluate retention overrides for this page. Try again later. ``` -**Cause:** The [local session endpoints](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-local-sessions) return 503 with one of these bodies. The first two mean that session listings, or a session's captured content, are briefly unavailable; that is a transient condition related to load or to the back end. The third body (which reads `for this session` instead of `for this page` on the retrieve and messages endpoints) means that a retention or data-handling setting that applies to one or more sessions in the requested range could not yet be evaluated. That depends on the data and settings of the organization that ran the session rather than on load, and it can persist for an extended period. All three bodies share the `overloaded_error` type, so this is one of the few cases on this page where the message text, rather than `error.type`, distinguishes conditions that need different handling. +**Cause:** The [local session endpoints](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-local-sessions) return 503 with one of these bodies. All three share the `overloaded_error` type, so this is one of the few errors on this page where you need the message text, not `error.type`, to tell the conditions apart: -**Fix:** For the two `Try again shortly.` bodies, retry with exponential backoff and do not advance your `page` cursor, because the failed request returned no data. For the `Try again later.` body, do not hold a walk open waiting for it to clear. On the list endpoint, either retry later by restarting without the `page` parameter (a list page token older than 24 hours is still accepted but is re-evaluated against the current retention boundary, so a parked walk can skip sessions), or narrow the `created_at.gte` and `created_at.lt` window until the request succeeds and export the skipped range separately on a later run. On the retrieve and messages endpoints, skip that session ID, continue with the rest of your export, and retry the session on a later run; messages page cursors expire 24 hours after the walk's first page, so restart that session's walk without `page` when you return to it. If the condition recurs across runs, contact your Anthropic representative and include the `request-id` response header. +* The `index is temporarily unavailable` body means session listings are briefly unavailable because of load or a back-end condition. This is transient. +* The `Captured content` body means a session's transcript content cannot be returned right now. This is usually transient too. In organizations that use [customer-managed encryption keys](https://platform.claude.com/docs/en/manage-claude/cmek), the messages endpoint also returns this body for every page that contains content your key cannot decrypt, for example because you disabled, revoked, or destroyed the key, or because the key cannot be reached. In that case the error persists for as long as the key cannot be used. The message text is the same either way, so the only signal that the key is the cause is that the error keeps recurring for that organization. An unusable key is never reported as `not_captured`. +* The `retention overrides` body means a retention or data-handling setting that applies to one or more sessions in the requested range could not be evaluated yet. On the retrieve and messages endpoints it reads `for this session` instead of `for this page`. It depends on the data and settings of the organization that ran the session rather than on load, and it can persist for an extended period. + +**Fix:** Handle each body as follows: + +* For the two `Try again shortly.` bodies, retry with exponential backoff and do not advance your `page` cursor, because the failed request returned no data. +* If the `Captured content` body keeps recurring on the messages endpoint for an organization that uses a customer-managed key, treat it as persistent: stop walking that organization's transcripts and check the key's status in your key management service. Transcripts in other linked organizations, and session metadata everywhere, are unaffected. If you retry on a later run, restart each session's walk without `page`, because messages page cursors expire 24 hours after the walk's first page. +* For the `Try again later.` body, do not hold a walk open waiting for it to clear. On the list endpoint, either retry later by restarting without the `page` parameter (a list page token older than 24 hours is still accepted but is re-evaluated against the current retention boundary, so a parked walk can skip sessions), or narrow the `created_at.gte` and `created_at.lt` window until the request succeeds and export the skipped range separately on a later run. On the retrieve and messages endpoints, skip that session ID, continue with the rest of your export, and retry the session on a later run. Messages page cursors expire 24 hours after the walk's first page, so restart that session's walk without `page` when you return to it. + +If any of these conditions recurs across runs, contact your Anthropic representative and include the `request-id` response header. For the customer-managed key case, do this only if the error continues while your key is usable. For service-wide incidents, check [status.anthropic.com](https://status.anthropic.com). diff --git a/content/en/manage-claude/compliance-faq.md b/content/en/manage-claude/compliance-faq.md index ccda794eb..3e51b36d1 100644 --- a/content/en/manage-claude/compliance-faq.md +++ b/content/en/manage-claude/compliance-faq.md @@ -60,7 +60,7 @@ description: Answers to common questions about Compliance API access, scopes, re - The Activity Feed retains 6 years of organization activity, and new events are queryable within 1 minute of occurring. The feed reaches back at most to the point the Compliance API was first enabled for your organization: recording is not retroactive, and activity from before enablement is not backfilled. Activity Feed retention is independent of your organization's content retention policy: chat, file, and project content follows the retention rules configured for your organization (indefinite by default). + The Activity Feed retains 6 years of organization activity, and new events are queryable within 1 minute of occurring. The feed reaches back at most to the point the Compliance API was first enabled for your organization: recording is not retroactive, and activity from before enablement is not backfilled. Activity Feed retention is independent of your organization's content retention policy: chat, file, and project content follows the retention rules configured for your organization (indefinite by default), unless a user deletes it sooner. @@ -70,11 +70,11 @@ description: Answers to common questions about Compliance API access, scopes, re - Yes. Cowork sessions in Claude Desktop that run on users' machines, and Claude Code sessions in the terminal, in Claude Desktop, or in an IDE extension, are captured while users are signed in with their Claude Enterprise account and are available through the [local session endpoints](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-local-sessions). Cowork sessions started on claude.ai web or mobile, which run in the cloud in Anthropic-managed environments, are available through the [remote session endpoints](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-remote-sessions). Each family has a list endpoint that returns session metadata and a messages endpoint that returns the session transcript (user prompts, assistant responses, and tool calls and results). The local family adds a third endpoint that retrieves one session's metadata. All of these endpoints use your existing Compliance Access Key with `read:compliance_user_data`; no new key or scope is needed. + Yes. Cowork sessions in Claude Desktop that run on users' machines, Claude Code sessions (in the terminal, in Claude Desktop, or in an IDE extension), sessions in the Claude Science desktop app, and Claude for Microsoft 365 sessions in Excel, PowerPoint, Word, and Outlook are captured while users are signed in with their Claude Enterprise account and are available through the [local session endpoints](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-local-sessions). Cowork sessions started on claude.ai web or mobile, which run in the cloud in Anthropic-managed environments, are available through the [remote session endpoints](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-remote-sessions). Each family has a list endpoint that returns session metadata and a messages endpoint that returns the session transcript (user prompts, assistant responses, and tool calls and results). The local family adds a third endpoint that retrieves one session's metadata. All of these endpoints use your existing Compliance Access Key with `read:compliance_user_data`; no new key or scope is needed. Local sessions are captured as their requests reach the Claude API, so nothing is installed on the device, and on-device activity that never reaches the API is not captured. Claude Code sessions authenticated with a Claude Console API key, Claude Code sessions run through a third-party cloud platform (Amazon Bedrock, Google Cloud, or Microsoft Foundry), and Claude Code on the web are not captured. Claude Code on the web also runs in the cloud in Anthropic-managed environments, but it is not a remote session; the remote session endpoints return Cowork sessions only. Organizations with [HIPAA readiness](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#hipaa-readiness) enabled get no local session data, and sessions for which [zero data retention (ZDR)](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#zero-data-retention-zdr-scope) is in effect are excluded. - The local and remote session endpoints are in beta. + The local and remote session endpoints are stable for Cowork and Claude Code sessions; coverage of Claude Science and Claude for Microsoft 365 sessions is in beta. @@ -103,13 +103,13 @@ description: Answers to common questions about Compliance API access, scopes, re - No. Deletes performed through the Compliance API are immediate, permanent, and not recoverable. Chats that a user deleted through claude.ai are soft-deleted: they remain visible through the Compliance API with `deleted_at` populated until your organization's retention window expires or you hard-delete them through this API. Pull any content you need to retain (for legal hold or archival) before issuing a `DELETE` request. + No. Deletes performed through the Compliance API are immediate, permanent, and not recoverable. The content of a chat that a user deletes in claude.ai is not recoverable either: the Compliance API still returns the chat and its messages, with `deleted_at` populated, but not their content. Pull any content you need to retain (for legal hold or archival) while it is still available. See [Plan content retention](https://platform.claude.com/docs/en/manage-claude/compliance-integration-patterns#plan-content-retention) for when to export content to your own archive. - The Compliance API has known coverage boundaries: the Activity Feed records resource events but not prompt or response text, Claude Console and Claude API workloads authenticated with an API key expose no message content at all, and content removed by your retention policy or by a hard delete is not recoverable. For the full coverage boundaries and delivery contract, see [Delivery guarantees and completeness](https://platform.claude.com/docs/en/manage-claude/compliance-integration-patterns#delivery-guarantees-and-completeness). + The Compliance API has known coverage boundaries: the Activity Feed records resource events but not prompt or response text, Claude Console and Claude API workloads authenticated with an API key expose no message content at all, and content removed by your retention policy, deleted by a user in claude.ai, or hard-deleted through the Compliance API is not recoverable. For the full coverage boundaries and delivery contract, see [Delivery guarantees and completeness](https://platform.claude.com/docs/en/manage-claude/compliance-integration-patterns#delivery-guarantees-and-completeness). - Cowork and Claude Code session transcripts have boundaries of their own. Local sessions are captured only as their requests reach the Claude API, so on-device activity that never reaches the API is not captured. Claude Code sessions authenticated with a Claude Console API key, Claude Code sessions run through a third-party cloud platform (Amazon Bedrock, Google Cloud, or Microsoft Foundry), and Claude Code on the web are not captured either; organizations with HIPAA readiness enabled get no local session data; and sessions for which zero data retention is in effect are excluded. No session transcript, local or remote, includes thinking blocks or tool definitions. Organizations that use [customer-managed encryption keys](https://platform.claude.com/docs/en/manage-claude/cmek) see local session metadata but no transcript content. + Cowork and Claude Code session transcripts have boundaries of their own. Local sessions are captured only as their requests reach the Claude API, so on-device activity that never reaches the API is not captured. Claude Code sessions authenticated with a Claude Console API key, Claude Code sessions run through a third-party cloud platform (Amazon Bedrock, Google Cloud, or Microsoft Foundry), and Claude Code on the web are not captured either; organizations with HIPAA readiness enabled get no local session data; and sessions for which zero data retention is in effect are excluded. No session transcript, local or remote, includes thinking blocks or tool definitions. Organizations that use [customer-managed encryption keys](https://platform.claude.com/docs/en/manage-claude/cmek) receive local session transcripts as usual. While the key cannot be used, the messages endpoint returns [503 Service Unavailable](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-sessions-temporarily-unavailable) instead of transcript content, and session metadata is still listed. diff --git a/content/en/manage-claude/compliance-integration-patterns.md b/content/en/manage-claude/compliance-integration-patterns.md index e4d4039c7..508807cbd 100644 --- a/content/en/manage-claude/compliance-integration-patterns.md +++ b/content/en/manage-claude/compliance-integration-patterns.md @@ -113,7 +113,7 @@ Five retention horizons govern what you can retrieve later: | Data | Retained for | Controlled by | | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | Activity Feed records | 6 years | Anthropic | -| Chat, file, and project content | Your organization's claude.ai retention policy | Your organization | +| Chat, file, and project content | Your organization's claude.ai retention policy, unless a user deletes it sooner | Your organization | | Local session transcripts (sessions on users' machines) | 6 years by default, or your organization's custom conversation retention period when a finite one is set | Anthropic by default; your organization when it sets a custom period | | Remote session transcripts (sessions in the cloud) | 6 years | Anthropic | | Content hard-deleted through the Compliance API | Not retained; deletion is immediate and permanent | The caller of the `DELETE` endpoint | @@ -124,7 +124,8 @@ Decide between export-and-archive and on-demand API retrieval as follows: * If your legal-hold or audit horizon exceeds 6 years for activity metadata or session transcripts, export Activity Feed pages and session transcripts to your own archive as you ingest them. * If your content-retention policy is shorter than your eDiscovery horizon, export chat and file content before the retention window expires; the Compliance API cannot return content that retention has already removed. The same applies to local session transcripts, which follow your organization's custom conversation retention period when a finite one is set, even when that period is shorter than 6 years. The local session endpoints stop returning messages older than your organization's current period as soon as the setting changes, and lengthening the period later does not restore transcripts that have already expired, so export any transcript you must keep beyond it. -* If a workflow might issue a Compliance API hard-delete (for example, DLP enforcement), retrieve and archive the target content first. There is no recovery window after a hard-delete; soft-deletes from claude.ai remain retrievable with `deleted_at` populated, but Compliance API deletes do not. +* If you must retain chat content after users delete it in claude.ai (for example, under a legal hold), export chat, file, and artifact content to your own archive as you ingest it; the Compliance API cannot return content that a user has already deleted. +* If a workflow might issue a Compliance API hard-delete (for example, DLP enforcement), retrieve and archive the target content first. There is no recovery window after a hard-delete. In every other case, rely on direct API retrieval and avoid maintaining a parallel copy. @@ -147,10 +148,12 @@ The content endpoints (chats, files, projects, project attachments, and local an * Claude Code usage authenticated with a Claude Console API key, run through a third-party cloud platform (Amazon Bedrock, Google Cloud, or Microsoft Foundry), or run in Claude Code on the web. * Local sessions from organizations with [HIPAA readiness](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#hipaa-readiness) enabled, and local sessions for which [zero data retention](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#zero-data-retention-zdr-scope) is in effect. * Thinking blocks, and images or other binary content, inside session transcripts (transcripts carry user prompts, assistant responses, and tool activity only; local session transcripts show a placeholder `text` block where binary content was omitted). +* The original file for a chat attachment that claude.ai stored as extracted text, such as some Word, PowerPoint, and PDF uploads (the file content endpoint returns the extracted text; see [Retrieve files and artifacts](https://platform.claude.com/docs/en/manage-claude/compliance-content-data#retrieve-files-and-artifacts)). * The system prompt of local sessions (a marker message stands in for it). * Tool definitions and MCP server configuration in session transcripts (local or remote), and citation metadata on `text` blocks in local session transcripts. -* Transcript content for local sessions in organizations that use [customer-managed encryption keys](https://platform.claude.com/docs/en/manage-claude/cmek) (session metadata is still listed). +* Local session transcript content in an organization whose [customer-managed encryption key](https://platform.claude.com/docs/en/manage-claude/cmek) cannot currently be used. Those requests return [503 Service Unavailable](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-sessions-temporarily-unavailable), and session metadata is still listed. * Content removed by your organization's retention policy. +* Content of chats that users delete in claude.ai (the chats are still listed, with `deleted_at` populated). * Content hard-deleted through the Compliance API. See the [Compliance API FAQ](https://platform.claude.com/docs/en/manage-claude/compliance-faq#data-coverage-and-retention) for more on what the Compliance API does and does not capture. diff --git a/content/en/manage-claude/compliance-sessions.md b/content/en/manage-claude/compliance-sessions.md index 14de5f553..0f1c5d8e9 100644 --- a/content/en/manage-claude/compliance-sessions.md +++ b/content/en/manage-claude/compliance-sessions.md @@ -5,7 +5,7 @@ description: List the sessions your users run in Claude apps and agents, such as --- - The endpoints on this page are available only to Claude Enterprise organizations and are in beta. They work with the same Compliance Access Key and `read:compliance_user_data` scope as the [chat, file, and project endpoints](https://platform.claude.com/docs/en/manage-claude/compliance-content-data); no new key, scope, setting, or client update is required. See [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api-access). + The endpoints on this page are available only to Claude Enterprise organizations. The local and remote session endpoints are stable for Cowork and Claude Code sessions; coverage of Claude Science and Claude for Microsoft 365 sessions is in beta. The endpoints work with the same Compliance Access Key and `read:compliance_user_data` scope as the [chat, file, and project endpoints](https://platform.claude.com/docs/en/manage-claude/compliance-content-data); no new key, scope, setting, or client update is required. See [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api-access). @@ -14,17 +14,19 @@ description: List the sessions your users run in Claude apps and agents, such as **Prerequisite:** None for listing sessions organization-wide. To filter the remote session list (sessions in the cloud) to specific users, you need user IDs from [List organization users](https://platform.claude.com/docs/en/manage-claude/compliance-org-data#list-organization-users); the local session list has no user filter. -The endpoints on this page expose transcripts of the sessions your users run in Claude apps and agents (today, Cowork and Claude Code) from your Claude Enterprise organizations to compliance reviewers. Each session is a single conversation with Claude; its transcript is the sequence of user prompts, assistant responses, and tool calls and results in that conversation. The endpoints support eDiscovery (electronic discovery) exports and data loss prevention (DLP) enforcement. +The endpoints on this page expose transcripts of the sessions your users run in Claude apps and agents (today: Cowork, Claude Code, Claude Science, and Claude for Microsoft 365) from your Claude Enterprise organizations to compliance reviewers. Each session is a single conversation with Claude; its transcript is the sequence of user prompts, assistant responses, and tool calls and results in that conversation. The endpoints support eDiscovery (electronic discovery) exports and data loss prevention (DLP) enforcement. The Compliance API groups sessions into two endpoint families according to where they run: local session endpoints for sessions on users' machines, and remote session endpoints for sessions that run in the cloud in Anthropic-managed environments. Both families are read-only, and neither is available to Admin API keys (`sk-ant-admin01-...`): calls authenticated with an Admin API key return [403 Forbidden](https://platform.claude.com/docs/en/manage-claude/compliance-errors#403-forbidden). The following table maps each product, and where it runs, to the endpoint family that returns its sessions and the `product_surface` value that identifies them in responses. Products are added to this table as coverage expands. -| Product and where it runs | Endpoint family | `product_surface` | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----------------- | -| Cowork in Claude Desktop, running on the user's machine | Local session endpoints (`/v1/compliance/apps/sessions/local`) | `cowork` | -| Claude Code in the terminal, in Claude Desktop, or in an IDE extension, running on the user's machine | Local session endpoints | `claude_code` | -| Cowork sessions started on claude.ai web or mobile, running in the cloud in Anthropic-managed environments | Remote session endpoints (`/v1/compliance/apps/sessions/remote`) | `cowork_remote` | +| Product and where it runs | Endpoint family | `product_surface` | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| Cowork in Claude Desktop, running on the user's machine | Local session endpoints (`/v1/compliance/apps/sessions/local`) | `cowork` | +| Claude Code in the terminal, in Claude Desktop, or in an IDE extension, running on the user's machine | Local session endpoints | `claude_code` | +| Claude Science desktop app, running on the user's machine | Local session endpoints | `claude_science` | +| Claude for Microsoft 365 (the Claude add-ins for Excel, PowerPoint, Word, and Outlook), running in the Microsoft 365 desktop or web apps | Local session endpoints | `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, or `office_agents/outlook` (`office_agents` when the app is not identified) | +| Cowork sessions started on claude.ai web or mobile, running in the cloud in Anthropic-managed environments | Remote session endpoints (`/v1/compliance/apps/sessions/remote`) | `cowork_remote` | Capture of local sessions is tied to the Compliance API being enabled for your organization and applies while users are signed in with their Claude Enterprise account. The session endpoints do not return the following: @@ -41,7 +43,7 @@ Anthropic recommends the Compliance API for retrieving the content of Cowork and | Setup | Works with your existing Compliance Access Key | Works with your existing Compliance Access Key | Admin configures an OTLP endpoint and content-capture settings | | Infrastructure | Anthropic-hosted | Anthropic-hosted | You run the collector and storage | | ID prefix | `clls_` | `cse_` | N/A | -| `product_surface` values | `cowork`, `claude_code` | `cowork_remote` | N/A | +| `product_surface` values | `cowork`, `claude_code`, `claude_science`, and values beginning with `office_agents` | `cowork_remote` | N/A | | Retention | 6 years by default, or your organization's custom conversation retention period when a finite one is set; held by Anthropic | 6 years, held by Anthropic | Your infrastructure, your policies | | User prompts and assistant responses | Yes | Yes | Yes, subject to content-capture settings | | Tool inputs | Truncated to 10,000 bytes per input by default; up to about 1 MiB on request | Truncated to 10,000 bytes per input by default; up to about 1 MiB on request | Truncated summaries | @@ -52,13 +54,13 @@ Anthropic recommends the Compliance API for retrieving the content of Cowork and ## Sessions on users' machines (local sessions) -Local sessions run on users' machines while they are signed in with their Claude Enterprise account: today, Cowork in Claude Desktop, and Claude Code in the terminal, in Claude Desktop, or in an IDE extension. +Local sessions run on users' machines while they are signed in with their Claude Enterprise account: today, Cowork in Claude Desktop, Claude Code (in the terminal, in Claude Desktop, or in an IDE extension), the Claude Science desktop app, and Claude for Microsoft 365 in Excel, PowerPoint, Word, and Outlook. The Compliance API exposes local sessions through three endpoints: `GET /v1/compliance/apps/sessions/local` lists session metadata, `GET /v1/compliance/apps/sessions/local/{session_id}` retrieves one session's metadata, and `GET /v1/compliance/apps/sessions/local/{session_id}/messages` returns one session's transcript. All three require the `read:compliance_user_data` scope and count only against the shared Compliance API rate limit; they are not subject to the second request budget that applies to the remote session endpoints. See [429 Too Many Requests](https://platform.claude.com/docs/en/manage-claude/compliance-errors#429-too-many-requests). If local sessions are not available to your parent organization, all three endpoints return 404 with the message `Local sessions are not available.` (see [Local session not found](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-session-not-found)); while session listings or captured content are temporarily unavailable, they return 503 (see [Local sessions temporarily unavailable](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-sessions-temporarily-unavailable)). For local sessions, Anthropic records each conversation server-side as its requests reach the Claude API; nothing is installed on the device, and nothing is collected beyond the requests the client already sends to the Claude API. Local session transcripts show what Claude was asked to do and what it returned, not what happened on the device. File and network activity is visible only through the tool calls and tool results in the transcript, so activity that never reaches the API (for example, local files the session never sent) is not captured. -In organizations that use [customer-managed encryption keys](https://platform.claude.com/docs/en/manage-claude/cmek), local sessions are listed and retrievable as usual, but transcript content is not currently returned; each message comes back with its content marked unavailable (see [Retrieve a local session transcript](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-a-local-session-transcript) for how such messages are marked). +In organizations that use [customer-managed encryption keys](https://platform.claude.com/docs/en/manage-claude/cmek), local session transcripts are encrypted under your key and returned as usual. While your key cannot be used (for example, because you disabled or revoked it, or because it cannot be reached), the messages endpoint returns [503 Service Unavailable](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-sessions-temporarily-unavailable) for the affected pages instead of transcript content. Those messages are never reported as `not_captured` (see [Retrieve a local session transcript](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-a-local-session-transcript)). Listing sessions and retrieving session metadata are not affected. The list endpoint returns session metadata, with no transcript content, for every linked organization your key can read. Unlike the remote session list, it has no organization or user filters: bound the results in time with the `created_at.gte` and `created_at.lt` parameters. Both take RFC 3339 timestamps with a required UTC offset, and when both are supplied, `created_at.lt` must be strictly after `created_at.gte` or the request returns [400 Bad Request](https://platform.claude.com/docs/en/manage-claude/compliance-errors#400-bad-request). A third time filter, `updated_at.gte`, bounds by last activity instead of first: it returns sessions whose last inference call is at or after the given time and combines with the `created_at` filters without changing the ordering or pagination. Use it to poll for sessions active since a previous pass, as described later in this section. New sessions and messages appear in results after a short processing delay, typically within minutes; a session that is missing immediately after it starts is not necessarily uncaptured. The following request lists sessions created since a given date. @@ -106,9 +108,11 @@ curl --fail-with-body -sS -G \ Results are sorted in reverse chronological order (newest first) by `created_at`, with ties broken in a fixed server-side order, and capped at `limit` results per response (default 100, max 500). The endpoint paginates forward only with `page` and `next_page` tokens (see [Paginate results](https://platform.claude.com/docs/en/manage-claude/compliance-activity-feed#paginate-results)): pass the response's `next_page` value back as the `page` query parameter on the next request, and stop when `next_page` is `null`. The response has no `has_more` field. Complete a list walk within 24 hours of starting it; an older list cursor is still accepted but is re-evaluated against the current retention boundary, so sessions whose oldest retained activity is about to age out of the retention period can be skipped. -In each session object, `user.id` is always set and survives account deletion; `user.email_address` is `null` when the user's account has been deleted or the user is no longer a member of an organization your key can read. `workspace_id` is `null` when the session was not associated with a workspace. A local session corresponds to one client session ID: starting a new conversation in the client, or clearing its context, begins a new session record. Treat `id` values as opaque strings; the format may change without notice. +In each session object, `user.id` is always set and survives account deletion; `user.email_address` is `null` when the user's account has been deleted or the user is no longer a member of an organization your key can read. `workspace_id` is `null` when the session was not associated with a workspace. A local session corresponds to one client session ID: starting a new conversation in the client, or clearing its context, begins a new session record. For Claude Science, the list can also include separate sessions for the app's own background work (for example, naming the conversation; on newer app versions also its reviewer and delegation tracks), and on older app versions some of that background work appears as extra messages inside the conversation's own transcript. A Claude Science conversation that continues across some app updates appears as two sessions. These behaviors are expected. Treat `id` values as opaque strings; the format may change without notice. -Local sessions carry an `updated_at` but no `status`: a local session has no server-side lifecycle status, and its visibility is governed by retention instead. A local session is captured as the series of Claude API calls (inference calls) that the client makes during the session, and retention applies to each captured call individually. `created_at` is the timestamp of the session's earliest retained call and `updated_at` the timestamp of its last, both UTC. As older calls age past the retention period, `created_at` advances accordingly, and once every call in a session has aged out, the session is no longer returned; `updated_at` tracks the most recent call and is unaffected until then. Because `created_at` can shift between runs, deduplicate on `id` when you re-walk the list over time. To keep transcripts current as sessions gain messages, poll with the `updated_at.gte` filter, overlapping consecutive windows. On the list endpoint `updated_at` is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity, and a new call only becomes queryable after the short processing delay noted earlier. Because of that lag, set each run's `updated_at.gte` a few minutes before your previous run's start time, not to the previous run's time exactly. A bound set to the exact previous time silently and permanently drops a session whose final call was still indexing at that moment, because once the bound advances past that call no later run returns it. Deduplicate the returned sessions on `id`, re-fetch their transcripts, and deduplicate messages on `id`. Retrieving a session, or its messages, always reflects the exact latest retained call, so a periodic reconciliation pass over an older window is the belt-and-braces alternative to widening the overlap. +For Claude for Microsoft 365, deleting a conversation in the add-in happens only on the client, so it is not reflected in the API: local sessions have no `deleted_at` field, and the session stays listed until retention removes it. + +Local sessions carry an `updated_at` but no `status`: a local session has no server-side lifecycle status, and its visibility is governed by retention instead. A local session is captured as the series of Claude API calls (inference calls) that the client makes during the session, and retention applies to each captured call individually. `created_at` is the timestamp of the session's earliest retained call and `updated_at` the timestamp of its last, both UTC. As older calls age past the retention period, `created_at` advances accordingly, and once every call in a session has aged out, the session is no longer returned; `updated_at` tracks the most recent call and is unaffected until then. Because `created_at` can shift between runs, deduplicate on `id` when you re-walk the list over time. To keep transcripts current as sessions gain messages, poll with the `updated_at.gte` filter, overlapping consecutive windows. On the list endpoint `updated_at` is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity, and a new call only becomes queryable after the short processing delay noted earlier. Because of that lag, set each run's `updated_at.gte` a few minutes before your previous run's start time, not to the previous run's time exactly. A bound set to the exact previous time silently and permanently drops a session whose final call was still indexing at that moment, because once the bound advances past that call no later run returns it. Deduplicate the returned sessions on `id`, re-fetch their transcripts, and deduplicate messages on `id`. Retrieving a session, or its messages, always reflects the exact latest retained call, so a periodic reconciliation pass over an older window is a more thorough alternative to widening the overlap. The list is built from session activity metadata, so it can include sessions whose transcript content was not captured, for example sessions that ran before capture began for your organization (as far back as your retention period allows); the transcript of such a session returns each message with its content marked unavailable (see [Retrieve a local session transcript](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-a-local-session-transcript)). @@ -116,7 +120,7 @@ Captured local session content is stored for 6 years from capture by default. If To fetch one session's metadata directly, pass its ID to `GET /v1/compliance/apps/sessions/local/{session_id}`. The response is the same session object the list endpoint returns, with no envelope and no transcript content. A malformed session ID returns [400 Bad Request](https://platform.claude.com/docs/en/manage-claude/compliance-errors#400-bad-request). A single [404 Not Found](https://platform.claude.com/docs/en/manage-claude/compliance-errors#404-not-found) covers four cases that the response does not distinguish: the session is not in an organization your key can read (including sessions under another parent organization), it does not exist, zero data retention is in effect for it, or every call in it has aged past retention. -`product_surface` (string or `null`) identifies the product that created the session: `cowork` for Cowork sessions running on the user's machine in Claude Desktop, and `claude_code` for Claude Code sessions. New values appear as coverage expands. +`product_surface` (string or `null`) identifies the product that created the session: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands. **Build forward-compatible handlers.** Pass through unrecognized `product_surface` values, and ignore fields your handler does not expect, so your integration keeps working as new product surfaces ship. @@ -129,8 +133,8 @@ The messages endpoint returns the session's transcript, reconstructed from the c * Thinking blocks are never included. * The request's system prompt is never returned. A marker message reading `[system prompt content not shown]` stands in for it (normally once per session; a session with no captured content carries no marker). * Tool definitions and MCP server configuration are not part of the transcript. -* Images, PDFs, and other binary or structured blocks are not returned. Each appears as a `text` block reading `[ content not shown]` (for example, `[image content not shown]`) with `truncated` set to `true`. Non-text items inside a tool result are replaced by one `[N non-text item(s) not shown]` entry, and the tool result block's `truncated` is `true`. -* Citation metadata on `text` blocks is omitted, and the affected block carries `truncated` set to `true`. +* Images, PDFs, and other binary or structured blocks are not returned. Each appears as a `text` block reading `[ content not shown]` (for example, `[image content not shown]`) with `truncated` set to `true`. Non-text items inside a tool result, such as [web search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) results or the output of the [code execution tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool), are replaced by one `[N non-text item(s) not shown]` entry, and the tool result block's `truncated` is `true`. The matching tool call, with the search query or the code in its `input`, is still returned. +* Citation metadata on `text` blocks, such as the source citations on an answer that draws on web search results, is omitted. The text itself is returned, and the block carries `truncated` set to `true`. Project instruction files such as `CLAUDE.md` appear as ordinary user-role content. Skill content appears when the client sends it as message content and is not distinguished from other user text. For a coverage summary, see the [Compliance API FAQ](https://platform.claude.com/docs/en/manage-claude/compliance-faq#data-coverage-and-retention); for a table comparing local sessions with remote sessions and OpenTelemetry logging, see this page's introduction. @@ -259,11 +263,11 @@ The response embeds a `session` envelope alongside the paginated `data` array. T Messages are returned oldest first by default; pass `order=desc` to reverse. Pagination uses the same `page`/`next_page` scheme as the list endpoint, with a `limit` default of 100 and a max of 1,000. A page can end early when the response reaches its size limit, so a page with fewer than `limit` messages does not mean you have reached the end; keep paginating until `next_page` is `null`. Page cursors are bound to the session and sort order they were issued under, and a walk's cursors expire 24 hours after its first page: an expired cursor returns [400 Bad Request](https://platform.claude.com/docs/en/manage-claude/compliance-errors#400-bad-request) telling you to restart without the `page` parameter, and the restarted walk reflects the current retention boundary. A cursor issued for a different session or `order` also returns 400, as an invalid cursor. -Each message carries a `role` (`user` or `assistant`) and a `content` array of `text`, `tool_use`, and `tool_result` blocks. It also carries a `model`: on an assistant turn captured from the Claude API this is the model that served the turn, and it is `null` on user messages and on any assistant message whose `provenance` is set, since client-asserted history and synthetic markers were not produced by a model and the serving model is unknown for unavailable content. A `text` block carries `text` and `truncated`. A `tool_use` block carries `id`, `name`, `input`, and `truncated`, where `input` is a JSON-encoded string rather than an object. A `tool_result` block carries `tool_use_id`, `name`, `is_error`, a `content` array of `text` entries, and `truncated`. MCP tool calls and results, and most server tool calls and results, are normalized into these same `tool_use` and `tool_result` shapes; any other block type appears as a `[ content not shown]` placeholder. A message `id` is stable while the turn is retained. Every message reconstructed from the same inference call carries that call's timestamp, so consecutive messages often share a `created_at` value; preserve the returned order rather than re-sorting by timestamp. +Each message carries a `role` (`user` or `assistant`) and a `content` array of `text`, `tool_use`, and `tool_result` blocks. It also carries a `model`: on an assistant turn captured from the Claude API this is the model that served the turn, and it is `null` on user messages and on any assistant message whose `provenance` is set, because client-asserted history and synthetic markers were not produced by a model and the serving model is unknown for unavailable content. A `text` block carries `text` and `truncated`. A `tool_use` block carries `id`, `name`, `input`, and `truncated`, where `input` is a JSON-encoded string rather than an object. A `tool_result` block carries `tool_use_id`, `name`, `is_error`, a `content` array of `text` entries, and `truncated`. MCP tool calls and results, and most server tool calls and results, are normalized into these same `tool_use` and `tool_result` shapes; any other block type appears as a `[ content not shown]` placeholder. A message `id` is stable while the turn is retained. Every message reconstructed from the same inference call carries that call's timestamp, so consecutive messages often share a `created_at` value; preserve the returned order rather than re-sorting by timestamp. Each message also carries a `provenance` field describing how its content was captured. `provenance` is `null` for verified content captured by the Claude API, which is the common case. Otherwise it is an object whose `type` marks the exception: -* `content_unavailable` means the content cannot be returned. The `content` array is empty, and `provenance.reason` states why. `not_captured` means no content is available for the turn; it does not prove that no record was stored, because content withheld by a storage-side access policy is reported with the same reason (for example, in organizations that use [customer-managed encryption keys](https://platform.claude.com/docs/en/manage-claude/cmek#disabled-or-modified)), and individual turns within an otherwise captured session can be unavailable for other data-handling reasons and carry the same reason. `client_aborted` means the client closed the connection or cancelled the request before the response completed, so the turn's response was not captured; any partial output already streamed to the client is not included, and this reason applies to assistant-role turns only. `cmek_key_revoked` is reserved for content encrypted under your organization's customer-managed key when that key is unavailable (for example, revoked); it is not currently returned, so handle it for forward compatibility. `retention_elapsed` means the content aged past retention. `oversize` means a single message exceeded the per-message size bound; the message is still returned, with an empty `content` array. +* `content_unavailable` means the content cannot be returned. The `content` array is empty, and `provenance.reason` states why. `not_captured` means no content is available for the turn. It does not prove that no record was stored: content that Anthropic's data-handling policies withhold from the Compliance API is reported with the same reason, and so are individual turns within an otherwise captured session that are unavailable for such reasons. An unusable customer-managed key is the one exception and returns [503 Service Unavailable](https://platform.claude.com/docs/en/manage-claude/compliance-errors#local-sessions-temporarily-unavailable) instead. `client_aborted` means the client closed the connection or cancelled the request before the response completed, so the turn's response was not captured; any partial output already streamed to the client is not included, and this reason applies to assistant-role turns only. `cmek_key_revoked` is reserved for content encrypted under your organization's customer-managed key when that key is unavailable (for example, revoked). It is not currently returned, because an unusable key produces a 503 instead, but handle it for forward compatibility. `retention_elapsed` means the content aged past retention. `oversize` means a single message exceeded the per-message size bound; the message is still returned, with an empty `content` array. * `client_asserted` marks assistant messages that the client supplied as conversation history and that could not be matched to a captured response; their authorship is not verified. * `synthetic_marker` marks records generated by the endpoint itself, such as the marker that stands in for the system prompt. When the client rewrites or compacts its conversation history mid-session (for example, after context compaction), the transcript inserts a marker message at that point and continues with the new content the client sent; when your organization has a finite retention period, the rewritten history itself is withheld (a second marker notes this) and only the latest user turn and what follows are shown. diff --git a/content/en/manage-claude/rate-limits-api.md b/content/en/manage-claude/rate-limits-api.md index 55a1bc4bb..788aa7ccd 100644 --- a/content/en/manage-claude/rate-limits-api.md +++ b/content/en/manage-claude/rate-limits-api.md @@ -20,15 +20,130 @@ Use this API to: **Admin API key required.** These endpoints require an Admin API key, which is different from a standard Claude API key. See [Create an Admin API key](https://platform.claude.com/docs/en/manage-claude/admin-api-keys) to find where to create one for your organization type and which scopes to select. +The SDK and CLI examples on this page construct the default client, which reads the Admin API key from the `ANTHROPIC_API_KEY` environment variable. The SDKs expose these endpoints as `client.beta.organization.rate_limits` and `client.beta.organization.workspaces.rate_limits`; the Python, TypeScript, C#, Go, and Java list methods return an iterator that follows `next_page` for you, while the PHP, Ruby, and curl examples read one page. + ## Quick start List the rate limits configured for your organization: -```bash cURL -curl "https://api.anthropic.com/v1/organizations/rate_limits" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/rate_limits" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:rate-limits list + ``` + + ```python Python + client = anthropic.Anthropic() + + rate_limits = client.beta.organization.rate_limits.list() + + for group in rate_limits: + models = f" ({', '.join(group.models)})" if group.models else "" + print(f"{group.group_type}{models}") + for limit in group.limits: + print(f" {limit.type}: {limit.value}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const rateLimits = await client.beta.organization.rateLimits.list(); + + for await (const group of rateLimits) { + const models = group.models ? ` (${group.models.join(", ")})` : ""; + console.log(`${group.group_type}${models}`); + for (const limit of group.limits) { + console.log(` ${limit.type}: ${limit.value}`); + } + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var rateLimits = await client.Beta.Organization.RateLimits.List(); + + await foreach (var group in rateLimits.Paginate()) + { + var models = group.Models is null ? "" : $" ({string.Join(", ", group.Models)})"; + Console.WriteLine($"{group.GroupType.Raw()}{models}"); + foreach (var limit in group.Limits) + { + Console.WriteLine($" {limit.Type}: {limit.Value}"); + } + } + ``` + + ```go Go + client := anthropic.NewClient() + + rateLimits := client.Beta.Organization.RateLimits.ListAutoPaging(context.Background(), anthropic.BetaOrganizationRateLimitListParams{}) + + for rateLimits.Next() { + group := rateLimits.Current() + models := "" + if len(group.Models) > 0 { + models = fmt.Sprintf(" (%s)", strings.Join(group.Models, ", ")) + } + fmt.Printf("%s%s\n", group.GroupType, models) + for _, limit := range group.Limits { + fmt.Printf(" %s: %d\n", limit.Type, limit.Value) + } + } + if err := rateLimits.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var rateLimits = client.beta().organization().rateLimits().list(); + + for (var group : rateLimits.autoPager()) { + var models = group.models() + .map(modelIds -> " (" + String.join(", ", modelIds) + ")") + .orElse(""); + IO.println(group.groupType().asString() + models); + for (var limit : group.limits()) { + IO.println(" " + limit.type() + ": " + limit.value()); + } + } + ``` + + ```php PHP + $client = new Client(); + + $rateLimits = $client->beta->organization->rateLimits->list(); + + foreach ($rateLimits->data as $group) { + $models = $group->models ? ' (' . implode(', ', $group->models) . ')' : ''; + echo "{$group->groupType}{$models}\n"; + foreach ($group->limits as $limit) { + echo " {$limit->type}: {$limit->value}\n"; + } + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + rate_limits = client.beta.organization.rate_limits.list + + rate_limits.data.each do |group| + models = group.models ? " (#{group.models.join(", ")})" : "" + puts "#{group.group_type}#{models}" + group.limits.each do |limit| + puts " #{limit.type}: #{limit.value}" + end + end + ``` + ## Organization rate limits @@ -45,11 +160,124 @@ For complete parameter details and response schemas, see the [Organization Rate ### List all organization rate limits -```bash cURL -curl "https://api.anthropic.com/v1/organizations/rate_limits" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/rate_limits" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:rate-limits list + ``` + + ```python Python + client = anthropic.Anthropic() + + rate_limits = client.beta.organization.rate_limits.list() + + for group in rate_limits: + models = f" ({', '.join(group.models)})" if group.models else "" + print(f"{group.group_type}{models}") + for limit in group.limits: + print(f" {limit.type}: {limit.value}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const rateLimits = await client.beta.organization.rateLimits.list(); + + for await (const group of rateLimits) { + const models = group.models ? ` (${group.models.join(", ")})` : ""; + console.log(`${group.group_type}${models}`); + for (const limit of group.limits) { + console.log(` ${limit.type}: ${limit.value}`); + } + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var rateLimits = await client.Beta.Organization.RateLimits.List(); + + await foreach (var group in rateLimits.Paginate()) + { + var models = group.Models is null ? "" : $" ({string.Join(", ", group.Models)})"; + Console.WriteLine($"{group.GroupType.Raw()}{models}"); + foreach (var limit in group.Limits) + { + Console.WriteLine($" {limit.Type}: {limit.Value}"); + } + } + ``` + + ```go Go + client := anthropic.NewClient() + + rateLimits := client.Beta.Organization.RateLimits.ListAutoPaging(context.Background(), anthropic.BetaOrganizationRateLimitListParams{}) + + for rateLimits.Next() { + group := rateLimits.Current() + models := "" + if len(group.Models) > 0 { + models = fmt.Sprintf(" (%s)", strings.Join(group.Models, ", ")) + } + fmt.Printf("%s%s\n", group.GroupType, models) + for _, limit := range group.Limits { + fmt.Printf(" %s: %d\n", limit.Type, limit.Value) + } + } + if err := rateLimits.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var rateLimits = client.beta().organization().rateLimits().list(); + + for (var group : rateLimits.autoPager()) { + var models = group.models() + .map(modelIds -> " (" + String.join(", ", modelIds) + ")") + .orElse(""); + IO.println(group.groupType().asString() + models); + for (var limit : group.limits()) { + IO.println(" " + limit.type() + ": " + limit.value()); + } + } + ``` + + ```php PHP + $client = new Client(); + + $rateLimits = $client->beta->organization->rateLimits->list(); + + foreach ($rateLimits->data as $group) { + $models = $group->models ? ' (' . implode(', ', $group->models) . ')' : ''; + echo "{$group->groupType}{$models}\n"; + foreach ($group->limits as $limit) { + echo " {$limit->type}: {$limit->value}\n"; + } + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + rate_limits = client.beta.organization.rate_limits.list + + rate_limits.data.each do |group| + models = group.models ? " (#{group.models.join(", ")})" : "" + puts "#{group.group_type}#{models}" + group.limits.each do |limit| + puts " #{limit.type}: #{limit.value}" + end + end + ``` + ```json { @@ -95,11 +323,141 @@ curl "https://api.anthropic.com/v1/organizations/rate_limits" \ Pass any model ID or alias as the `model` query parameter to return only the entry that contains it: -```bash cURL -curl "https://api.anthropic.com/v1/organizations/rate_limits?model=claude-opus-5" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/rate_limits?model=claude-opus-5" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:rate-limits list --model claude-opus-5 + ``` + + ```python Python + client = anthropic.Anthropic() + + rate_limits = client.beta.organization.rate_limits.list(model="claude-opus-5") + + for group in rate_limits: + models = f" ({', '.join(group.models)})" if group.models else "" + print(f"{group.group_type}{models}") + for limit in group.limits: + print(f" {limit.type}: {limit.value}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const rateLimits = await client.beta.organization.rateLimits.list({ model: "claude-opus-5" }); + + for await (const group of rateLimits) { + const models = group.models ? ` (${group.models.join(", ")})` : ""; + console.log(`${group.group_type}${models}`); + for (const limit of group.limits) { + console.log(` ${limit.type}: ${limit.value}`); + } + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var rateLimits = await client.Beta.Organization.RateLimits.List(new() + { + Model = "claude-opus-5" + }); + + await foreach (var group in rateLimits.Paginate()) + { + var models = group.Models is null ? "" : $" ({string.Join(", ", group.Models)})"; + Console.WriteLine($"{group.GroupType.Raw()}{models}"); + foreach (var limit in group.Limits) + { + Console.WriteLine($" {limit.Type}: {limit.Value}"); + } + } + ``` + + ```go Go + client := anthropic.NewClient() + + rateLimits := client.Beta.Organization.RateLimits.ListAutoPaging(context.Background(), anthropic.BetaOrganizationRateLimitListParams{ + Model: anthropic.String(anthropic.ModelClaudeOpus5), + }) + + for rateLimits.Next() { + group := rateLimits.Current() + models := "" + if len(group.Models) > 0 { + models = fmt.Sprintf(" (%s)", strings.Join(group.Models, ", ")) + } + fmt.Printf("%s%s\n", group.GroupType, models) + for _, limit := range group.Limits { + fmt.Printf(" %s: %d\n", limit.Type, limit.Value) + } + } + if err := rateLimits.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.ratelimits.RateLimitListParams; + import com.anthropic.models.messages.Model; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = RateLimitListParams.builder() + .model(Model.CLAUDE_OPUS_5.asString()) + .build(); + var rateLimits = client.beta().organization().rateLimits().list(params); + + for (var group : rateLimits.autoPager()) { + var models = group.models() + .map(modelIds -> " (" + String.join(", ", modelIds) + ")") + .orElse(""); + IO.println(group.groupType().asString() + models); + for (var limit : group.limits()) { + IO.println(" " + limit.type() + ": " + limit.value()); + } + } + } + ``` + + ```php PHP + use Anthropic\Messages\Model; + + $client = new Client(); + + $rateLimits = $client->beta->organization->rateLimits->list( + model: Model::CLAUDE_OPUS_5->value, + ); + + foreach ($rateLimits->data as $group) { + $models = $group->models ? ' (' . implode(', ', $group->models) . ')' : ''; + echo "{$group->groupType}{$models}\n"; + foreach ($group->limits as $limit) { + echo " {$limit->type}: {$limit->value}\n"; + } + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + rate_limits = client.beta.organization.rate_limits.list(model: Anthropic::Model::CLAUDE_OPUS_5) + + rate_limits.data.each do |group| + models = group.models ? " (#{group.models.join(", ")})" : "" + puts "#{group.group_type}#{models}" + group.limits.each do |limit| + puts " #{limit.type}: #{limit.value}" + end + end + ``` + If the model string doesn't match any group, the endpoint returns a 404 error. The `model` parameter is supported on the organization endpoint only; the workspace endpoint doesn't accept it. @@ -119,11 +477,139 @@ For complete parameter details and response schemas, see the [Workspace Rate Lim To retrieve your organization's workspace IDs, use the [List Workspaces](https://platform.claude.com/docs/en/api/admin/workspaces/list) endpoint, or find them in the [Claude Console](https://platform.claude.com/settings/workspaces). The default workspace cannot have rate limit overrides, so it has no entry on this endpoint; use the organization endpoint to read its limits. -```bash cURL -curl "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/rate_limits" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/rate_limits" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:workspaces:rate-limits list \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ + ``` + + ```python Python + client = anthropic.Anthropic() + + rate_limits = client.beta.organization.workspaces.rate_limits.list( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ) + + for group in rate_limits: + models = f" ({', '.join(group.models)})" if group.models else "" + print(f"{group.group_type}{models}") + for limit in group.limits: + print(f" {limit.type}: {limit.value}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const rateLimits = await client.beta.organization.workspaces.rateLimits.list( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ); + + for await (const group of rateLimits) { + const models = group.models ? ` (${group.models.join(", ")})` : ""; + console.log(`${group.group_type}${models}`); + for (const limit of group.limits) { + console.log(` ${limit.type}: ${limit.value}`); + } + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var rateLimits = await client.Beta.Organization.Workspaces.RateLimits.List( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ); + + await foreach (var group in rateLimits.Paginate()) + { + var models = group.Models is null ? "" : $" ({string.Join(", ", group.Models)})"; + Console.WriteLine($"{group.GroupType.Raw()}{models}"); + foreach (var limit in group.Limits) + { + Console.WriteLine($" {limit.Type}: {limit.Value}"); + } + } + ``` + + ```go Go + client := anthropic.NewClient() + + rateLimits := client.Beta.Organization.Workspaces.RateLimits.ListAutoPaging( + context.Background(), + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + anthropic.BetaOrganizationWorkspaceRateLimitListParams{}, + ) + + for rateLimits.Next() { + group := rateLimits.Current() + models := "" + if len(group.Models) > 0 { + models = fmt.Sprintf(" (%s)", strings.Join(group.Models, ", ")) + } + fmt.Printf("%s%s\n", group.GroupType, models) + for _, limit := range group.Limits { + fmt.Printf(" %s: %d\n", limit.Type, limit.Value) + } + } + if err := rateLimits.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var rateLimits = client.beta().organization().workspaces().rateLimits() + .list("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"); + + for (var group : rateLimits.autoPager()) { + var models = group.models() + .map(modelIds -> " (" + String.join(", ", modelIds) + ")") + .orElse(""); + IO.println(group.groupType().asString() + models); + for (var limit : group.limits()) { + IO.println(" " + limit.type() + ": " + limit.value()); + } + } + ``` + + ```php PHP + $client = new Client(); + + $rateLimits = $client->beta->organization->workspaces->rateLimits->list( + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + ); + + foreach ($rateLimits->data as $group) { + $models = $group->models ? ' (' . implode(', ', $group->models) . ')' : ''; + echo "{$group->groupType}{$models}\n"; + foreach ($group->limits as $limit) { + echo " {$limit->type}: {$limit->value}\n"; + } + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace_id = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + rate_limits = client.beta.organization.workspaces.rate_limits.list(workspace_id) + + rate_limits.data.each do |group| + models = group.models ? " (#{group.models.join(", ")})" : "" + puts "#{group.group_type}#{models}" + group.limits.each do |limit| + puts " #{limit.type}: #{limit.value}" + end + end + ``` + ```json { @@ -161,11 +647,143 @@ curl "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA Both endpoints accept an optional `group_type` query parameter that restricts the response to a single category: -```bash cURL -curl "https://api.anthropic.com/v1/organizations/rate_limits?group_type=batch" \ - --header "anthropic-version: 2023-06-01" \ - --header "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/rate_limits?group_type=batch" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:rate-limits list --group-type batch + ``` + + ```python Python + client = anthropic.Anthropic() + + rate_limits = client.beta.organization.rate_limits.list(group_type="batch") + + for group in rate_limits: + models = f" ({', '.join(group.models)})" if group.models else "" + print(f"{group.group_type}{models}") + for limit in group.limits: + print(f" {limit.type}: {limit.value}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const rateLimits = await client.beta.organization.rateLimits.list({ group_type: "batch" }); + + for await (const group of rateLimits) { + const models = group.models ? ` (${group.models.join(", ")})` : ""; + console.log(`${group.group_type}${models}`); + for (const limit of group.limits) { + console.log(` ${limit.type}: ${limit.value}`); + } + } + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.RateLimits; + + AnthropicClient client = new(); + + var rateLimits = await client.Beta.Organization.RateLimits.List(new() + { + GroupType = GroupType.Batch + }); + + await foreach (var group in rateLimits.Paginate()) + { + var models = group.Models is null ? "" : $" ({string.Join(", ", group.Models)})"; + Console.WriteLine($"{group.GroupType.Raw()}{models}"); + foreach (var limit in group.Limits) + { + Console.WriteLine($" {limit.Type}: {limit.Value}"); + } + } + ``` + + ```go Go + client := anthropic.NewClient() + + rateLimits := client.Beta.Organization.RateLimits.ListAutoPaging(context.Background(), anthropic.BetaOrganizationRateLimitListParams{ + GroupType: anthropic.BetaOrganizationRateLimitListParamsGroupTypeBatch, + }) + + for rateLimits.Next() { + group := rateLimits.Current() + models := "" + if len(group.Models) > 0 { + models = fmt.Sprintf(" (%s)", strings.Join(group.Models, ", ")) + } + fmt.Printf("%s%s\n", group.GroupType, models) + for _, limit := range group.Limits { + fmt.Printf(" %s: %d\n", limit.Type, limit.Value) + } + } + if err := rateLimits.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.ratelimits.RateLimitListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = RateLimitListParams.builder() + .groupType(RateLimitListParams.GroupType.BATCH) + .build(); + var rateLimits = client.beta().organization().rateLimits().list(params); + + for (var group : rateLimits.autoPager()) { + var models = group.models() + .map(modelIds -> " (" + String.join(", ", modelIds) + ")") + .orElse(""); + IO.println(group.groupType().asString() + models); + for (var limit : group.limits()) { + IO.println(" " + limit.type() + ": " + limit.value()); + } + } + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\RateLimits\RateLimitListParams\GroupType; + // ... + + $client = new Client(); + + $rateLimits = $client->beta->organization->rateLimits->list( + groupType: GroupType::BATCH, + ); + + foreach ($rateLimits->data as $group) { + $models = $group->models ? ' (' . implode(', ', $group->models) . ')' : ''; + echo "{$group->groupType}{$models}\n"; + foreach ($group->limits as $limit) { + echo " {$limit->type}: {$limit->value}\n"; + } + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + rate_limits = client.beta.organization.rate_limits.list(group_type: :batch) + + rate_limits.data.each do |group| + models = group.models ? " (#{group.models.join(", ")})" : "" + puts "#{group.group_type}#{models}" + group.limits.each do |limit| + puts " #{limit.type}: #{limit.value}" + end + end + ``` + Valid values are `model_group`, `batch`, `token_count`, `files`, `skills`, and `web_search`. diff --git a/content/en/manage-claude/usage-cost-api.md b/content/en/manage-claude/usage-cost-api.md index a69211024..54dcec9a9 100644 --- a/content/en/manage-claude/usage-cost-api.md +++ b/content/en/manage-claude/usage-cost-api.md @@ -56,6 +56,10 @@ Leading observability platforms offer ready-to-use integrations for monitoring y Agentless integration for easy LLM observability with out-of-the-box dashboards and alerts + + FinOps platform for cloud and AI cost management + + Advanced querying and visualization through OpenTelemetry @@ -310,9 +314,9 @@ Code execution costs appear in the cost endpoint grouped under `Code Execution U Filter or group by `service_tier` in the usage endpoint and look for the `priority` value. Priority Tier costs are not available in the cost endpoint. -### What happens with Playground usage? +### What happens with playground usage? -API usage from Playground in the Claude Console (and from the legacy Workbench before it) is not associated with an API key, so `api_key_id` will be `null` even when grouping by that dimension. +API usage from playground in the Claude Console (and from the legacy Workbench before it) is not associated with an API key, so `api_key_id` will be `null` even when grouping by that dimension. ### How is the default workspace represented? diff --git a/content/en/manage-claude/wif-admin-api.md b/content/en/manage-claude/wif-admin-api.md index 4983781a3..f40cbb1c7 100644 --- a/content/en/manage-claude/wif-admin-api.md +++ b/content/en/manage-claude/wif-admin-api.md @@ -12,15 +12,17 @@ Every request on this page authenticates with an OAuth bearer token that carries ### Interactive (your terminal) -Log in with the [`ant` CLI](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/quickstart) under a dedicated profile, requesting the `org:admin` scope (see [Admin access](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/authentication#admin-access)), then export the bearer token: +Log in with the [`ant` CLI](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/quickstart) under a dedicated profile, requesting the `org:admin` scope (see [Admin access](https://platform.claude.com/docs/en/cli-sdks-libraries/cli/authentication#admin-access)), then export the bearer token. Logging in with `--profile admin` stores the `org:admin` credential under its own profile name and also makes it the CLI's active profile, and the exported variable applies to every SDK and CLI call in that shell; so use a shell you reserve for administration, unset the variable when you are done, and switch the CLI back with `ant profile activate default`: ```bash CLI ant auth login --profile admin --scope "org:admin" -export ANTHROPIC_OAUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token) +export ANTHROPIC_AUTH_TOKEN=$(ant auth print-credentials --profile admin --access-token) ``` Interactive tokens are short-lived; if requests start returning 401, re-run the export command (it refreshes the token automatically). +The SDKs and the `ant` CLI read `ANTHROPIC_AUTH_TOKEN` automatically; leave `ANTHROPIC_API_KEY` unset in the same shell, because these endpoints reject API keys and some clients prefer the key when both are set. + ### Workload (CI and automation) Create a federation rule with `oauth_scope: org:admin` that targets a service account whose `organization_role` is `admin`. The rule itself must be created in the Claude Console: granting a workload organization-admin access is a deliberate human action, not something automation can bootstrap for itself. The next section walks through this once-per-organization setup. @@ -39,11 +41,25 @@ One Console-created rule is enough to put the rest of your federation configurat - At runtime, the workload exchanges the JWT from its identity provider for a short-lived `org:admin` bearer token using the same [token exchange](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation#authenticate-from-your-workload) as any other federated workload. + A workload that uses one of the SDKs or the `ant` CLI does not perform the exchange itself. Point the client at the rule with the federation environment variables and construct it with no arguments, exactly as for inference in [Construct the SDK client](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation#construct-the-sdk-client); the client exchanges the identity token on the first request and, before the resulting access token expires, re-reads the identity token and exchanges it again: + + ```bash + export ANTHROPIC_FEDERATION_RULE_ID=fdrl_... # the org:admin rule from step 1 + export ANTHROPIC_ORGANIZATION_ID=00000000-0000-0000-0000-000000000000 + export ANTHROPIC_SERVICE_ACCOUNT_ID=svac_... # the rule's target service account + export ANTHROPIC_IDENTITY_TOKEN_FILE=/path/to/jwt # or ANTHROPIC_IDENTITY_TOKEN + # ANTHROPIC_WORKSPACE_ID is required only if the rule is enabled for all + # workspaces or more than one; the org:admin endpoints ignore the binding. + unset ANTHROPIC_API_KEY ANTHROPIC_AUTH_TOKEN # both take precedence over federation + ``` + + The `ant` CLI reads the same variables, or takes `--federation-rule`, `--organization-id`, `--service-account-id`, and `--identity-token-file` flags. For a workload that runs more than one `ant` command, use a [federation profile](https://platform.claude.com/docs/en/manage-claude/wif-reference#profile-configuration-file) rather than flags or environment variables: with flags or variables the CLI exchanges the identity token again in every process, and identity tokens that carry a `jti` claim (GitHub Actions tokens do) are accepted only once, so a second command would be rejected; a profile is also the only way to give the CLI a `workspace_id` for the exchange when the rule is enabled for all workspaces or more than one, because unlike the SDKs the CLI does not pass `ANTHROPIC_WORKSPACE_ID` or `--workspace-id` into the exchange. Every SDK also accepts the same settings as explicit constructor arguments, shown per language in [Construct the SDK client](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation#construct-the-sdk-client). See [Environment variables](https://platform.claude.com/docs/en/manage-claude/wif-reference#environment-variables) and [Credential precedence](https://platform.claude.com/docs/en/manage-claude/wif-reference#credential-precedence) for the full list and ordering. + + A workload that calls the API with curl exchanges the JWT for a short-lived `org:admin` bearer token itself, using the same [token exchange](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation#authenticate-from-your-workload) as any other federated workload, and sends it in the `authorization: Bearer` header. - With the minted token in `ANTHROPIC_OAUTH_TOKEN`, the workload creates and manages your federation configuration using the endpoints on this page. + With the client configured (or, for curl, the minted token in `ANTHROPIC_AUTH_TOKEN`), the workload creates and manages your federation configuration using the endpoints on this page. @@ -53,11 +69,91 @@ For the operations a workload-minted token can and cannot perform, see [Permissi All endpoints live under `https://api.anthropic.com/v1/organizations/`. Every request to the federation and service-account endpoints needs the API version header and the bearer token: -```bash cURL -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/service_accounts" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" -``` +In the SDKs these endpoints are `client.beta.organization.service_accounts`, `client.beta.organization.federation.issuers`, and `client.beta.organization.federation.rules` (`ant beta:organization:service-accounts`, `federation:issuers`, and `federation:rules` in the CLI). The SDK and CLI examples construct the default client, which sends the bearer token from `ANTHROPIC_AUTH_TOKEN`, or, in an automated workload, performs the federation exchange itself as described in [Bootstrap a workload to manage WIF](https://platform.claude.com/docs/en/manage-claude/wif-admin-api#bootstrap-a-workload-to-manage-wif). SDK list methods fetch further pages on demand, so `limit` sets the page size; the PHP and Ruby examples read one page. + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/service_accounts" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:service-accounts list + ``` + + ```python Python + client = anthropic.Anthropic() + + service_accounts = client.beta.organization.service_accounts.list() + + for service_account in service_accounts: + print(f"{service_account.id}: {service_account.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + for await (const serviceAccount of client.beta.organization.serviceAccounts.list()) { + console.log(`${serviceAccount.id}: ${serviceAccount.name}`); + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var page = await client.Beta.Organization.ServiceAccounts.List(); + + await foreach (var serviceAccount in page.Paginate()) + { + Console.WriteLine($"{serviceAccount.ID}: {serviceAccount.Name}"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + serviceAccounts := client.Beta.Organization.ServiceAccounts.ListAutoPaging(context.Background(), anthropic.BetaOrganizationServiceAccountListParams{}) + + for serviceAccounts.Next() { + serviceAccount := serviceAccounts.Current() + fmt.Printf("%s: %s\n", serviceAccount.ID, serviceAccount.Name) + } + if err := serviceAccounts.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var serviceAccounts = client.beta().organization().serviceAccounts().list(); + + for (var serviceAccount : serviceAccounts.autoPager()) { + IO.println(serviceAccount.id() + ": " + serviceAccount.name()); + } + ``` + + ```php PHP + $client = new Client(); + + $serviceAccounts = $client->beta->organization->serviceAccounts->list(); + + foreach ($serviceAccounts->getItems() as $serviceAccount) { + echo "{$serviceAccount->id}: {$serviceAccount->name}\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + service_accounts = client.beta.organization.service_accounts.list + + service_accounts.data.each do |service_account| + puts "#{service_account.id}: #{service_account.name}" + end + ``` + Admin API keys are not accepted on these endpoints; the Admin API page's `x-api-key` examples do not apply here. @@ -65,27 +161,314 @@ Admin API keys are not accepted on these endpoints; the Admin API page's `x-api- A [service account](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation#service-accounts) (`svac_...`) is the non-human identity that a federated token acts as. Set `organization_role` to `developer`. -```bash cURL -# Create a service account -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/service_accounts" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \ - -H "content-type: application/json" \ - -d '{ - "name": "inference-worker", - "organization_role": "developer" - }' - -# List service accounts -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/service_accounts?limit=20" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" - -# Archive a service account -curl --fail-with-body -sS -X POST "https://api.anthropic.com/v1/organizations/service_accounts/svac_.../archive" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" -``` +Create a service account: + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/service_accounts" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "name": "inference-worker", + "organization_role": "developer" + }' + ``` + + ```bash CLI + ant beta:organization:service-accounts create \ + --name inference-worker \ + --organization-role developer + ``` + + ```python Python + client = anthropic.Anthropic() + + service_account = client.beta.organization.service_accounts.create( + name="inference-worker", organization_role="developer" + ) + + print(f"id: {service_account.id}") + print(f"name: {service_account.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const serviceAccount = await client.beta.organization.serviceAccounts.create({ + name: "inference-worker", + organization_role: "developer" + }); + + console.log(`id: ${serviceAccount.id}`); + console.log(`name: ${serviceAccount.name}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.ServiceAccounts; + + AnthropicClient client = new(); + + var serviceAccount = await client.Beta.Organization.ServiceAccounts.Create(new() + { + Name = "inference-worker", + OrganizationRole = OrganizationRole.Developer + }); + + Console.WriteLine($"id: {serviceAccount.ID}"); + Console.WriteLine($"name: {serviceAccount.Name}"); + ``` + + ```go Go + client := anthropic.NewClient() + + serviceAccount, err := client.Beta.Organization.ServiceAccounts.New(context.Background(), anthropic.BetaOrganizationServiceAccountNewParams{ + Name: "inference-worker", + OrganizationRole: anthropic.BetaOrganizationServiceAccountNewParamsOrganizationRoleDeveloper, + }) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", serviceAccount.ID) + fmt.Printf("name: %s\n", serviceAccount.Name) + ``` + + ```java Java + import com.anthropic.models.beta.organization.serviceaccounts.ServiceAccountCreateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = ServiceAccountCreateParams.builder() + .name("inference-worker") + .organizationRole(ServiceAccountCreateParams.OrganizationRole.DEVELOPER) + .build(); + var serviceAccount = client.beta().organization().serviceAccounts().create(params); + + IO.println("id: " + serviceAccount.id()); + IO.println("name: " + serviceAccount.name()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\ServiceAccounts\ServiceAccountCreateParams\OrganizationRole; + // ... + + $client = new Client(); + + $serviceAccount = $client->beta->organization->serviceAccounts->create( + name: 'inference-worker', + organizationRole: OrganizationRole::DEVELOPER, + ); + + echo "id: {$serviceAccount->id}\n"; + echo "name: {$serviceAccount->name}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + service_account = client.beta.organization.service_accounts.create( + name: "inference-worker", + organization_role: :developer + ) + + puts "id: #{service_account.id}" + puts "name: #{service_account.name}" + ``` + + +List service accounts: + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/service_accounts?limit=20" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:service-accounts list --limit 20 + ``` + + ```python Python + client = anthropic.Anthropic() + + service_accounts = client.beta.organization.service_accounts.list(limit=20) + + for service_account in service_accounts: + print(f"{service_account.id}: {service_account.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + for await (const serviceAccount of client.beta.organization.serviceAccounts.list({ + limit: 20 + })) { + console.log(`${serviceAccount.id}: ${serviceAccount.name}`); + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var page = await client.Beta.Organization.ServiceAccounts.List(new() { Limit = 20 }); + + await foreach (var serviceAccount in page.Paginate()) + { + Console.WriteLine($"{serviceAccount.ID}: {serviceAccount.Name}"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + serviceAccounts := client.Beta.Organization.ServiceAccounts.ListAutoPaging(context.Background(), anthropic.BetaOrganizationServiceAccountListParams{ + Limit: anthropic.Int(20), + }) + + for serviceAccounts.Next() { + serviceAccount := serviceAccounts.Current() + fmt.Printf("%s: %s\n", serviceAccount.ID, serviceAccount.Name) + } + if err := serviceAccounts.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.serviceaccounts.ServiceAccountListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = ServiceAccountListParams.builder() + .limit(20) + .build(); + var serviceAccounts = client.beta().organization().serviceAccounts().list(params); + + for (var serviceAccount : serviceAccounts.autoPager()) { + IO.println(serviceAccount.id() + ": " + serviceAccount.name()); + } + } + ``` + + ```php PHP + $client = new Client(); + + $serviceAccounts = $client->beta->organization->serviceAccounts->list(limit: 20); + + foreach ($serviceAccounts->getItems() as $serviceAccount) { + echo "{$serviceAccount->id}: {$serviceAccount->name}\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + service_accounts = client.beta.organization.service_accounts.list(limit: 20) + + service_accounts.data.each do |service_account| + puts "#{service_account.id}: #{service_account.name}" + end + ``` + + +Archive a service account: + + + ```bash cURL + curl --fail-with-body -sS -X POST "https://api.anthropic.com/v1/organizations/service_accounts/svac_01ABCDEFabcdef0123456789XY/archive" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:service-accounts archive svac_01ABCDEFabcdef0123456789XY + ``` + + ```python Python + client = anthropic.Anthropic() + + service_account = client.beta.organization.service_accounts.archive( + "svac_01ABCDEFabcdef0123456789XY" + ) + + print(f"id: {service_account.id}") + print(f"archived_at: {service_account.archived_at}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const serviceAccount = await client.beta.organization.serviceAccounts.archive( + "svac_01ABCDEFabcdef0123456789XY" + ); + + console.log(`id: ${serviceAccount.id}`); + console.log(`archived_at: ${serviceAccount.archived_at}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var serviceAccount = await client.Beta.Organization.ServiceAccounts.Archive( + "svac_01ABCDEFabcdef0123456789XY" + ); + + Console.WriteLine($"id: {serviceAccount.ID}"); + Console.WriteLine($"archived_at: {serviceAccount.ArchivedAt:O}"); + ``` + + ```go Go + client := anthropic.NewClient() + + serviceAccount, err := client.Beta.Organization.ServiceAccounts.Archive( + context.Background(), + "svac_01ABCDEFabcdef0123456789XY", + anthropic.BetaOrganizationServiceAccountArchiveParams{}, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", serviceAccount.ID) + fmt.Printf("archived_at: %s\n", serviceAccount.ArchivedAt) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var serviceAccount = client.beta().organization().serviceAccounts() + .archive("svac_01ABCDEFabcdef0123456789XY"); + + IO.println("id: " + serviceAccount.id()); + IO.println("archived_at: " + serviceAccount.archivedAt().orElseThrow()); + ``` + + ```php PHP + $client = new Client(); + + $serviceAccount = $client->beta->organization->serviceAccounts->archive( + serviceAccountID: 'svac_01ABCDEFabcdef0123456789XY', + ); + + echo "id: {$serviceAccount->id}\n"; + echo "archived_at: {$serviceAccount->archivedAt?->format(DATE_ATOM)}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + service_account_id = "svac_01ABCDEFabcdef0123456789XY" + service_account = client.beta.organization.service_accounts.archive(service_account_id) + + puts "id: #{service_account.id}" + puts "archived_at: #{service_account.archived_at}" + ``` + The create endpoint returns the new service account: @@ -114,28 +497,330 @@ A [federation issuer](https://platform.claude.com/docs/en/manage-claude/workload | `{"type": "explicit_url", "url": "..."}` | Point at a JWKS endpoint directly. | | `{"type": "inline", "keys": [...]}` | Upload the key set for providers that are not reachable from the public internet. | -```bash cURL -# Register an issuer (GitHub Actions, with JWKS discovery) -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/federation_issuers" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \ - -H "content-type: application/json" \ - -d '{ - "name": "github-actions", - "issuer_url": "https://token.actions.githubusercontent.com", - "jwks": {"type": "discovery"} - }' - -# List issuers -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/federation_issuers?limit=20" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" - -# Archive an issuer -curl --fail-with-body -sS -X POST "https://api.anthropic.com/v1/organizations/federation_issuers/fdis_.../archive" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" -``` +Register an issuer. This example registers GitHub Actions with JWKS discovery: + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/federation_issuers" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "name": "github-actions", + "issuer_url": "https://token.actions.githubusercontent.com", + "jwks": {"type": "discovery"} + }' + ``` + + ```bash CLI + ant beta:organization:federation:issuers create \ + --name github-actions \ + --issuer-url https://token.actions.githubusercontent.com \ + --jwks '{type: discovery}' + ``` + + ```python Python + client = anthropic.Anthropic() + + issuer = client.beta.organization.federation.issuers.create( + name="github-actions", + issuer_url="https://token.actions.githubusercontent.com", + jwks={"type": "discovery"}, + ) + + print(f"id: {issuer.id}") + print(f"name: {issuer.name}") + print(f"issuer_url: {issuer.issuer_url}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const issuer = await client.beta.organization.federation.issuers.create({ + name: "github-actions", + issuer_url: "https://token.actions.githubusercontent.com", + jwks: { type: "discovery" } + }); + + console.log(`id: ${issuer.id}`); + console.log(`name: ${issuer.name}`); + console.log(`issuer_url: ${issuer.issuer_url}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.Federation.Issuers; + + AnthropicClient client = new(); + + var issuer = await client.Beta.Organization.Federation.Issuers.Create(new() + { + Name = "github-actions", + IssuerUrl = "https://token.actions.githubusercontent.com", + Jwks = new BetaJwksDiscovery() + }); + + Console.WriteLine($"id: {issuer.ID}"); + Console.WriteLine($"name: {issuer.Name}"); + Console.WriteLine($"issuer_url: {issuer.IssuerUrl}"); + ``` + + ```go Go + client := anthropic.NewClient() + + issuer, err := client.Beta.Organization.Federation.Issuers.New(context.Background(), anthropic.BetaOrganizationFederationIssuerNewParams{ + Name: "github-actions", + IssuerURL: "https://token.actions.githubusercontent.com", + JWKS: anthropic.BetaOrganizationFederationIssuerNewParamsJWKSUnion{ + OfDiscovery: &anthropic.BetaJWKSDiscoveryParam{}, + }, + }) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", issuer.ID) + fmt.Printf("name: %s\n", issuer.Name) + fmt.Printf("issuer_url: %s\n", issuer.IssuerURL) + ``` + + ```java Java + import com.anthropic.models.beta.organization.federation.issuers.BetaJwksDiscovery; + import com.anthropic.models.beta.organization.federation.issuers.IssuerCreateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = IssuerCreateParams.builder() + .name("github-actions") + .issuerUrl("https://token.actions.githubusercontent.com") + .jwks(BetaJwksDiscovery.builder().build()) + .build(); + var issuer = client.beta().organization().federation().issuers().create(params); + + IO.println("id: " + issuer.id()); + IO.println("name: " + issuer.name()); + IO.println("issuer_url: " + issuer.issuerUrl()); + } + ``` + + ```php PHP + $client = new Client(); + + $issuer = $client->beta->organization->federation->issuers->create( + name: 'github-actions', + issuerURL: 'https://token.actions.githubusercontent.com', + jwks: ['type' => 'discovery'], + ); + + echo "id: {$issuer->id}\n"; + echo "name: {$issuer->name}\n"; + echo "issuer_url: {$issuer->issuerURL}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + issuer = client.beta.organization.federation.issuers.create( + name: "github-actions", + issuer_url: "https://token.actions.githubusercontent.com", + jwks: {type: :discovery} + ) + + puts "id: #{issuer.id}" + puts "name: #{issuer.name}" + puts "issuer_url: #{issuer.issuer_url}" + ``` + + +List issuers: + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/federation_issuers?limit=20" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:federation:issuers list --limit 20 + ``` + + ```python Python + client = anthropic.Anthropic() + + issuers = client.beta.organization.federation.issuers.list(limit=20) + + for issuer in issuers: + print(f"{issuer.id}: {issuer.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + for await (const issuer of client.beta.organization.federation.issuers.list({ limit: 20 })) { + console.log(`${issuer.id}: ${issuer.name}`); + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var page = await client.Beta.Organization.Federation.Issuers.List(new() { Limit = 20 }); + + await foreach (var issuer in page.Paginate()) + { + Console.WriteLine($"{issuer.ID}: {issuer.Name}"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + issuers := client.Beta.Organization.Federation.Issuers.ListAutoPaging(context.Background(), anthropic.BetaOrganizationFederationIssuerListParams{ + Limit: anthropic.Int(20), + }) + + for issuers.Next() { + issuer := issuers.Current() + fmt.Printf("%s: %s\n", issuer.ID, issuer.Name) + } + if err := issuers.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.federation.issuers.IssuerListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = IssuerListParams.builder() + .limit(20) + .build(); + var issuers = client.beta().organization().federation().issuers().list(params); + + for (var issuer : issuers.autoPager()) { + IO.println(issuer.id() + ": " + issuer.name()); + } + } + ``` + + ```php PHP + $client = new Client(); + + $issuers = $client->beta->organization->federation->issuers->list(limit: 20); + + foreach ($issuers->getItems() as $issuer) { + echo "{$issuer->id}: {$issuer->name}\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + issuers = client.beta.organization.federation.issuers.list(limit: 20) + + issuers.data.each do |issuer| + puts "#{issuer.id}: #{issuer.name}" + end + ``` + + +Archive an issuer: + + + ```bash cURL + curl --fail-with-body -sS -X POST "https://api.anthropic.com/v1/organizations/federation_issuers/fdis_01ABCDEFabcdef0123456789XY/archive" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:federation:issuers archive \ + --federation-issuer-id fdis_01ABCDEFabcdef0123456789XY + ``` + + ```python Python + client = anthropic.Anthropic() + + issuer = client.beta.organization.federation.issuers.archive( + "fdis_01ABCDEFabcdef0123456789XY" + ) + + print(f"id: {issuer.id}") + print(f"archived_at: {issuer.archived_at}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const issuer = await client.beta.organization.federation.issuers.archive( + "fdis_01ABCDEFabcdef0123456789XY" + ); + + console.log(`id: ${issuer.id}`); + console.log(`archived_at: ${issuer.archived_at}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var issuer = await client.Beta.Organization.Federation.Issuers.Archive( + "fdis_01ABCDEFabcdef0123456789XY" + ); + + Console.WriteLine($"id: {issuer.ID}"); + Console.WriteLine($"archived_at: {issuer.ArchivedAt:O}"); + ``` + + ```go Go + client := anthropic.NewClient() + + issuer, err := client.Beta.Organization.Federation.Issuers.Archive( + context.Background(), + "fdis_01ABCDEFabcdef0123456789XY", + anthropic.BetaOrganizationFederationIssuerArchiveParams{}, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", issuer.ID) + fmt.Printf("archived_at: %s\n", issuer.ArchivedAt) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var issuer = client.beta().organization().federation().issuers() + .archive("fdis_01ABCDEFabcdef0123456789XY"); + + IO.println("id: " + issuer.id()); + IO.println("archived_at: " + issuer.archivedAt().orElseThrow()); + ``` + + ```php PHP + $client = new Client(); + + $issuer = $client->beta->organization->federation->issuers->archive( + federationIssuerID: 'fdis_01ABCDEFabcdef0123456789XY', + ); + + echo "id: {$issuer->id}\n"; + echo "archived_at: {$issuer->archivedAt?->format(DATE_ATOM)}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + issuer_id = "fdis_01ABCDEFabcdef0123456789XY" + issuer = client.beta.organization.federation.issuers.archive(issuer_id) + + puts "id: #{issuer.id}" + puts "archived_at: #{issuer.archived_at}" + ``` + To read or update a single issuer, use `GET` and `POST` on `/v1/organizations/federation_issuers/{issuer_id}`. An OAuth caller cannot update an issuer that backs a rule whose `oauth_scope` is anything other than `workspace:developer` or `workspace:inference`; see [Permissions and constraints](https://platform.claude.com/docs/en/manage-claude/wif-admin-api#permissions-and-constraints). @@ -145,38 +830,420 @@ For complete parameter details and response schemas, see the [Federation issuers A [federation rule](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation#federation-rules) (`fdrl_...`) binds an issuer to a service account: JWTs from the issuer that satisfy the rule's match conditions can mint tokens that act as the rule's target. The `workspace_id` in the create request enables the rule in that workspace at creation; add more workspaces later through the `/federation_rules/{rule_id}/workspaces` sub-resource. Either `workspace_id` or `applies_to_all_workspaces: true` is required on create. -```bash cURL -# Create a rule (GitHub Actions deploys from the main branch) -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/federation_rules" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \ - -H "content-type: application/json" \ - -d '{ - "name": "gha-deploy", - "issuer_id": "fdis_...", - "match": { - "subject_prefix": "repo:my-org/my-repo:ref:refs/heads/main", - "claims": {"repository_owner": "my-org"} +Create a rule. This example lets GitHub Actions deploys from the main branch act as the service account: + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/federation_rules" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "name": "gha-deploy", + "issuer_id": "fdis_01ABCDEFabcdef0123456789XY", + "match": { + "subject_prefix": "repo:my-org/my-repo:ref:refs/heads/main", + "claims": {"repository_owner": "my-org"} + }, + "target": { + "type": "service_account", + "service_account_id": "svac_01ABCDEFabcdef0123456789XY" + }, + "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + "oauth_scope": "workspace:developer", + "token_lifetime_seconds": 600 + }' + ``` + + ```bash CLI + ant beta:organization:federation:rules create <<'YAML' + name: gha-deploy + issuer_id: fdis_01ABCDEFabcdef0123456789XY + match: + subject_prefix: "repo:my-org/my-repo:ref:refs/heads/main" + claims: + repository_owner: my-org + target: + type: service_account + service_account_id: svac_01ABCDEFabcdef0123456789XY + workspace_id: wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ + oauth_scope: "workspace:developer" + token_lifetime_seconds: 600 + YAML + ``` + + ```python Python + client = anthropic.Anthropic() + + rule = client.beta.organization.federation.rules.create( + name="gha-deploy", + issuer_id="fdis_01ABCDEFabcdef0123456789XY", + match={ + "subject_prefix": "repo:my-org/my-repo:ref:refs/heads/main", + "claims": {"repository_owner": "my-org"}, + }, + target={ + "type": "service_account", + "service_account_id": "svac_01ABCDEFabcdef0123456789XY", + }, + workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + oauth_scope="workspace:developer", + token_lifetime_seconds=600, + ) + + print(f"id: {rule.id}") + print(f"name: {rule.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const rule = await client.beta.organization.federation.rules.create({ + name: "gha-deploy", + issuer_id: "fdis_01ABCDEFabcdef0123456789XY", + match: { + subject_prefix: "repo:my-org/my-repo:ref:refs/heads/main", + claims: { repository_owner: "my-org" } }, - "target": { - "type": "service_account", - "service_account_id": "svac_..." + target: { + type: "service_account", + service_account_id: "svac_01ABCDEFabcdef0123456789XY" }, - "workspace_id": "wrkspc_...", - "oauth_scope": "workspace:developer", - "token_lifetime_seconds": 600 - }' - -# List rules, optionally filtered by issuer -curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/federation_rules?issuer_id=fdis_..." \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" - -# Archive a rule -curl --fail-with-body -sS -X POST "https://api.anthropic.com/v1/organizations/federation_rules/fdrl_.../archive" \ - -H "anthropic-version: 2023-06-01" \ - -H "authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" -``` + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + oauth_scope: "workspace:developer", + token_lifetime_seconds: 600 + }); + + console.log(`id: ${rule.id}`); + console.log(`name: ${rule.name}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var rule = await client.Beta.Organization.Federation.Rules.Create(new() + { + Name = "gha-deploy", + IssuerID = "fdis_01ABCDEFabcdef0123456789XY", + Match = new() + { + SubjectPrefix = "repo:my-org/my-repo:ref:refs/heads/main", + Claims = new Dictionary { ["repository_owner"] = "my-org" } + }, + Target = new() { ServiceAccountID = "svac_01ABCDEFabcdef0123456789XY" }, + WorkspaceID = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + OAuthScope = "workspace:developer", + TokenLifetimeSeconds = 600 + }); + + Console.WriteLine($"id: {rule.ID}"); + Console.WriteLine($"name: {rule.Name}"); + ``` + + ```go Go + client := anthropic.NewClient() + + rule, err := client.Beta.Organization.Federation.Rules.New(context.Background(), anthropic.BetaOrganizationFederationRuleNewParams{ + Name: "gha-deploy", + IssuerID: "fdis_01ABCDEFabcdef0123456789XY", + Match: anthropic.BetaFederationRuleMatchParam{ + SubjectPrefix: anthropic.String("repo:my-org/my-repo:ref:refs/heads/main"), + Claims: map[string]string{"repository_owner": "my-org"}, + }, + Target: anthropic.BetaServiceAccountTargetParam{ + ServiceAccountID: "svac_01ABCDEFabcdef0123456789XY", + }, + WorkspaceID: anthropic.String("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"), + OAuthScope: "workspace:developer", + TokenLifetimeSeconds: anthropic.Int(600), + }) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", rule.ID) + fmt.Printf("name: %s\n", rule.Name) + ``` + + ```java Java + import com.anthropic.core.JsonValue; + import com.anthropic.models.beta.organization.federation.rules.BetaFederationRuleMatch; + import com.anthropic.models.beta.organization.federation.rules.BetaServiceAccountTarget; + import com.anthropic.models.beta.organization.federation.rules.RuleCreateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var match = BetaFederationRuleMatch.builder() + .subjectPrefix("repo:my-org/my-repo:ref:refs/heads/main") + .claims(BetaFederationRuleMatch.Claims.builder() + .putAdditionalProperty("repository_owner", JsonValue.from("my-org")) + .build()) + .build(); + var params = RuleCreateParams.builder() + .name("gha-deploy") + .issuerId("fdis_01ABCDEFabcdef0123456789XY") + .match(match) + .target(BetaServiceAccountTarget.of("svac_01ABCDEFabcdef0123456789XY")) + .workspaceId("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ") + .oauthScope("workspace:developer") + .tokenLifetimeSeconds(600) + .build(); + var rule = client.beta().organization().federation().rules().create(params); + + IO.println("id: " + rule.id()); + IO.println("name: " + rule.name()); + } + ``` + + ```php PHP + $client = new Client(); + + $rule = $client->beta->organization->federation->rules->create( + name: 'gha-deploy', + issuerID: 'fdis_01ABCDEFabcdef0123456789XY', + match: [ + 'subjectPrefix' => 'repo:my-org/my-repo:ref:refs/heads/main', + 'claims' => ['repository_owner' => 'my-org'], + ], + target: [ + 'type' => 'service_account', + 'serviceAccountID' => 'svac_01ABCDEFabcdef0123456789XY', + ], + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + oauthScope: 'workspace:developer', + tokenLifetimeSeconds: 600, + ); + + echo "id: {$rule->id}\n"; + echo "name: {$rule->name}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + rule = client.beta.organization.federation.rules.create( + name: "gha-deploy", + issuer_id: "fdis_01ABCDEFabcdef0123456789XY", + match: { + subject_prefix: "repo:my-org/my-repo:ref:refs/heads/main", + claims: {repository_owner: "my-org"} + }, + target: { + type: :service_account, + service_account_id: "svac_01ABCDEFabcdef0123456789XY" + }, + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + oauth_scope: "workspace:developer", + token_lifetime_seconds: 600 + ) + + puts "id: #{rule.id}" + puts "name: #{rule.name}" + ``` + + +List rules, optionally filtered by issuer: + + + ```bash cURL + curl --fail-with-body -sS "https://api.anthropic.com/v1/organizations/federation_rules?issuer_id=fdis_01ABCDEFabcdef0123456789XY" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:federation:rules list \ + --issuer-id fdis_01ABCDEFabcdef0123456789XY + ``` + + ```python Python + client = anthropic.Anthropic() + + rules = client.beta.organization.federation.rules.list( + issuer_id="fdis_01ABCDEFabcdef0123456789XY" + ) + + for rule in rules: + print(f"{rule.id}: {rule.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + for await (const rule of client.beta.organization.federation.rules.list({ + issuer_id: "fdis_01ABCDEFabcdef0123456789XY" + })) { + console.log(`${rule.id}: ${rule.name}`); + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var page = await client.Beta.Organization.Federation.Rules.List(new() + { + IssuerID = "fdis_01ABCDEFabcdef0123456789XY" + }); + + await foreach (var rule in page.Paginate()) + { + Console.WriteLine($"{rule.ID}: {rule.Name}"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + rules := client.Beta.Organization.Federation.Rules.ListAutoPaging(context.Background(), anthropic.BetaOrganizationFederationRuleListParams{ + IssuerID: anthropic.String("fdis_01ABCDEFabcdef0123456789XY"), + }) + + for rules.Next() { + rule := rules.Current() + fmt.Printf("%s: %s\n", rule.ID, rule.Name) + } + if err := rules.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.federation.rules.RuleListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = RuleListParams.builder() + .issuerId("fdis_01ABCDEFabcdef0123456789XY") + .build(); + var rules = client.beta().organization().federation().rules().list(params); + + for (var rule : rules.autoPager()) { + IO.println(rule.id() + ": " + rule.name()); + } + } + ``` + + ```php PHP + $client = new Client(); + + $rules = $client->beta->organization->federation->rules->list( + issuerID: 'fdis_01ABCDEFabcdef0123456789XY', + ); + + foreach ($rules->getItems() as $rule) { + echo "{$rule->id}: {$rule->name}\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + rules = client.beta.organization.federation.rules.list( + issuer_id: "fdis_01ABCDEFabcdef0123456789XY" + ) + + rules.data.each do |rule| + puts "#{rule.id}: #{rule.name}" + end + ``` + + +Archive a rule: + + + ```bash cURL + curl --fail-with-body -sS -X POST "https://api.anthropic.com/v1/organizations/federation_rules/fdrl_01ABCDEFabcdef0123456789XY/archive" \ + -H "authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:federation:rules archive \ + --federation-rule-id fdrl_01ABCDEFabcdef0123456789XY + ``` + + ```python Python + client = anthropic.Anthropic() + + rule = client.beta.organization.federation.rules.archive( + "fdrl_01ABCDEFabcdef0123456789XY" + ) + + print(f"id: {rule.id}") + print(f"archived_at: {rule.archived_at}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const rule = await client.beta.organization.federation.rules.archive( + "fdrl_01ABCDEFabcdef0123456789XY" + ); + + console.log(`id: ${rule.id}`); + console.log(`archived_at: ${rule.archived_at}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var rule = await client.Beta.Organization.Federation.Rules.Archive( + "fdrl_01ABCDEFabcdef0123456789XY" + ); + + Console.WriteLine($"id: {rule.ID}"); + Console.WriteLine($"archived_at: {rule.ArchivedAt:O}"); + ``` + + ```go Go + client := anthropic.NewClient() + + rule, err := client.Beta.Organization.Federation.Rules.Archive( + context.Background(), + "fdrl_01ABCDEFabcdef0123456789XY", + anthropic.BetaOrganizationFederationRuleArchiveParams{}, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", rule.ID) + fmt.Printf("archived_at: %s\n", rule.ArchivedAt) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var rule = client.beta().organization().federation().rules() + .archive("fdrl_01ABCDEFabcdef0123456789XY"); + + IO.println("id: " + rule.id()); + IO.println("archived_at: " + rule.archivedAt().orElseThrow()); + ``` + + ```php PHP + $client = new Client(); + + $rule = $client->beta->organization->federation->rules->archive( + federationRuleID: 'fdrl_01ABCDEFabcdef0123456789XY', + ); + + echo "id: {$rule->id}\n"; + echo "archived_at: {$rule->archivedAt?->format(DATE_ATOM)}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + rule_id = "fdrl_01ABCDEFabcdef0123456789XY" + rule = client.beta.organization.federation.rules.archive(rule_id) + + puts "id: #{rule.id}" + puts "archived_at: #{rule.archived_at}" + ``` + The list endpoint returns a page of rules and the cursor for the next page: diff --git a/content/en/manage-claude/workspaces.md b/content/en/manage-claude/workspaces.md index b8c7cebcc..aa137c90a 100644 --- a/content/en/manage-claude/workspaces.md +++ b/content/en/manage-claude/workspaces.md @@ -38,7 +38,7 @@ Members can have different roles in each workspace, allowing fine-grained access | Role | Permissions | | --------------------------- | ----------------------------------------------------------------------------------------------- | -| Workspace User | Use Playground only | +| Workspace User | Use playground only | | Workspace Limited Developer | Create and manage API keys, use the API. Cannot access session tracing views or download files. | | Workspace Developer | Create and manage API keys, use the API | | Workspace Admin | Full control over workspace settings and members | @@ -140,54 +140,680 @@ Programmatically manage workspaces using the [Admin API](https://platform.claude Admin API endpoints require an Admin API key (starting with `sk-ant-admin...`) that differs from standard API keys. See [Create an Admin API key](https://platform.claude.com/docs/en/manage-claude/admin-api-keys) for how to provision one. -```bash cURL -# Create a workspace -curl -X POST "https://api.anthropic.com/v1/organizations/workspaces" \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \ - -d '{"name": "Production"}' +The following SDK and CLI examples construct the default client, which reads the Admin API key from the `ANTHROPIC_API_KEY` environment variable; the SDKs expose these endpoints under `client.beta.organization.workspaces`. SDK list methods fetch further pages on demand, so `limit` sets the page size; the PHP, Ruby, and curl examples return one page. -# List workspaces -curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \ - -H "anthropic-version: 2023-06-01" \ - -H "x-api-key: $ANTHROPIC_ADMIN_KEY" +Create a workspace: -# Archive a workspace -curl -X POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/archive" \ - -H "anthropic-version: 2023-06-01" \ - -H "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + + ```bash cURL + curl -X POST "https://api.anthropic.com/v1/organizations/workspaces" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{"name": "Production"}' + ``` + + ```bash CLI + ant beta:organization:workspaces create --name Production + ``` + + ```python Python + client = anthropic.Anthropic() + + workspace = client.beta.organization.workspaces.create(name="Production") + + print(f"id: {workspace.id}") + print(f"name: {workspace.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const workspace = await client.beta.organization.workspaces.create({ name: "Production" }); + + console.log(`id: ${workspace.id}`); + console.log(`name: ${workspace.name}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var workspace = await client.Beta.Organization.Workspaces.Create(new() + { + Name = "Production" + }); + + Console.WriteLine($"id: {workspace.ID}"); + Console.WriteLine($"name: {workspace.Name}"); + ``` + + ```go Go + client := anthropic.NewClient() + + workspace, err := client.Beta.Organization.Workspaces.New(context.Background(), anthropic.BetaOrganizationWorkspaceNewParams{ + Name: "Production", + }) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", workspace.ID) + fmt.Printf("name: %s\n", workspace.Name) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.WorkspaceCreateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = WorkspaceCreateParams.builder() + .name("Production") + .build(); + var workspace = client.beta().organization().workspaces().create(params); + + IO.println("id: " + workspace.id()); + IO.println("name: " + workspace.name()); + } + ``` + + ```php PHP + $client = new Client(); + + $workspace = $client->beta->organization->workspaces->create( + name: 'Production', + ); + + echo "id: {$workspace->id}\n"; + echo "name: {$workspace->name}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace = client.beta.organization.workspaces.create(name: "Production") + + puts "id: #{workspace.id}" + puts "name: #{workspace.name}" + ``` + + +List workspaces: + + + ```bash cURL + curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:workspaces list --limit 10 --include-archived=false + ``` + + ```python Python + client = anthropic.Anthropic() + + workspaces = client.beta.organization.workspaces.list(limit=10, include_archived=False) + + for workspace in workspaces: + print(f"{workspace.id}: {workspace.name}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const workspaces = await client.beta.organization.workspaces.list({ + limit: 10, + include_archived: false + }); + + for await (const workspace of workspaces) { + console.log(`${workspace.id}: ${workspace.name}`); + } + ``` + + ```csharp C# + AnthropicClient client = new(); + + var workspaces = await client.Beta.Organization.Workspaces.List(new() + { + Limit = 10, + IncludeArchived = false + }); + + await foreach (var workspace in workspaces.Paginate()) + { + Console.WriteLine($"{workspace.ID}: {workspace.Name}"); + } + ``` + + ```go Go + client := anthropic.NewClient() + + workspaces := client.Beta.Organization.Workspaces.ListAutoPaging(context.Background(), anthropic.BetaOrganizationWorkspaceListParams{ + Limit: anthropic.Int(10), + IncludeArchived: anthropic.Bool(false), + }) + + for workspaces.Next() { + workspace := workspaces.Current() + fmt.Printf("%s: %s\n", workspace.ID, workspace.Name) + } + if err := workspaces.Err(); err != nil { + log.Fatal(err) + } + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.WorkspaceListParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = WorkspaceListParams.builder() + .limit(10) + .includeArchived(false) + .build(); + var workspaces = client.beta().organization().workspaces().list(params); + + for (var workspace : workspaces.autoPager()) { + IO.println(workspace.id() + ": " + workspace.name()); + } + } + ``` + + ```php PHP + $client = new Client(); + + $workspaces = $client->beta->organization->workspaces->list( + limit: 10, + includeArchived: false, + ); + + foreach ($workspaces->getItems() as $workspace) { + echo "{$workspace->id}: {$workspace->name}\n"; + } + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspaces = client.beta.organization.workspaces.list(limit: 10, include_archived: false) + + workspaces.data.each do |workspace| + puts "#{workspace.id}: #{workspace.name}" + end + ``` + + +Archive a workspace: + + + ```bash cURL + curl -X POST "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/archive" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:workspaces archive --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ + ``` + + ```python Python + client = anthropic.Anthropic() + + workspace = client.beta.organization.workspaces.archive( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ) + + print(f"id: {workspace.id}") + print(f"archived_at: {workspace.archived_at}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const workspace = await client.beta.organization.workspaces.archive( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ); + + console.log(`id: ${workspace.id}`); + console.log(`archived_at: ${workspace.archived_at}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var workspace = await client.Beta.Organization.Workspaces.Archive( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ); + + Console.WriteLine($"id: {workspace.ID}"); + Console.WriteLine($"archived_at: {workspace.ArchivedAt:O}"); + ``` + + ```go Go + client := anthropic.NewClient() + + workspace, err := client.Beta.Organization.Workspaces.Archive(context.Background(), "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ") + if err != nil { + log.Fatal(err) + } + + fmt.Printf("id: %s\n", workspace.ID) + fmt.Printf("archived_at: %s\n", workspace.ArchivedAt) + ``` + + ```java Java + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var workspace = client.beta().organization().workspaces() + .archive("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"); + + IO.println("id: " + workspace.id()); + IO.println("archived_at: " + workspace.archivedAt().orElseThrow()); + ``` + + ```php PHP + $client = new Client(); + + $workspace = $client->beta->organization->workspaces->archive( + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + ); + + echo "id: {$workspace->id}\n"; + echo "archived_at: {$workspace->archivedAt?->format(DATE_ATOM)}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace_id = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + workspace = client.beta.organization.workspaces.archive(workspace_id) + + puts "id: #{workspace.id}" + puts "archived_at: #{workspace.archived_at}" + ``` + For complete parameter details and response schemas, see the [Workspaces API reference](https://platform.claude.com/docs/en/api/admin/workspaces/retrieve). ### Managing workspace members -Add, update, or remove members from a workspace: +Add a member to a workspace: -```bash cURL -# Add a member to a workspace -curl -X POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \ - -d '{ - "user_id": "user_xxx", - "workspace_role": "workspace_developer" - }' - -# Update a member's role -curl -X POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \ - -H "anthropic-version: 2023-06-01" \ - -H "content-type: application/json" \ - -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \ - -d '{"workspace_role": "workspace_admin"}' + + ```bash cURL + curl -X POST "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/members" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ + "user_id": "user_01XyDMpzjS89pFZXqSFUBDr6", + "workspace_role": "workspace_developer" + }' + ``` -# Remove a member from a workspace -curl -X DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \ - -H "anthropic-version: 2023-06-01" \ - -H "x-api-key: $ANTHROPIC_ADMIN_KEY" -``` + ```bash CLI + ant beta:organization:workspaces:members add \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ \ + --user-id user_01XyDMpzjS89pFZXqSFUBDr6 \ + --workspace-role workspace_developer + ``` + + ```python Python + client = anthropic.Anthropic() + + member = client.beta.organization.workspaces.members.add( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + user_id="user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_role="workspace_developer", + ) + + print(f"user_id: {member.user_id}") + print(f"workspace_role: {member.workspace_role}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const member = await client.beta.organization.workspaces.members.add( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + { + user_id: "user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_role: "workspace_developer" + } + ); + + console.log(`user_id: ${member.user_id}`); + console.log(`workspace_role: ${member.workspace_role}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.Workspaces; + + AnthropicClient client = new(); + + var member = await client.Beta.Organization.Workspaces.Members.Add( + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + new() + { + UserID = "user_01XyDMpzjS89pFZXqSFUBDr6", + WorkspaceRole = BetaNoBillingWorkspaceRole.WorkspaceDeveloper + } + ); + + Console.WriteLine($"user_id: {member.UserID}"); + Console.WriteLine($"workspace_role: {member.WorkspaceRole.Raw()}"); + ``` + + ```go Go + client := anthropic.NewClient() + + member, err := client.Beta.Organization.Workspaces.Members.Add( + context.Background(), + "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + anthropic.BetaOrganizationWorkspaceMemberAddParams{ + UserID: "user_01XyDMpzjS89pFZXqSFUBDr6", + WorkspaceRole: anthropic.BetaNoBillingWorkspaceRoleWorkspaceDeveloper, + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("user_id: %s\n", member.UserID) + fmt.Printf("workspace_role: %s\n", member.WorkspaceRole) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.BetaNoBillingWorkspaceRole; + import com.anthropic.models.beta.organization.workspaces.members.MemberAddParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = MemberAddParams.builder() + .userId("user_01XyDMpzjS89pFZXqSFUBDr6") + .workspaceRole(BetaNoBillingWorkspaceRole.WORKSPACE_DEVELOPER) + .build(); + var member = client.beta().organization().workspaces().members() + .add("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", params); + + IO.println("user_id: " + member.userId()); + IO.println("workspace_role: " + member.workspaceRole().asString()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\Workspaces\NoBillingWorkspaceRole; + // ... + + $client = new Client(); + + $member = $client->beta->organization->workspaces->members->add( + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + userID: 'user_01XyDMpzjS89pFZXqSFUBDr6', + workspaceRole: NoBillingWorkspaceRole::WORKSPACE_DEVELOPER, + ); + + echo "user_id: {$member->userID}\n"; + echo "workspace_role: {$member->workspaceRole}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + workspace_id = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + member = client.beta.organization.workspaces.members.add( + workspace_id, + user_id: "user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_role: :workspace_developer + ) + + puts "user_id: #{member.user_id}" + puts "workspace_role: #{member.workspace_role}" + ``` + + +Update a member's role: + + + ```bash cURL + curl -X POST "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/members/user_01XyDMpzjS89pFZXqSFUBDr6" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{"workspace_role": "workspace_admin"}' + ``` + + ```bash CLI + ant beta:organization:workspaces:members update \ + --user-id user_01XyDMpzjS89pFZXqSFUBDr6 \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ \ + --workspace-role workspace_admin + ``` + + ```python Python + client = anthropic.Anthropic() + + member = client.beta.organization.workspaces.members.update( + "user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + workspace_role="workspace_admin", + ) + + print(f"user_id: {member.user_id}") + print(f"workspace_role: {member.workspace_role}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const member = await client.beta.organization.workspaces.members.update( + "user_01XyDMpzjS89pFZXqSFUBDr6", + { + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + workspace_role: "workspace_admin" + } + ); + + console.log(`user_id: ${member.user_id}`); + console.log(`workspace_role: ${member.workspace_role}`); + ``` + + ```csharp C# + using Anthropic.Models.Beta.Organization.Workspaces; + + AnthropicClient client = new(); + + var member = await client.Beta.Organization.Workspaces.Members.Update( + "user_01XyDMpzjS89pFZXqSFUBDr6", + new() + { + WorkspaceID = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + WorkspaceRole = BetaWorkspaceRole.WorkspaceAdmin + } + ); + + Console.WriteLine($"user_id: {member.UserID}"); + Console.WriteLine($"workspace_role: {member.WorkspaceRole.Raw()}"); + ``` + + ```go Go + client := anthropic.NewClient() + + member, err := client.Beta.Organization.Workspaces.Members.Update( + context.Background(), + "user_01XyDMpzjS89pFZXqSFUBDr6", + anthropic.BetaOrganizationWorkspaceMemberUpdateParams{ + WorkspaceID: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + WorkspaceRole: anthropic.BetaWorkspaceRoleWorkspaceAdmin, + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("user_id: %s\n", member.UserID) + fmt.Printf("workspace_role: %s\n", member.WorkspaceRole) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.BetaWorkspaceRole; + import com.anthropic.models.beta.organization.workspaces.members.MemberUpdateParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = MemberUpdateParams.builder() + .workspaceId("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ") + .workspaceRole(BetaWorkspaceRole.WORKSPACE_ADMIN) + .build(); + var member = client.beta().organization().workspaces().members() + .update("user_01XyDMpzjS89pFZXqSFUBDr6", params); + + IO.println("user_id: " + member.userId()); + IO.println("workspace_role: " + member.workspaceRole().asString()); + } + ``` + + ```php PHP + use Anthropic\Beta\Organization\Workspaces\WorkspaceRole; + // ... + + $client = new Client(); + + $member = $client->beta->organization->workspaces->members->update( + userID: 'user_01XyDMpzjS89pFZXqSFUBDr6', + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + workspaceRole: WorkspaceRole::WORKSPACE_ADMIN, + ); + + echo "user_id: {$member->userID}\n"; + echo "workspace_role: {$member->workspaceRole}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + user_id = "user_01XyDMpzjS89pFZXqSFUBDr6" + member = client.beta.organization.workspaces.members.update( + user_id, + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + workspace_role: :workspace_admin + ) + + puts "user_id: #{member.user_id}" + puts "workspace_role: #{member.workspace_role}" + ``` + + +Remove a member from a workspace: + + + ```bash cURL + curl -X DELETE "https://api.anthropic.com/v1/organizations/workspaces/wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ/members/user_01XyDMpzjS89pFZXqSFUBDr6" \ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" + ``` + + ```bash CLI + ant beta:organization:workspaces:members remove \ + --user-id user_01XyDMpzjS89pFZXqSFUBDr6 \ + --workspace-id wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ + ``` + + ```python Python + client = anthropic.Anthropic() + + removed_member = client.beta.organization.workspaces.members.remove( + "user_01XyDMpzjS89pFZXqSFUBDr6", + workspace_id="wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + ) + + print(f"user_id: {removed_member.user_id}") + ``` + + ```typescript TypeScript + const client = new Anthropic(); + + const removedMember = await client.beta.organization.workspaces.members.remove( + "user_01XyDMpzjS89pFZXqSFUBDr6", + { workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } + ); + + console.log(`user_id: ${removedMember.user_id}`); + ``` + + ```csharp C# + AnthropicClient client = new(); + + var removedMember = await client.Beta.Organization.Workspaces.Members.Remove( + "user_01XyDMpzjS89pFZXqSFUBDr6", + new() { WorkspaceID = "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } + ); + + Console.WriteLine($"user_id: {removedMember.UserID}"); + ``` + + ```go Go + client := anthropic.NewClient() + + removedMember, err := client.Beta.Organization.Workspaces.Members.Remove( + context.Background(), + "user_01XyDMpzjS89pFZXqSFUBDr6", + anthropic.BetaOrganizationWorkspaceMemberRemoveParams{ + WorkspaceID: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", + }, + ) + if err != nil { + log.Fatal(err) + } + + fmt.Printf("user_id: %s\n", removedMember.UserID) + ``` + + ```java Java + import com.anthropic.models.beta.organization.workspaces.members.MemberRemoveParams; + + void main() { + AnthropicClient client = AnthropicOkHttpClient.fromEnv(); + + var params = MemberRemoveParams.builder() + .workspaceId("wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ") + .build(); + var removedMember = client.beta().organization().workspaces().members() + .remove("user_01XyDMpzjS89pFZXqSFUBDr6", params); + + IO.println("user_id: " + removedMember.userId()); + } + ``` + + ```php PHP + $client = new Client(); + + $removedMember = $client->beta->organization->workspaces->members->remove( + userID: 'user_01XyDMpzjS89pFZXqSFUBDr6', + workspaceID: 'wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ', + ); + + echo "user_id: {$removedMember->userID}\n"; + ``` + + ```ruby Ruby + client = Anthropic::Client.new + + user_id = "user_01XyDMpzjS89pFZXqSFUBDr6" + removed_member = client.beta.organization.workspaces.members.remove( + user_id, + workspace_id: "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" + ) + + puts "user_id: #{removed_member.user_id}" + ``` + For complete parameter details, see the [Workspace Members API reference](https://platform.claude.com/docs/en/api/admin/workspaces/members/retrieve). diff --git a/content/en/models/opus-5/migration-guide.md b/content/en/models/opus-5/migration-guide.md index 1c275691a..42878f1b9 100644 --- a/content/en/models/opus-5/migration-guide.md +++ b/content/en/models/opus-5/migration-guide.md @@ -113,7 +113,7 @@ These are not required but will improve your experience: ## Migrating to Claude Opus 5 from Claude Opus 4.7 -Claude Opus 5 should have strong out-of-the-box performance on existing Claude Opus 4.7 prompts and evals, at the same pricing of $5 per million input tokens and $25 per million output tokens. It supports the same set of features as Claude Opus 4.7, including the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows), [128k max output tokens](https://platform.claude.com/docs/en/models/overview), [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching), [batch processing](https://platform.claude.com/docs/en/build-with-claude/batch-processing), the [Files API](https://platform.claude.com/docs/en/build-with-claude/files), [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [vision](https://platform.claude.com/docs/en/build-with-claude/vision), and server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview), with two exceptions: [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) is not available on Claude Opus 5, and [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not supported on Claude Opus 5. It also adds [mid-conversation system messages](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages) and publicly documents [refusal stop details](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#refusal-response). On the Claude API, Claude Opus 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Opus 4.7 supports; existing integrations on the earlier `computer_20251124` version continue to work unchanged on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). +Claude Opus 5 should have strong out-of-the-box performance on existing Claude Opus 4.7 prompts and evals, at the same pricing of $5 per million input tokens and $25 per million output tokens. It supports the same set of features as Claude Opus 4.7, including the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows), [128k max output tokens](https://platform.claude.com/docs/en/models/overview), [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching), [batch processing](https://platform.claude.com/docs/en/build-with-claude/batch-processing), the [Files API](https://platform.claude.com/docs/en/build-with-claude/files), [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [vision](https://platform.claude.com/docs/en/build-with-claude/vision), and server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview), with two exceptions: [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) is not available on Claude Opus 5, and [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not supported on Claude Opus 5. It also adds [mid-conversation system messages](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages) and publicly documents [refusal stop details](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#refusal-response). On the Claude API and Google Cloud, Claude Opus 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Opus 4.7 supports; existing integrations on the earlier `computer_20251124` version continue to work unchanged on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). If your code is on Claude Opus 4.6 or earlier, use [Migrating to Claude Opus 5 from Claude Opus 4.6 and earlier Opus models](https://platform.claude.com/docs/en/models/opus-5/migration-guide#migrating-from-claude-opus-46) instead. That section includes breaking changes (sampling parameters rejected, manual extended thinking rejected, new tokenizer) that the upgrade from Claude Opus 4.7 alone does not cover. @@ -234,7 +234,7 @@ Claude Opus 5 should have strong out-of-the-box performance on existing Claude O * [Vision](https://platform.claude.com/docs/en/build-with-claude/vision) * Server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) ([bash](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool), [code execution](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool), [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), [text editor](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool), [web search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool), [MCP connector](https://platform.claude.com/docs/en/agents-and-tools/mcp-connector), [memory](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool)) -Two exceptions: [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) is not available on Claude Opus 5, and [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not supported on Claude Opus 5. On the Claude API, Claude Opus 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Opus 4.6 or earlier Opus models support; existing integrations on the earlier `computer_20251124` version continue to work unchanged on Claude Opus 5. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). +Two exceptions: [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) is not available on Claude Opus 5, and [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not supported on Claude Opus 5. On the Claude API and Google Cloud, Claude Opus 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Opus 4.6 or earlier Opus models support; existing integrations on the earlier `computer_20251124` version continue to work unchanged on Claude Opus 5. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). ### Update your model name diff --git a/content/en/models/sonnet-5/migration-guide.md b/content/en/models/sonnet-5/migration-guide.md index 5f3fba779..edb7802da 100644 --- a/content/en/models/sonnet-5/migration-guide.md +++ b/content/en/models/sonnet-5/migration-guide.md @@ -20,7 +20,7 @@ description: "Migrate to Claude Sonnet 5 from earlier Claude models: model IDs, Claude Sonnet 5 offers the best combination of speed and intelligence in the Claude model family. It builds on Claude Sonnet 4.6. -Claude Sonnet 5 is a drop-in upgrade for Claude Sonnet 4.6, priced at $2/$10 USD per million input/output tokens; see [Pricing](https://platform.claude.com/docs/en/about-claude/pricing) for details. There are two breaking API changes for code already running on Claude Sonnet 4.6: manual extended thinking (`thinking: {type: "enabled", budget_tokens: N}`) and sampling parameters (`temperature`, `top_p`, `top_k`) set to non-default values are no longer accepted and return a 400 error. Use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) with the [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) instead. Claude Sonnet 5 supports the same set of features as Claude Sonnet 4.6, including the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows), [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching), [batch processing](https://platform.claude.com/docs/en/build-with-claude/batch-processing), the [Files API](https://platform.claude.com/docs/en/build-with-claude/files), [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [vision](https://platform.claude.com/docs/en/build-with-claude/vision), and the full set of server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview). On the Claude API, Claude Sonnet 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Sonnet 4.6 supports; existing integrations on the earlier `computer_20251124` version continue to work unchanged on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not available on Claude Sonnet 5. Claude Sonnet 5 also uses a new tokenizer. +Claude Sonnet 5 is a drop-in upgrade for Claude Sonnet 4.6, priced at $2/$10 USD per million input/output tokens; see [Pricing](https://platform.claude.com/docs/en/about-claude/pricing) for details. There are two breaking API changes for code already running on Claude Sonnet 4.6: manual extended thinking (`thinking: {type: "enabled", budget_tokens: N}`) and sampling parameters (`temperature`, `top_p`, `top_k`) set to non-default values are no longer accepted and return a 400 error. Use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) with the [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) instead. Claude Sonnet 5 supports the same set of features as Claude Sonnet 4.6, including the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows), [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching), [batch processing](https://platform.claude.com/docs/en/build-with-claude/batch-processing), the [Files API](https://platform.claude.com/docs/en/build-with-claude/files), [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [vision](https://platform.claude.com/docs/en/build-with-claude/vision), and the full set of server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview). On the Claude API and Google Cloud, Claude Sonnet 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Sonnet 4.6 supports; existing integrations on the earlier `computer_20251124` version continue to work unchanged on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not available on Claude Sonnet 5. Claude Sonnet 5 also uses a new tokenizer. ## Migrating to Claude Sonnet 5 from Claude Sonnet 4.6 diff --git a/content/en/models/sonnet-5/whats-new-sonnet-5.md b/content/en/models/sonnet-5/whats-new-sonnet-5.md index d91067bcf..ca348ff51 100644 --- a/content/en/models/sonnet-5/whats-new-sonnet-5.md +++ b/content/en/models/sonnet-5/whats-new-sonnet-5.md @@ -12,7 +12,7 @@ Claude Sonnet 5 is the next generation of Anthropic's Sonnet model family. It is | --------------- | ----------------- | ---------------------------------------------- | | Claude Sonnet 5 | `claude-sonnet-5` | The best combination of speed and intelligence | -Claude Sonnet 5 supports the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) by default (1M tokens is both the default and the maximum; there is no smaller context variant), 128k max output tokens, [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), and the same set of tools and platform features as Claude Sonnet 4.6, except [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models), which is not available on Claude Sonnet 5. On the Claude API, Claude Sonnet 5 also supports the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) and the stable `computer_toolset_20260801` version of the [computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), neither of which Claude Sonnet 4.6 supports; the earlier `computer_20251124` version is still accepted on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). +Claude Sonnet 5 supports the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) by default (1M tokens is both the default and the maximum; there is no smaller context variant), 128k max output tokens, [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), and the same set of tools and platform features as Claude Sonnet 4.6, except [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models), which is not available on Claude Sonnet 5. On the Claude API and Google Cloud, Claude Sonnet 5 also supports the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) and the stable `computer_toolset_20260801` version of the [computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), neither of which Claude Sonnet 4.6 supports; the earlier `computer_20251124` version is still accepted on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). For complete pricing and specs, see the [models overview](https://platform.claude.com/docs/en/models/overview). diff --git a/content/en/release-notes/overview.md b/content/en/release-notes/overview.md index 33ba4268d..c0cb742b1 100644 --- a/content/en/release-notes/overview.md +++ b/content/en/release-notes/overview.md @@ -12,9 +12,17 @@ The Claude Platform release notes list changes to the Claude API, the client SDK For updates to Claude Code, see the [complete CHANGELOG.md](https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md) in the `claude-code` repository. +### August 26, 2026 + +* The [Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api) session endpoints are out of beta for Cowork and Claude Code sessions. See [Retrieve session transcripts](https://platform.claude.com/docs/en/manage-claude/compliance-sessions). +* The [Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api) local session endpoints now also return transcripts of Claude Science sessions (`product_surface` value `claude_science`) and Claude for Microsoft 365 sessions in Excel, PowerPoint, Word, and Outlook (`product_surface` values beginning with `office_agents`), in beta for Claude Enterprise organizations, with your existing Compliance Access Key and the `read:compliance_user_data` scope. See [Sessions on users' machines](https://platform.claude.com/docs/en/manage-claude/compliance-sessions#retrieve-local-sessions). + +- The [Admin API](https://platform.claude.com/docs/en/manage-claude/admin-api) is now available in the `ant` CLI and the Python, TypeScript, C#, Go, Java, PHP, and Ruby SDKs under `client.beta.organization`. They cover organization info, members, invites, workspaces and workspace members, API keys, rate limits, service accounts, workload identity federation issuers and rules, and customer-managed encryption keys. Usage and cost reports and the Claude Enterprise user-management and analytics endpoints remain curl-only. The CLI and SDKs read an Admin API key from `ANTHROPIC_API_KEY` or an `org:admin` OAuth token from `ANTHROPIC_AUTH_TOKEN`. + ### August 20, 2026 * We've released **v1.0 of the [Python SDK](https://platform.claude.com/docs/en/cli-sdks-libraries/sdks/python)**. The SDK's HTTP layer moves from `httpx` to [httpx2](https://httpx2.pydantic.dev), a maintained, API-compatible fork: build custom `http_client`, `Timeout`, and transport objects from `httpx2` (the `DefaultHttpxClient` helpers are unchanged), and call `httpx2.alias_httpx()` at startup if you rely on tracing or mocking libraries that patch `httpx`. v1.0 requires Python 3.10 or later and removes long-deprecated surface, including the legacy Text Completions API, the `temperature`, `top_p`, and `top_k` parameters on Messages methods, and the tool runner's client-side `compaction_control`. On the async client, `.with_raw_response` results now need `await response.parse()`, and `AnthropicBedrock` now raises an error when no AWS region is configured instead of defaulting to `us-east-1`. See the [v1 migration guide](https://github.com/anthropics/anthropic-sdk-python/blob/main/MIGRATION.md) for every change with before-and-after snippets. +* The [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) and [browser use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) toolsets (`computer_toolset_20260801` and `browser_toolset_20260801`) are now available on [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai) for Claude Fable 5, Claude Mythos 5, Claude Opus 5, Claude Sonnet 5, and Claude Opus 4.8. Requests use the same `tools` entries as on the Claude API. ### August 19, 2026 @@ -30,7 +38,7 @@ The Claude Platform release notes list changes to the Claude API, the client SDK ### August 18, 2026 -* Workbench is now [**Playground**](https://platform.claude.com/playground) in the Claude Console. Playground supports every Messages API parameter and includes templates that demonstrate API features such as code execution and web search. It shows the full SDK request and the API response for each run, to help you understand the API and build with it. For more, see the [Claude Help Center](https://support.claude.com/en/articles/8606378-how-do-i-use-playground) or try it at [platform.claude.com/playground](https://platform.claude.com/playground). +* Workbench is now [**playground**](https://platform.claude.com/playground) in the Claude Console. Playground supports every Messages API parameter and includes templates that demonstrate API features such as code execution and web search. It shows the full SDK request and the API response for each run, to help you understand the API and build with it. For more, see the [Claude Help Center](https://support.claude.com/en/articles/8606378-how-do-i-use-playground) or try it at [platform.claude.com/playground](https://platform.claude.com/playground). ### August 11, 2026 diff --git a/content/github/anthropic-sdk-python/CHANGELOG.md b/content/github/anthropic-sdk-python/CHANGELOG.md index 194a0507b..d1968ef11 100644 --- a/content/github/anthropic-sdk-python/CHANGELOG.md +++ b/content/github/anthropic-sdk-python/CHANGELOG.md @@ -1,5 +1,35 @@ # Changelog +## 1.1.0 (2026-08-26) + +Full Changelog: [v1.0.0...v1.1.0](https://github.com/anthropics/anthropic-sdk-python/compare/v1.0.0...v1.1.0) + +### Features + +* **api:** add `updates` thinking display mode (beta) ([eb4a73f](https://github.com/anthropics/anthropic-sdk-python/commit/eb4a73fdddc153e1bb4375f7b9e3d45b4bce5c5b)) +* **api:** add missing anthropic-beta values ([dbebd15](https://github.com/anthropics/anthropic-sdk-python/commit/dbebd1515db48f4200105b3a92136a0ba787751e)) +* **api:** add support for Organization API endpoints ([5a5b8fc](https://github.com/anthropics/anthropic-sdk-python/commit/5a5b8fc1eec3f3a494f6a3b08819e0ea06ecc45d)) + + +### Bug Fixes + +* **docs:** correct link for long requests error ([#1884](https://github.com/anthropics/anthropic-sdk-python/issues/1884)) ([4474f31](https://github.com/anthropics/anthropic-sdk-python/commit/4474f31efa48588eff590f04419230791e22419f)), closes [#1883](https://github.com/anthropics/anthropic-sdk-python/issues/1883) +* **tools:** keep the tool runner going on pause_turn ([#343](https://github.com/anthropics/anthropic-sdk-python/issues/343)) ([ab1ec60](https://github.com/anthropics/anthropic-sdk-python/commit/ab1ec609f2cce801644ff4410660deb52680f273)) + + +### Chores + +* **docs:** clarify skill version `latest` support and memory version retention ([a754f3b](https://github.com/anthropics/anthropic-sdk-python/commit/a754f3b53f2040491d6390850e08982d36f19910)) +* **internal:** cancel superseded CI runs ([c061ab1](https://github.com/anthropics/anthropic-sdk-python/commit/c061ab1cf0cf9a7c6519abe1260a2bc0bac4794c)) +* **internal:** minor workflow reformat ([1569002](https://github.com/anthropics/anthropic-sdk-python/commit/1569002594c39349d8a38eaef51c57caaa981485)) +* **internal:** remove the legacy response API ([a48b1dd](https://github.com/anthropics/anthropic-sdk-python/commit/a48b1dde8b3159085c904b9abe252adccf06b47b)) +* **internal:** use `import httpx2` directly instead of aliasing as httpx ([628d789](https://github.com/anthropics/anthropic-sdk-python/commit/628d7891884748b4eef51506543bfd2ef757ba17)) + + +### Documentation + +* **api:** clarify session thread agent and usage.iterations compaction descriptions (beta) ([4ace503](https://github.com/anthropics/anthropic-sdk-python/commit/4ace503320c2af170fefe6be605cf2ddd729594a)) + ## 1.0.0 (2026-08-20) Full Changelog: [v0.125.0...v1.0.0](https://github.com/anthropics/anthropic-sdk-python/compare/v0.125.0...v1.0.0) diff --git a/content/github/anthropic-sdk-python/api.md b/content/github/anthropic-sdk-python/api.md index 962efa4e5..79fdb5560 100644 --- a/content/github/anthropic-sdk-python/api.md +++ b/content/github/anthropic-sdk-python/api.md @@ -1500,3 +1500,269 @@ Methods: - client.beta.tunnels.certificates.retrieve(certificate_id, \*, tunnel_id) -> BetaTunnelCertificate - client.beta.tunnels.certificates.list(tunnel_id, \*\*params) -> SyncPageCursor[BetaTunnelCertificate] - client.beta.tunnels.certificates.archive(certificate_id, \*, tunnel_id) -> BetaTunnelCertificate + +## Organization + +Types: + +```python +from anthropic.types.beta import BetaOrganization, BetaOrganizationRole +``` + +Methods: + +- client.beta.organization.retrieve() -> BetaOrganization + +### APIKeys + +Types: + +```python +from anthropic.types.beta.organization import ( + BetaAPIKey, + BetaAPIKeyCreatedBy, + BetaAPIKeyOrganizationScope, + BetaAPIKeyServiceAccountActor, + BetaAPIKeyUserActor, + BetaAPIKeyWorkspaceScope, +) +``` + +Methods: + +- client.beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey +- client.beta.organization.api_keys.update(api_key_id, \*\*params) -> BetaAPIKey +- client.beta.organization.api_keys.list(\*\*params) -> SyncPage[BetaAPIKey] + +### ExternalKeys + +Types: + +```python +from anthropic.types.beta.organization import ( + BetaAWSExternalKeyConfig, + BetaAzureExternalKeyConfig, + BetaAzureExternalKeyConfigParam, + BetaExternalKey, + BetaExternalKeyAttachedAttachment, + BetaExternalKeyUnattachedAttachment, + BetaGCPExternalKeyConfig, + ExternalKeyDeleteResponse, + ExternalKeyValidateResponse, +) +``` + +Methods: + +- client.beta.organization.external_keys.create(\*\*params) -> BetaExternalKey +- client.beta.organization.external_keys.retrieve(external_key_id) -> BetaExternalKey +- client.beta.organization.external_keys.update(external_key_id, \*\*params) -> BetaExternalKey +- client.beta.organization.external_keys.list(\*\*params) -> SyncPageCursor[BetaExternalKey] +- client.beta.organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse +- client.beta.organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse + +### Federation + +#### Issuers + +Types: + +```python +from anthropic.types.beta.organization.federation import ( + BetaFederationIssuer, + BetaFederationIssuerPollStatus, + BetaJWKSDiscovery, + BetaJWKSExplicitURL, + BetaJWKSInline, +) +``` + +Methods: + +- client.beta.organization.federation.issuers.create(\*\*params) -> BetaFederationIssuer +- client.beta.organization.federation.issuers.retrieve(federation_issuer_id) -> BetaFederationIssuer +- client.beta.organization.federation.issuers.update(federation_issuer_id, \*\*params) -> BetaFederationIssuer +- client.beta.organization.federation.issuers.list(\*\*params) -> SyncPageCursor[BetaFederationIssuer] +- client.beta.organization.federation.issuers.archive(federation_issuer_id) -> BetaFederationIssuer + +#### Rules + +Types: + +```python +from anthropic.types.beta.organization.federation import ( + BetaFederationRule, + BetaFederationRuleMatch, + BetaFederationRuleWorkspace, + BetaServiceAccountTarget, +) +``` + +Methods: + +- client.beta.organization.federation.rules.create(\*\*params) -> BetaFederationRule +- client.beta.organization.federation.rules.retrieve(federation_rule_id) -> BetaFederationRule +- client.beta.organization.federation.rules.update(federation_rule_id, \*\*params) -> BetaFederationRule +- client.beta.organization.federation.rules.list(\*\*params) -> SyncPageCursor[BetaFederationRule] +- client.beta.organization.federation.rules.archive(federation_rule_id) -> BetaFederationRule + +##### Workspaces + +Types: + +```python +from anthropic.types.beta.organization.federation.rules import WorkspaceRemoveResponse +``` + +Methods: + +- client.beta.organization.federation.rules.workspaces.list(federation_rule_id, \*\*params) -> SyncPageCursor[BetaFederationRuleWorkspace] +- client.beta.organization.federation.rules.workspaces.add(federation_rule_id, \*\*params) -> BetaFederationRuleWorkspace +- client.beta.organization.federation.rules.workspaces.remove(workspace_id, \*, federation_rule_id) -> WorkspaceRemoveResponse + +### Invites + +Types: + +```python +from anthropic.types.beta.organization import BetaOrganizationInvite, InviteDeleteResponse +``` + +Methods: + +- client.beta.organization.invites.create(\*\*params) -> BetaOrganizationInvite +- client.beta.organization.invites.retrieve(invite_id) -> BetaOrganizationInvite +- client.beta.organization.invites.list(\*\*params) -> SyncPage[BetaOrganizationInvite] +- client.beta.organization.invites.delete(invite_id) -> InviteDeleteResponse + +### ServiceAccounts + +Types: + +```python +from anthropic.types.beta.organization import BetaServiceAccount, BetaServiceAccountWorkspaceMember +``` + +Methods: + +- client.beta.organization.service_accounts.create(\*\*params) -> BetaServiceAccount +- client.beta.organization.service_accounts.retrieve(service_account_id) -> BetaServiceAccount +- client.beta.organization.service_accounts.update(service_account_id, \*\*params) -> BetaServiceAccount +- client.beta.organization.service_accounts.list(\*\*params) -> SyncPageCursor[BetaServiceAccount] +- client.beta.organization.service_accounts.archive(service_account_id) -> BetaServiceAccount + +#### Workspaces + +Types: + +```python +from anthropic.types.beta.organization.service_accounts import WorkspaceRemoveResponse +``` + +Methods: + +- client.beta.organization.service_accounts.workspaces.list(service_account_id, \*\*params) -> SyncPageCursor[BetaServiceAccountWorkspaceMember] +- client.beta.organization.service_accounts.workspaces.add(service_account_id, \*\*params) -> BetaServiceAccountWorkspaceMember +- client.beta.organization.service_accounts.workspaces.remove(workspace_id, \*, service_account_id) -> WorkspaceRemoveResponse + +### Users + +Types: + +```python +from anthropic.types.beta.organization import BetaOrganizationUser, UserRemoveResponse +``` + +Methods: + +- client.beta.organization.users.retrieve(user_id) -> BetaOrganizationUser +- client.beta.organization.users.update(user_id, \*\*params) -> BetaOrganizationUser +- client.beta.organization.users.list(\*\*params) -> SyncPage[BetaOrganizationUser] +- client.beta.organization.users.remove(user_id) -> UserRemoveResponse + +### Workspaces + +Types: + +```python +from anthropic.types.beta.organization import ( + BetaAllowedInferenceGeo, + BetaDataResidency, + BetaDataResidencyCreateConfig, + BetaDataResidencyUpdateConfig, + BetaNoBillingWorkspaceRole, + BetaWorkspace, + BetaWorkspaceMember, + BetaWorkspaceRole, +) +``` + +Methods: + +- client.beta.organization.workspaces.create(\*\*params) -> BetaWorkspace +- client.beta.organization.workspaces.retrieve(workspace_id) -> BetaWorkspace +- client.beta.organization.workspaces.update(workspace_id, \*\*params) -> BetaWorkspace +- client.beta.organization.workspaces.list(\*\*params) -> SyncPage[BetaWorkspace] +- client.beta.organization.workspaces.archive(workspace_id) -> BetaWorkspace + +#### RateLimits + +Types: + +```python +from anthropic.types.beta.organization.workspaces import ( + BetaWorkspaceRateLimit, + BetaWorkspaceRateLimitValue, +) +``` + +Methods: + +- client.beta.organization.workspaces.rate_limits.list(workspace_id, \*\*params) -> SyncPageCursor[BetaWorkspaceRateLimit] + +#### Members + +Types: + +```python +from anthropic.types.beta.organization.workspaces import MemberRemoveResponse +``` + +Methods: + +- client.beta.organization.workspaces.members.retrieve(user_id, \*, workspace_id) -> BetaWorkspaceMember +- client.beta.organization.workspaces.members.update(user_id, \*, workspace_id, \*\*params) -> BetaWorkspaceMember +- client.beta.organization.workspaces.members.list(workspace_id, \*\*params) -> SyncPage[BetaWorkspaceMember] +- client.beta.organization.workspaces.members.add(workspace_id, \*\*params) -> BetaWorkspaceMember +- client.beta.organization.workspaces.members.remove(user_id, \*, workspace_id) -> MemberRemoveResponse + +#### ServiceAccounts + +Types: + +```python +from anthropic.types.beta.organization.workspaces import ServiceAccountRemoveResponse +``` + +Methods: + +- client.beta.organization.workspaces.service_accounts.retrieve(service_account_id, \*, workspace_id) -> BetaServiceAccountWorkspaceMember +- client.beta.organization.workspaces.service_accounts.update(service_account_id, \*, workspace_id, \*\*params) -> BetaServiceAccountWorkspaceMember +- client.beta.organization.workspaces.service_accounts.list(workspace_id, \*\*params) -> SyncPageCursor[BetaServiceAccountWorkspaceMember] +- client.beta.organization.workspaces.service_accounts.add(workspace_id, \*\*params) -> BetaServiceAccountWorkspaceMember +- client.beta.organization.workspaces.service_accounts.remove(service_account_id, \*, workspace_id) -> ServiceAccountRemoveResponse + +### RateLimits + +Types: + +```python +from anthropic.types.beta.organization import ( + BetaOrganizationRateLimit, + BetaOrganizationRateLimitValue, +) +``` + +Methods: + +- client.beta.organization.rate_limits.list(\*\*params) -> SyncPageCursor[BetaOrganizationRateLimit] diff --git a/content/github/anthropic-sdk-python/tools.md b/content/github/anthropic-sdk-python/tools.md index f4408e403..016280ddd 100644 --- a/content/github/anthropic-sdk-python/tools.md +++ b/content/github/anthropic-sdk-python/tools.md @@ -63,7 +63,7 @@ or you can use our [tool runner](#tool-runner)! ## Tool runner -We provide a `client.beta.messages.tool_runner()` method that can automatically call tools defined with `@beta_tool()`. This method returns a `BetaToolRunner` class that is an iterator where each iteration yields a new `BetaMessage` instance from an API call, iteration will stop when there no tool call content blocks. +We provide a `client.beta.messages.tool_runner()` method that can automatically call tools defined with `@beta_tool()`. This method returns a `BetaToolRunner` class that is an iterator where each iteration yields a new `BetaMessage` instance from an API call. Iteration is driven by each message's `stop_reason`: on `tool_use` the runner executes the requested tools and sends the results back, on `pause_turn` or `compaction` it sends the turn back unchanged so the server can resume it, and on any other stop reason it stops after yielding that final message without running tools. ```py runner = client.beta.messages.tool_runner( diff --git a/content/github/anthropic-sdk-typescript/CHANGELOG.md b/content/github/anthropic-sdk-typescript/CHANGELOG.md index 93739dca5..b7b93b310 100644 --- a/content/github/anthropic-sdk-typescript/CHANGELOG.md +++ b/content/github/anthropic-sdk-typescript/CHANGELOG.md @@ -1,5 +1,38 @@ # Changelog +## 0.121.0 (2026-08-26) + +Full Changelog: [sdk-v0.120.0...sdk-v0.121.0](https://github.com/anthropics/anthropic-sdk-typescript/compare/sdk-v0.120.0...sdk-v0.121.0) + +### Features + +* **api:** add `updates` thinking display mode (beta) ([22274ea](https://github.com/anthropics/anthropic-sdk-typescript/commit/22274eaf968edc62a8b9e1f39a1913f5e04b2ada)) +* **api:** add missing anthropic-beta values ([0779f02](https://github.com/anthropics/anthropic-sdk-typescript/commit/0779f02666cfc6088c1555ee25e8cd8677e421da)) +* **api:** add support for Organization API endpoints ([8b61e7a](https://github.com/anthropics/anthropic-sdk-typescript/commit/8b61e7a4d441d662cd121c94c6d27dbffa5c294a)) +* **helpers:** support Standard Schema for structured outputs and tools ([7880078](https://github.com/anthropics/anthropic-sdk-typescript/commit/788007889c048e18f6bdf19d4903f1ac96f66cb0)) + + +### Bug Fixes + +* **tools:** keep the tool runner going on pause_turn ([#288](https://github.com/anthropics/anthropic-sdk-typescript/issues/288)) ([f040dc9](https://github.com/anthropics/anthropic-sdk-typescript/commit/f040dc9d39a3ec471a87ac8eb93387fb7d9960c3)) +* **types:** don't reference NodeJS.ProcessEnv from published types ([#367](https://github.com/anthropics/anthropic-sdk-typescript/issues/367)) ([fd38dfd](https://github.com/anthropics/anthropic-sdk-typescript/commit/fd38dfdc48beec5d0d3640b65ac3e467bc73ea4e)) + + +### Chores + +* **docs:** clarify skill version `latest` support and memory version retention ([7405a69](https://github.com/anthropics/anthropic-sdk-typescript/commit/7405a692be3ab6728037223482337f640cfa00b9)) +* **examples:** remove redundant main().catch boilerplate ([154ace7](https://github.com/anthropics/anthropic-sdk-typescript/commit/154ace7ea8ccd66d59b3a7d2ca61dcff82b39417)) +* **internal:** cancel superseded CI runs ([0532c98](https://github.com/anthropics/anthropic-sdk-typescript/commit/0532c9878433dd93cc1b7b34c8a895f2a80aeb2c)) +* **internal:** codegen related update ([228ff1e](https://github.com/anthropics/anthropic-sdk-typescript/commit/228ff1e5fa09fe6d6e1cca2cb876d2fa29d431b6)) +* **internal:** minor workflow reformat ([41b6c31](https://github.com/anthropics/anthropic-sdk-typescript/commit/41b6c3190f4c4196817e9102fac1f9fca674452e)) +* **internal:** tighten publint and attw lint checks ([e3fbd62](https://github.com/anthropics/anthropic-sdk-typescript/commit/e3fbd62677554699b51498179fe15feb73f1f24e)) + + +### Documentation + +* **api:** clarify session thread agent and usage.iterations compaction descriptions (beta) ([6e852a7](https://github.com/anthropics/anthropic-sdk-typescript/commit/6e852a70ee5db1d514e9459ac627324bfe6c904f)) +* **examples:** use adaptive thinking in thinking examples ([3dd7699](https://github.com/anthropics/anthropic-sdk-typescript/commit/3dd7699110fd34b82b795841e76ac40122a63c7d)) + ## 0.120.0 (2026-08-19) Full Changelog: [sdk-v0.119.0...sdk-v0.120.0](https://github.com/anthropics/anthropic-sdk-typescript/compare/sdk-v0.119.0...sdk-v0.120.0) diff --git a/content/github/anthropic-sdk-typescript/api.md b/content/github/anthropic-sdk-typescript/api.md index f987615d2..31abaca53 100644 --- a/content/github/anthropic-sdk-typescript/api.md +++ b/content/github/anthropic-sdk-typescript/api.md @@ -1406,3 +1406,229 @@ Methods: - client.beta.tunnels.certificates.retrieve(certificateID, { ...params }) -> BetaTunnelCertificate - client.beta.tunnels.certificates.list(tunnelID, { ...params }) -> BetaTunnelCertificatesPageCursor - client.beta.tunnels.certificates.archive(certificateID, { ...params }) -> BetaTunnelCertificate + +## Organization + +Types: + +- BetaOrganization +- BetaOrganizationRole + +Methods: + +- client.beta.organization.retrieve() -> BetaOrganization + +### APIKeys + +Types: + +- BetaAPIKey +- BetaAPIKeyCreatedBy +- BetaAPIKeyOrganizationScope +- BetaAPIKeyServiceAccountActor +- BetaAPIKeyUserActor +- BetaAPIKeyWorkspaceScope + +Methods: + +- client.beta.organization.apiKeys.retrieve(apiKeyID) -> BetaAPIKey +- client.beta.organization.apiKeys.update(apiKeyID, { ...params }) -> BetaAPIKey +- client.beta.organization.apiKeys.list({ ...params }) -> BetaAPIKeysPage + +### ExternalKeys + +Types: + +- BetaAWSExternalKeyConfig +- BetaAzureExternalKeyConfig +- BetaAzureExternalKeyConfigParam +- BetaExternalKey +- BetaExternalKeyAttachedAttachment +- BetaExternalKeyUnattachedAttachment +- BetaGCPExternalKeyConfig +- ExternalKeyDeleteResponse +- ExternalKeyValidateResponse + +Methods: + +- client.beta.organization.externalKeys.create({ ...params }) -> BetaExternalKey +- client.beta.organization.externalKeys.retrieve(externalKeyID) -> BetaExternalKey +- client.beta.organization.externalKeys.update(externalKeyID, { ...params }) -> BetaExternalKey +- client.beta.organization.externalKeys.list({ ...params }) -> BetaExternalKeysPageCursor +- client.beta.organization.externalKeys.delete(externalKeyID) -> ExternalKeyDeleteResponse +- client.beta.organization.externalKeys.validate(externalKeyID) -> ExternalKeyValidateResponse + +### Federation + +#### Issuers + +Types: + +- BetaFederationIssuer +- BetaFederationIssuerPollStatus +- BetaJWKSDiscovery +- BetaJWKSExplicitURL +- BetaJWKSInline + +Methods: + +- client.beta.organization.federation.issuers.create({ ...params }) -> BetaFederationIssuer +- client.beta.organization.federation.issuers.retrieve(federationIssuerID, { ...params }) -> BetaFederationIssuer +- client.beta.organization.federation.issuers.update(federationIssuerID, { ...params }) -> BetaFederationIssuer +- client.beta.organization.federation.issuers.list({ ...params }) -> BetaFederationIssuersPageCursor +- client.beta.organization.federation.issuers.archive(federationIssuerID, { ...params }) -> BetaFederationIssuer + +#### Rules + +Types: + +- BetaFederationRule +- BetaFederationRuleMatch +- BetaFederationRuleWorkspace +- BetaServiceAccountTarget + +Methods: + +- client.beta.organization.federation.rules.create({ ...params }) -> BetaFederationRule +- client.beta.organization.federation.rules.retrieve(federationRuleID, { ...params }) -> BetaFederationRule +- client.beta.organization.federation.rules.update(federationRuleID, { ...params }) -> BetaFederationRule +- client.beta.organization.federation.rules.list({ ...params }) -> BetaFederationRulesPageCursor +- client.beta.organization.federation.rules.archive(federationRuleID, { ...params }) -> BetaFederationRule + +##### Workspaces + +Types: + +- WorkspaceRemoveResponse + +Methods: + +- client.beta.organization.federation.rules.workspaces.list(federationRuleID, { ...params }) -> BetaFederationRuleWorkspacesPageCursor +- client.beta.organization.federation.rules.workspaces.add(federationRuleID, { ...params }) -> BetaFederationRuleWorkspace +- client.beta.organization.federation.rules.workspaces.remove(workspaceID, { ...params }) -> WorkspaceRemoveResponse + +### Invites + +Types: + +- BetaOrganizationInvite +- InviteDeleteResponse + +Methods: + +- client.beta.organization.invites.create({ ...params }) -> BetaOrganizationInvite +- client.beta.organization.invites.retrieve(inviteID) -> BetaOrganizationInvite +- client.beta.organization.invites.list({ ...params }) -> BetaOrganizationInvitesPage +- client.beta.organization.invites.delete(inviteID) -> InviteDeleteResponse + +### ServiceAccounts + +Types: + +- BetaServiceAccount +- BetaServiceAccountWorkspaceMember + +Methods: + +- client.beta.organization.serviceAccounts.create({ ...params }) -> BetaServiceAccount +- client.beta.organization.serviceAccounts.retrieve(serviceAccountID, { ...params }) -> BetaServiceAccount +- client.beta.organization.serviceAccounts.update(serviceAccountID, { ...params }) -> BetaServiceAccount +- client.beta.organization.serviceAccounts.list({ ...params }) -> BetaServiceAccountsPageCursor +- client.beta.organization.serviceAccounts.archive(serviceAccountID, { ...params }) -> BetaServiceAccount + +#### Workspaces + +Types: + +- WorkspaceRemoveResponse + +Methods: + +- client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMembersPageCursor +- client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMember +- client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, { ...params }) -> WorkspaceRemoveResponse + +### Users + +Types: + +- BetaOrganizationUser +- UserRemoveResponse + +Methods: + +- client.beta.organization.users.retrieve(userID) -> BetaOrganizationUser +- client.beta.organization.users.update(userID, { ...params }) -> BetaOrganizationUser +- client.beta.organization.users.list({ ...params }) -> BetaOrganizationUsersPage +- client.beta.organization.users.remove(userID) -> UserRemoveResponse + +### Workspaces + +Types: + +- BetaAllowedInferenceGeo +- BetaDataResidency +- BetaDataResidencyCreateConfig +- BetaDataResidencyUpdateConfig +- BetaNoBillingWorkspaceRole +- BetaWorkspace +- BetaWorkspaceMember +- BetaWorkspaceRole + +Methods: + +- client.beta.organization.workspaces.create({ ...params }) -> BetaWorkspace +- client.beta.organization.workspaces.retrieve(workspaceID) -> BetaWorkspace +- client.beta.organization.workspaces.update(workspaceID, { ...params }) -> BetaWorkspace +- client.beta.organization.workspaces.list({ ...params }) -> BetaWorkspacesPage +- client.beta.organization.workspaces.archive(workspaceID) -> BetaWorkspace + +#### RateLimits + +Types: + +- BetaWorkspaceRateLimit +- BetaWorkspaceRateLimitValue + +Methods: + +- client.beta.organization.workspaces.rateLimits.list(workspaceID, { ...params }) -> BetaWorkspaceRateLimitsPageCursor + +#### Members + +Types: + +- MemberRemoveResponse + +Methods: + +- client.beta.organization.workspaces.members.retrieve(userID, { ...params }) -> BetaWorkspaceMember +- client.beta.organization.workspaces.members.update(userID, { ...params }) -> BetaWorkspaceMember +- client.beta.organization.workspaces.members.list(workspaceID, { ...params }) -> BetaWorkspaceMembersPage +- client.beta.organization.workspaces.members.add(workspaceID, { ...params }) -> BetaWorkspaceMember +- client.beta.organization.workspaces.members.remove(userID, { ...params }) -> MemberRemoveResponse + +#### ServiceAccounts + +Types: + +- ServiceAccountRemoveResponse + +Methods: + +- client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMember +- client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, { ...params }) -> BetaServiceAccountWorkspaceMember +- client.beta.organization.workspaces.serviceAccounts.list(workspaceID, { ...params }) -> BetaServiceAccountWorkspaceMembersPageCursor +- client.beta.organization.workspaces.serviceAccounts.add(workspaceID, { ...params }) -> BetaServiceAccountWorkspaceMember +- client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, { ...params }) -> ServiceAccountRemoveResponse + +### RateLimits + +Types: + +- BetaOrganizationRateLimit +- BetaOrganizationRateLimitValue + +Methods: + +- client.beta.organization.rateLimits.list({ ...params }) -> BetaOrganizationRateLimitsPageCursor diff --git a/content/github/anthropic-sdk-typescript/ecosystem-tests/README.md b/content/github/anthropic-sdk-typescript/ecosystem-tests/README.md new file mode 100644 index 000000000..b3dd6f66a --- /dev/null +++ b/content/github/anthropic-sdk-typescript/ecosystem-tests/README.md @@ -0,0 +1,42 @@ +# Ecosystem tests + +These tests install the SDK from an `npm pack` tarball into small projects and run them against a local mock server (`mock-server.mjs`). +This checks what users actually get across runtimes, module systems, TypeScript configs, package managers and bundlers. + +```sh +pnpm test:ecosystem # build, pack and run every project +pnpm test:ecosystem node-ts-esm 'browser-*' # run projects by name or glob +pnpm test:ecosystem --list # list projects and known failures +pnpm test:ecosystem --skip-build --skip-pack # reuse .pack/anthropic-ai-sdk.tgz +pnpm test:ecosystem --node-versions 20,22,24 # run the Node projects once per installed Node major +``` + +`--keep` keeps the temp copies (failed projects are always kept) and `--jobs N` runs projects in parallel. +`--node-versions` finds each major where actions/setup-node, nvm, fnm or volta install it, or in `$ECOSYSTEM_NODE_` (a bin directory). +CI runs these tests from `.github/workflows/ecosystem-tests.yml`. + +## Shared test cases + +`shared/cases.ts` holds the SDK calls every project runs (they throw on failure and use only web-standard globals) and `shared/type-tests.ts` the `@ts-expect-error` checks every project compiles; a project's own files just register the cases with its test runner or harness and add what is specific to that project (module resolution, runtime-specific uploads, extra compiler flags). +The runner copies `shared/` into each project's temp copy as `./shared/`; it is git-ignored inside project directories, so copy or symlink it there to work on a project in place. + +## Adding a project + +Create `ecosystem-tests//project.json` with these fields (the runner picks up any directory that has one): + +- `description`: what the project covers. +- `steps`: commands (argv arrays) to run in order after install. +- `packageManager`: `npm`, `pnpm`, `yarn` or `bun`. This decides the install command. +- `requires`: binaries that must be on `PATH`, for example `["deno"]`. If one is missing the project is skipped, unless it was named on the command line. +- `minNodeVersion`: optional. The project is skipped on older Node versions. +- `perNodeVersion`: optional. With `--node-versions`, run the project once per listed major instead of once under the current `node`. +- `knownFailure`: optional. Why the project currently fails because of an SDK bug. A failing step then reports `XFAIL` instead of failing the run (a failing install still fails it), and `XPASS` (which fails the run) once it passes, so the field gets removed. Put the failing step last so the other steps still run. + +Pin every dependency to an exact version and commit the lockfile. +Do not list `@anthropic-ai/sdk` in `package.json`: the runner does a frozen install from the lockfile and then adds `../.pack/anthropic-ai-sdk.tgz` on top, so the lockfile never pins a previous build of the SDK. +Neither install step runs dependency lifecycle scripts (`--ignore-scripts` and its equivalents), so a project cannot rely on a `postinstall`; prebuilt binaries that ship as `optionalDependencies` (esbuild, workerd, rolldown) still work. +Type-check with `skipLibCheck: false` so the published types are checked too. +Steps get `ANTHROPIC_BASE_URL` (the mock server) and `ANTHROPIC_API_KEY` in their environment, so `new Anthropic()` needs no options. +Import the cases from `./shared/cases` (see above) and add the project's `shared` directory to its tsconfig `include` so `shared/type-tests.ts` is checked too. +The mock server answers a request the SDK built incorrectly with a 4xx whose message starts with `mock:`, so the test fails at the call that sent it. +Each project runs from a temp copy next to a copy of `.pack/`, so nothing resolves from the repo's `node_modules`. diff --git a/content/github/anthropic-sdk-typescript/helpers.md b/content/github/anthropic-sdk-typescript/helpers.md index 98b8fda29..e02f5501c 100644 --- a/content/github/anthropic-sdk-typescript/helpers.md +++ b/content/github/anthropic-sdk-typescript/helpers.md @@ -101,7 +101,7 @@ The underlying `AbortController` for the runner. ## Structured Outputs -The SDK provides helpers for parsing structured JSON outputs from Claude using JSON Schema or Zod validation. +The SDK provides helpers for parsing structured JSON outputs from Claude using JSON Schema, Zod, or any library implementing [Standard Schema](https://standardschema.dev). ### Usage with Zod @@ -128,6 +128,38 @@ const message = await client.messages.parse({ console.log(message.parsed_output?.primes); // [2, 3, 5] ``` +### Usage with Standard Schema (Valibot, ArkType, ...) + +Standard Schema support is currently available under the beta namespace (`@anthropic-ai/sdk/helpers/beta/standard-schema` with `client.beta.messages.parse()`). + +```ts +import { betaStandardSchemaOutputFormat } from '@anthropic-ai/sdk/helpers/beta/standard-schema'; +import Anthropic from '@anthropic-ai/sdk'; +import * as v from 'valibot'; +import { toStandardJsonSchema } from '@valibot/to-json-schema'; + +const client = new Anthropic(); + +const NumbersResponse = toStandardJsonSchema( + v.object({ + primes: v.array(v.number()), + }), +); + +const message = await client.beta.messages.parse({ + model: 'claude-sonnet-5', + max_tokens: 1024, + messages: [{ role: 'user', content: 'What are the first 3 prime numbers?' }], + output_config: { + format: betaStandardSchemaOutputFormat(NumbersResponse), + }, +}); + +console.log(message.parsed_output?.primes); // [2, 3, 5] +``` + +The JSON schema sent to the API is derived from the schema's `~standard.jsonSchema` (Standard JSON Schema) interface. For libraries or versions that don't implement it, pass the `jsonSchema` option explicitly. + ### Usage with JSON Schema ```ts @@ -160,6 +192,12 @@ console.log(message.parsed_output?.primes); // [2, 3, 5] Creates a JSON schema output format from a Zod schema. The response will be validated and parsed using Zod. +### `betaStandardSchemaOutputFormat(schema, options?)` + +Creates a JSON schema output format from a [Standard Schema](https://standardschema.dev). The response will be validated and parsed using the schema's (synchronous) `~standard.validate`. Options: + +- `jsonSchema?: Record` - The JSON schema to send to the API, instead of deriving it from `~standard.jsonSchema` + ### `jsonSchemaOutputFormat(schema, options?)` Creates a JSON schema output format from a raw JSON schema. Options: @@ -171,13 +209,14 @@ Creates a JSON schema output format from a raw JSON schema. Options: See the following example files: - [`examples/structured-outputs-zod.ts`](examples/structured-outputs-zod.ts) +- [`examples/structured-outputs-standard-schema.ts`](examples/structured-outputs-standard-schema.ts) - [`examples/structured-outputs-json-schema.ts`](examples/structured-outputs-json-schema.ts) - [`examples/structured-outputs-streaming.ts`](examples/structured-outputs-streaming.ts) - [`examples/structured-outputs-raw.ts`](examples/structured-outputs-raw.ts) ## Tool Helpers -The SDK provides helper functions to create runnable tools that can be automatically invoked by the `.toolRunner()` method. These helpers simplify tool creation with JSON Schema or Zod validation. +The SDK provides helper functions to create runnable tools that can be automatically invoked by the `.toolRunner()` method. These helpers simplify tool creation with JSON Schema, Zod, or [Standard Schema](https://standardschema.dev) validation. ### Usage @@ -318,6 +357,32 @@ const weatherTool = betaZodTool({ }); ``` +### `betaStandardSchemaTool` + +Any schema library implementing [Standard Schema](https://standardschema.dev) (Valibot, ArkType, Zod, Effect Schema, ...) can be used to define the input schema for your tools: + +```ts +import { betaStandardSchemaTool } from '@anthropic-ai/sdk/helpers/beta/standard-schema'; +import * as v from 'valibot'; +import { toStandardJsonSchema } from '@valibot/to-json-schema'; + +const weatherTool = betaStandardSchemaTool({ + name: 'get_weather', + inputSchema: toStandardJsonSchema( + v.object({ + location: v.pipe(v.string(), v.description('The city and state, e.g. San Francisco, CA')), + unit: v.optional(v.picklist(['celsius', 'fahrenheit']), 'fahrenheit'), + }), + ), + description: 'Get the current weather in a given location', + run: async (input) => { + return `The weather in ${input.location} is ${input.unit === 'celsius' ? '22°C' : '72°F'}`; + }, +}); +``` + +As with `betaStandardSchemaOutputFormat`, pass the `jsonSchema` option if the schema doesn't implement `~standard.jsonSchema`. + ### `betaTool` You can use JSON Schema to define the input schema for your tools. `betaTool` will infer the type of `input` for you @@ -503,6 +568,7 @@ throw new ToolError('Invalid input: URL must start with https://'); See the following example files for more usage patterns: - [`examples/tools-helpers-zod.ts`](examples/tools-helpers-zod.ts) - Zod-based tools +- [`examples/tools-helpers-standard-schema.ts`](examples/tools-helpers-standard-schema.ts) - Standard Schema (Valibot) tools - [`examples/tools-helpers-json-schema.ts`](examples/tools-helpers-json-schema.ts) - JSON Schema tools - [`examples/tools.ts`](examples/tools.ts) - Basic tool usage diff --git a/content/github/anthropic-sdk-typescript/packages/bedrock-sdk/CHANGELOG.md b/content/github/anthropic-sdk-typescript/packages/bedrock-sdk/CHANGELOG.md index 97de70cbb..9ae1b0176 100644 --- a/content/github/anthropic-sdk-typescript/packages/bedrock-sdk/CHANGELOG.md +++ b/content/github/anthropic-sdk-typescript/packages/bedrock-sdk/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.33.2 (2026-08-26) + +Full Changelog: [bedrock-sdk-v0.33.1...bedrock-sdk-v0.33.2](https://github.com/anthropics/anthropic-sdk-typescript/compare/bedrock-sdk-v0.33.1...bedrock-sdk-v0.33.2) + +### Bug Fixes + +* **bedrock:** never send ambient first-party credentials to the Mantle endpoint ([#357](https://github.com/anthropics/anthropic-sdk-typescript/issues/357)) ([a2b5737](https://github.com/anthropics/anthropic-sdk-typescript/commit/a2b5737170b31e75e01c7a0b6302374e09da8e3e)) + ## 0.33.1 (2026-08-19) Full Changelog: [bedrock-sdk-v0.33.0...bedrock-sdk-v0.33.1](https://github.com/anthropics/anthropic-sdk-typescript/compare/bedrock-sdk-v0.33.0...bedrock-sdk-v0.33.1) diff --git a/content/github/anthropic-sdk-typescript/packages/google-cloud-sdk/CHANGELOG.md b/content/github/anthropic-sdk-typescript/packages/google-cloud-sdk/CHANGELOG.md index 201353ed1..ca05e38dd 100644 --- a/content/github/anthropic-sdk-typescript/packages/google-cloud-sdk/CHANGELOG.md +++ b/content/github/anthropic-sdk-typescript/packages/google-cloud-sdk/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.0.11 (2026-08-26) + +Full Changelog: [google-cloud-sdk-v0.0.10...google-cloud-sdk-v0.0.11](https://github.com/anthropics/anthropic-sdk-typescript/compare/google-cloud-sdk-v0.0.10...google-cloud-sdk-v0.0.11) + +### Chores + +* **examples:** remove redundant main().catch boilerplate ([154ace7](https://github.com/anthropics/anthropic-sdk-typescript/commit/154ace7ea8ccd66d59b3a7d2ca61dcff82b39417)) + ## 0.0.10 (2026-08-19) Full Changelog: [google-cloud-sdk-v0.0.9...google-cloud-sdk-v0.0.10](https://github.com/anthropics/anthropic-sdk-typescript/compare/google-cloud-sdk-v0.0.9...google-cloud-sdk-v0.0.10) diff --git a/content/github/anthropic-sdk-typescript/packages/vertex-sdk/CHANGELOG.md b/content/github/anthropic-sdk-typescript/packages/vertex-sdk/CHANGELOG.md index 76f4b6fe5..7fae51795 100644 --- a/content/github/anthropic-sdk-typescript/packages/vertex-sdk/CHANGELOG.md +++ b/content/github/anthropic-sdk-typescript/packages/vertex-sdk/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.19.6 (2026-08-26) + +Full Changelog: [vertex-sdk-v0.19.5...vertex-sdk-v0.19.6](https://github.com/anthropics/anthropic-sdk-typescript/compare/vertex-sdk-v0.19.5...vertex-sdk-v0.19.6) + +### Chores + +* **examples:** remove redundant main().catch boilerplate ([154ace7](https://github.com/anthropics/anthropic-sdk-typescript/commit/154ace7ea8ccd66d59b3a7d2ca61dcff82b39417)) + ## 0.19.5 (2026-08-19) Full Changelog: [vertex-sdk-v0.19.4...vertex-sdk-v0.19.5](https://github.com/anthropics/anthropic-sdk-typescript/compare/vertex-sdk-v0.19.4...vertex-sdk-v0.19.5) diff --git a/content/support/10310342-how-do-i-log-out-of-all-active-sessions.md b/content/support/10310342-how-do-i-log-out-of-all-active-sessions.md index 4c786f957..68f6f19cd 100644 --- a/content/support/10310342-how-do-i-log-out-of-all-active-sessions.md +++ b/content/support/10310342-how-do-i-log-out-of-all-active-sessions.md @@ -38,7 +38,7 @@ To regain access to your account on any device, you'll need to authenticate agai If you used your Claude account to authenticate into Claude Code, you can manage your authorization tokens by navigating to **[Settings > Claude Code](https://claude.ai/settings/claude-code)**. To remove a token and log out of Claude Code, click the trash can icon. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1608263923/b4fa7d6f6f08f2adffb4ea63bc58/image+%287%29.png?expires=1787744700&signature=2d8bab58ff0e6d21dbcd234a0d1694e29890b8d0f4a663a772c1461aa9b4d562&req=dSYnHst4nohdWvMW1HO4zVuHihv60mO8AQofdwM8qVcGIaLUa6CImbVuYDbS%0AXYn%2BObENVZBD%2FHfgFbg%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1608263923/b4fa7d6f6f08f2adffb4ea63bc58/image+%287%29.png?expires=1787829300&signature=cca1f1847e55da4a74d649e04845c7446fce56eb5171e036ec6cd1bdb876213d&req=dSYnHst4nohdWvMW1HO4zVuHihv11G64AQofdwM8qVfJ%2BOmVkV9sN7CwktAW%0AJsHG7865nmmLJQ1h3Nk%3D%0A) ## Unable to access your account? diff --git a/content/support/10366376-how-can-i-delete-my-claude-console-account.md b/content/support/10366376-how-can-i-delete-my-claude-console-account.md index 737f071c8..5dc38bb4a 100644 --- a/content/support/10366376-how-can-i-delete-my-claude-console-account.md +++ b/content/support/10366376-how-can-i-delete-my-claude-console-account.md @@ -36,7 +36,7 @@ If you followed the steps above to delete your Console organization but want to If you have an outstanding balance, you will see a message during the deletion flow that prompts you to pay the balance first by routing you to [Settings > Billing](https://platform.claude.com/settings/billing). -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1973957766/5c2dd87c0818a0400099a833c9b3/4cc3130a-f696-4967-9fe3-e5623c6f02bd?expires=1787744700&signature=479ff5fe53c85193e28b0178427b1046cf26bfd1e4acd628d87c465c26e4fd12&req=dSkgFcB7moZZX%2FMW1HO4zbYXUBBlWOAcFZRyvJPpBZ%2BPAa1AGfRSDYrXpEev%0AHSntgctto1iajRMO%2FVw%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1973957766/5c2dd87c0818a0400099a833c9b3/4cc3130a-f696-4967-9fe3-e5623c6f02bd?expires=1787829300&signature=ceda5e35163f320f2ad4be8091ed49becff0b0340e77dc14654b83d916bd7fc5&req=dSkgFcB7moZZX%2FMW1HO4zbYXUBBqXu0YFZRyvJPpBZ97HtbscJzFs0%2BTizND%0AnQD4Ik7s%2Fb73BZHiBCc%3D%0A) You must pay this outstanding balance before you’re able to move forward with the deletion process. @@ -44,6 +44,6 @@ You must pay this outstanding balance before you’re able to move forward with There are some scenarios where you will need to contact our team to delete your account. If this is the case, it will be noted when you try to delete your organization: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1973957765/19dda72a40db95d78c00c27a1a1c/6ce89be6-93ce-409c-bbea-d34be09db348?expires=1787744700&signature=ed8c6d0c99aa92c6781bcdce36e26130e073f9f2c0df6cae9ed199634dad5dc1&req=dSkgFcB7moZZXPMW1HO4zRW12%2BLKfKD%2BZxDZGlqR6GjyqEKIyvYZPNqxerTv%0A5Wfy%2F7JaNTsau9MGJpA%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1973957765/19dda72a40db95d78c00c27a1a1c/6ce89be6-93ce-409c-bbea-d34be09db348?expires=1787829300&signature=1b0815e2356ae12fa698189d97e48b4398b0a3503ecb08969a5edc40e3fd99fe&req=dSkgFcB7moZZXPMW1HO4zRW12%2BLFeq36ZxDZGlqR6GhquEehYGdCiOpDp2Z1%0AyGllduEgQ6R2aGLQrOI%3D%0A) If you are seeing this message, this indicates that your Console organization cannot be deleted via the self-service pathway. \ No newline at end of file diff --git a/content/support/10504844-manage-user-feedback-settings-on-team-and-enterprise-plans.md b/content/support/10504844-manage-user-feedback-settings-on-team-and-enterprise-plans.md index f9baa1da4..404cc4d81 100644 --- a/content/support/10504844-manage-user-feedback-settings-on-team-and-enterprise-plans.md +++ b/content/support/10504844-manage-user-feedback-settings-on-team-and-enterprise-plans.md @@ -6,6 +6,6 @@ As a Primary Owner or Owner of a Team or Enterprise plan, you can manage the abi 2. Use the toggle to change the **Rate chats** setting for your organization: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2058292603/75752add0bed6a9f3ab217f01708/CleanShot%2B2026-02-12%2Bat%2B08_55_14-402x.png?expires=1787744700&signature=fc190e75172d8250fd1110d4df777e548c869722ed2ace7023690895c172a57f&req=diAiHst3n4dfWvMW1HO4zYGm8iAbFKzL085gFtEpvcSpRNpFmMn%2BtoSPQMo7%0AwVgefbH3qthZ4QFvLMA%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2058292603/75752add0bed6a9f3ab217f01708/CleanShot%2B2026-02-12%2Bat%2B08_55_14-402x.png?expires=1787829300&signature=5dd8a934827d64423997c59d959a38613171bd7817da4e810ee083441f39cce4&req=diAiHst3n4dfWvMW1HO4zYGm8iAUEqHP085gFtEpvcRL1rBjw0LwERjBkBiZ%0AA26KWjbg3gKKg69i2Bg%3D%0A) More information on how Anthropic collects, uses, and stores feedback data can be found in our Privacy Center: **[How long do you store my organization’s data?](https://privacy.claude.com/en/articles/7996866-how-long-do-you-store-my-organization-s-data)** \ No newline at end of file diff --git a/content/support/10504853-manage-user-feedback-settings-on-claude-console.md b/content/support/10504853-manage-user-feedback-settings-on-claude-console.md index 6de495f25..16cf5222e 100644 --- a/content/support/10504853-manage-user-feedback-settings-on-claude-console.md +++ b/content/support/10504853-manage-user-feedback-settings-on-claude-console.md @@ -8,6 +8,6 @@ To manage feedback for your Console organization: 2. Toggle the feedback switch on or off. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1729186182/ebf4032a12a8c56959ca927726ce/Screenshot+2025-09-16+at+12_32_31%E2%80%AFPM.png?expires=1787744700&signature=8f8d64a475545689cdfe2613b920af4212c019cdfd7e6d73f956a63d387ca829&req=dSclH8h2m4BXW%2FMW1HO4zVpN5HAaXWxCJ%2FadMup7FQcW%2BVC1L4YadI67GpBY%0AU%2F%2BumbJfuESOw9XZhic%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1729186182/ebf4032a12a8c56959ca927726ce/Screenshot+2025-09-16+at+12_32_31%E2%80%AFPM.png?expires=1787829300&signature=b0e06d330d0122c693b6c2e4c0186b1f1a33460354ab65ca492c83514443dbf8&req=dSclH8h2m4BXW%2FMW1HO4zVpN5HAVW2FGJ%2FadMup7FQeuehLn4oKmnSibM4In%0AGzNeMohF34DoDEpsifw%3D%0A) More information on how Anthropic collects, uses, and stores feedback data can be found in our Privacy Center: [How long do you store my organization’s data?](https://privacy.claude.com/en/articles/7996866-how-long-do-you-store-my-organization-s-data) \ No newline at end of file diff --git a/content/support/10593882-share-and-unshare-chats.md b/content/support/10593882-share-and-unshare-chats.md index 7403b9253..de34010b3 100644 --- a/content/support/10593882-share-and-unshare-chats.md +++ b/content/support/10593882-share-and-unshare-chats.md @@ -38,12 +38,12 @@ To unshare a chat: Users on free, Pro, or Max plans can review a log of shared chats by navigating to **[Settings > Privacy](https://claude.ai/settings/data-privacy-controls)**. Find the **Privacy settings** section and click “Manage” next to **Shared chats:** -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1921669913/7cc7be48cfc7a18f9f469d6cd83c/CleanShot+2026-01-08+at+10_20_43%402x.png?expires=1787744700&signature=eb1246c0898f4ba574441b4074ae961ee9d8f01dbee1099026decd01a14e48a5&req=dSklF894lIheWvMW1HO4zWn5HzQaZkFsc9cNIYuX0GFhBxOIuAt%2F5njd2SF%2F%0AylJ4lPxqXznGHI7ADhk%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1921669913/7cc7be48cfc7a18f9f469d6cd83c/CleanShot+2026-01-08+at+10_20_43%402x.png?expires=1787829300&signature=30fd60b208bb1660e63fa364d6441d2fa3958ac2f6dd4967b1c719f41f5144d4&req=dSklF894lIheWvMW1HO4zWn5HzQVYExoc9cNIYuX0GFKZ%2FRH%2FsfB6Qg%2By%2FYF%0AhmEL8hWEUKkykMAgA%2Bs%3D%0A) This will open a **Shared chats** modal listing the title, date shared, and link to each chat, allowing you to easily review and access all your previously-shared content. From here, you also have the option to click “Unshare” next to each listed chat to revoke access to the last snapshot you shared: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1624243810/e6fe1d262597446c7fe21dff9f10/AD_4nXdW-GhByF8uKV7fCq9lTbkVB91FglSL6TSyXAOUk_MLcTV9YsEMBMkm9rgm1oXqv0k3sJh1JhlzZP6tHVkKbDJJ71pDRRtM3aVNG64MDuKDIzgmknh-XDZdNa7biTsTdwGoPr5GRg?expires=1787744700&signature=45919da3e90fc88ff14f425ce2ffe46d4f1517a77fa3ebbeec2a78b6bcf3a4e2&req=dSYlEst6noleWfMW1HO4ze44eCBmkBY5guvTv9woD7arjYklEFwAfWt6%2FJX2%0A2a0JruPcTwj1dNdJ4eA%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1624243810/e6fe1d262597446c7fe21dff9f10/AD_4nXdW-GhByF8uKV7fCq9lTbkVB91FglSL6TSyXAOUk_MLcTV9YsEMBMkm9rgm1oXqv0k3sJh1JhlzZP6tHVkKbDJJ71pDRRtM3aVNG64MDuKDIzgmknh-XDZdNa7biTsTdwGoPr5GRg?expires=1787829300&signature=0201e1345b567d75380f1c2c87634d2f72ee18d75da75e51ac033a5e3745b0b9&req=dSYlEst6noleWfMW1HO4ze44eCBplhs9guvTv9woD7aOUhst%2FdrA9RR4WsUR%0Aulm0aBEgSk%2BoTloqBxM%3D%0A) If you don’t have any shared chat snapshots, the **Shared chats** modal will show “No shared content found”: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1624243808/b025db8e598f0c88fb16d83d48d5/AD_4nXeUwCKnmFzzrjMHhfr5By4zk5pJlkEn3wbJ8-aNfu13Yl99IjBywpqPx9G07QRzpH1EwRY7uG7Q9m9fib98Gql1cIV7XwUCTzEgBNu79Ey8tCOS5CEVmwveIcEOxJ4fonBhe3g9MA?expires=1787744700&signature=357266318607c9ee978ad56c9f36abec683bfe81fb15f7ff4ba5b13f43b3438c&req=dSYlEst6nolfUfMW1HO4zdaFncJzhY22DeZsm0Gz1Hurl0woAwQcsq9Q1fv%2B%0A2X%2FmGZbwqun0Ja%2BYFJ0%3D%0A) \ No newline at end of file +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1624243808/b025db8e598f0c88fb16d83d48d5/AD_4nXeUwCKnmFzzrjMHhfr5By4zk5pJlkEn3wbJ8-aNfu13Yl99IjBywpqPx9G07QRzpH1EwRY7uG7Q9m9fib98Gql1cIV7XwUCTzEgBNu79Ey8tCOS5CEVmwveIcEOxJ4fonBhe3g9MA?expires=1787829300&signature=d15331cd5fe7e75ca2efc6add2ac38d56290600dc66bcd5fd1f67e849a09faf0&req=dSYlEst6nolfUfMW1HO4zdaFncJ8g4CyDeZsm0Gz1HtAQLxKOUrKE1lEsUpG%0AJJSiz%2B%2F6bHEYfz2IbbY%3D%0A) \ No newline at end of file diff --git a/content/support/10684626-enable-and-use-web-search.md b/content/support/10684626-enable-and-use-web-search.md index 58bcc3f04..79622552f 100644 --- a/content/support/10684626-enable-and-use-web-search.md +++ b/content/support/10684626-enable-and-use-web-search.md @@ -22,21 +22,19 @@ Web search expands Claude's knowledge with real-time data, helping you make bett **To access this feature on a Team or Enterprise plan account:** -An Owner or Primary Owner must first enable web search for the entire workspace. This can be found in **[Admin settings > Capabilities](https://claude.ai/admin-settings/capabilities)**: - -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2032032614/ad907328c4d9a26ee4bd9ca27a52/CleanShot+2026-02-05+at+09_01_42%402x.png?expires=1787744700&signature=a6771d42576c41e2cfcd6308de8a7472fd57280f2e874ad1feb8adfc13f9d060&req=diAkFMl9n4deXfMW1HO4zetvyrW9HMpXUJIbgsqS2%2BMz48deoMa8sqNCp81F%0AQCDtlItbhW%2F1tltmcP0%3D%0A) +An Owner or Primary Owner must first enable web search for the entire workspace in **[Organization settings > Capabilities](https://claude.ai/admin-settings/capabilities)**. Once this is enabled at the workspace level, any member of the organization can switch it on while starting a chat by clicking the “+” button in the lower left corner of the chat window and selecting “Web search." Users can toggle this off for chats that don’t require web search capabilities. -## How to enable web search in a chat +## Enable web search in a chat -1. Click on the slider icon in your chat input interface. +1. Click on the “+” button in the lower left corner of the chat window. -2. Locate **Web search** in the dropdown. +2. Find "Web search” in the dropdown and click on it. -3. Switch the toggle on. +3. A checkmark will appear next to “Web search” when it’s enabled. -You can disable the feature at any time by following the same steps and turning the toggle off. +You can disable the feature at any time by clicking “Web search” again. ## How web search works @@ -62,11 +60,11 @@ When Claude searches the web: When “Web search” is toggled on, Claude can also retrieve content directly from web pages when provided with specific URLs. This feature, called web fetch, allows Claude to access and analyze the full content of articles, blog posts, and other web pages you want to discuss. -**Important note for free Claude accounts:** When you provide Claude with a direct link to a long article or document and ask it to analyze or summarize the contents, the entire article is retrieved into Claude's context window. This can consume a significant portion of your usage capacity, especially for lengthy content. For example, asking Claude to summarize a 10,000-word article will use substantially more of your context window than a regular web search query. +**Important note for free Claude accounts:** When you provide Claude with a direct link to a long article or document and ask it to analyze or summarize the contents, the entire article is retrieved into Claude's context window. This can consume a significant portion of your usage limit, especially for lengthy content. For example, asking Claude to summarize a 10,000-word article will use substantially more of your context window than a regular web search query. ## Image results -When web search is enabled, Claude can also search for and display images directly in your conversation. You don't need to enable a separate setting — image results are part of web search. +When web search is enabled, Claude can also search for and display images directly in your conversation. You don't need to enable a separate setting—image results are part of web search. For example, you might ask Claude to: @@ -80,11 +78,11 @@ For example, you might ask Claude to: Claude selects images from web search results, powered by Bing, and displays them alongside its text response. Each image includes a source link so you can visit the original page for more details. -Image search is powered by Bing (). +Image search is powered by Bing (**[Microsoft Privacy Statement](https://www.microsoft.com/en-us/privacy/privacystatement)**). Claude can also display interactive content in search results. For more detailed information, see here: **[Visual and interactive content](https://support.claude.com/en/articles/13641943-visual-responses-and-interactive-widgets)**. -## Managing usage on free Claude accounts +## Manage usage on free Claude accounts As a free user, you have daily usage limits for Claude. Since web search and fetch both contribute to these limits, here are some tips to make the most of your capacity: @@ -96,11 +94,11 @@ As a free user, you have daily usage limits for Claude. Since web search and fet To disable web search and conserve your capacity: -1. Click on the slider icon in the lower left corner of your chat input. +1. Click on the “+” button in the lower left corner of the chat window. -2. Find **Web search** in the dropdown. +2. Find "Web search” in the dropdown and click on it. -3. Toggle it off. +3. The checkmark next to “Web search” will disappear when it’s disabled. You can re-enable it anytime you need current information. @@ -138,4 +136,4 @@ You can re-enable it anytime you need current information. - For web search questions or support, please visit our **[Online Safety Contacts](https://support.claude.com/en/articles/11174660-online-safety-contacts)** page. -- For content removal requests, please visit our **[Blocking and Removing Content from Claude](https://support.claude.com/en/articles/10684638-reporting-blocking-and-removing-content-from-claude)** page. \ No newline at end of file +- For content removal requests, please visit our **[Report, block, and remove content from Claude](https://support.claude.com/en/articles/10684638)** page. \ No newline at end of file diff --git a/content/support/10949351-getting-started-with-local-mcp-servers-on-claude-desktop.md b/content/support/10949351-getting-started-with-local-mcp-servers-on-claude-desktop.md index 9d278700c..cdf568286 100644 --- a/content/support/10949351-getting-started-with-local-mcp-servers-on-claude-desktop.md +++ b/content/support/10949351-getting-started-with-local-mcp-servers-on-claude-desktop.md @@ -48,7 +48,7 @@ for specific instructions. Custom desktop extensions uploads allow Team and Enterprise plans to leverage organization-specific workflows that aren’t available in the public directory. After creating a custom desktop extension, Owners and Primary Owners can navigate to Settings > Extensions within Claude Desktop and click “Advanced settings” to access the **Extension Developer** section: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1681607607/ba6e379d2769d190f0970a0adaed/AD_4nXd4aZkqjJFpiXMPF28Pih7HmSJ9pPsnoWAfVgiLdFRFiTkO92YtXteIjvDHaPl7T0tjfpRTBOlyrMbQ_aciCNDgfIuEvV3szmKvt72x5O51DMSClXOYWk1JIRIzylwkj3joXqZcLw?expires=1787744700&signature=bf1aee0a8335e4b10d85d4e12d686d62eed53d0f583135166f2d859666fbc73d&req=dSYvF89%2BmodfXvMW1HO4zWbPxEd4Mzk1Hn9K2IaIG2KyfW2EsaxMXlkws%2Bey%0A9kYw8UEz%2FafBkyXBX8E%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1681607607/ba6e379d2769d190f0970a0adaed/AD_4nXd4aZkqjJFpiXMPF28Pih7HmSJ9pPsnoWAfVgiLdFRFiTkO92YtXteIjvDHaPl7T0tjfpRTBOlyrMbQ_aciCNDgfIuEvV3szmKvt72x5O51DMSClXOYWk1JIRIzylwkj3joXqZcLw?expires=1787829300&signature=dbb0dd1a1a281af550ae019bf8d741f1f3a8d6d954e3d55fc0238746fa4405a6&req=dSYvF89%2BmodfXvMW1HO4zWbPxEd3NTQxHn9K2IaIG2Juynlx1CeJnRPkkhAd%0A7PUEew1M1Y9fjtNh5yE%3D%0A) Click “Install Extension…” and select the .mcpb file. Follow the prompts to install and configure your custom desktop extension. For more in-depth information, please refer to our [desktop extension developer documentation](https://github.com/anthropics/mcpb). diff --git a/content/support/11101966-use-voice-mode.md b/content/support/11101966-use-voice-mode.md index ad73eff48..1abffd320 100644 --- a/content/support/11101966-use-voice-mode.md +++ b/content/support/11101966-use-voice-mode.md @@ -24,7 +24,7 @@ Voice mode transforms how you interact with Claude by: 2. Tap the sound wave symbol in the lower right corner of the chat window to activate voice mode: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2042358620/1bf2311353615c1c494da1312a17/124b93a8-0a9b-4c84-9d1f-ede6ca3498dd?expires=1787744700&signature=27bb8a0624cae3f651d735ffc6c1012ff5da8aaf914bc990a46e669e1f12c5e8&req=diAjFMp7lYddWfMW1HO4zZyGrsl1v1MXF6uXnTLMvvCueQTTnLCv39r7G6SX%0A7paP%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2042358620/1bf2311353615c1c494da1312a17/124b93a8-0a9b-4c84-9d1f-ede6ca3498dd?expires=1787829300&signature=12247ff1b1b08b79c95429e5f799d7bfe9a5cb7a20e57aea17439e82441f119c&req=diAjFMp7lYddWfMW1HO4zZyGrsl6uV4TF6uXnTLMvvD9vlzMTQ%2BMgilkGWzn%0A0PbV%0A) 3. Start talking and see your prompt automatically populate in the chat input. @@ -32,7 +32,7 @@ Voice mode transforms how you interact with Claude by: 5. Claude will remain in voice mode until you click the “Stop” button in the lower right corner of the chat window: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2042352060/162f9e61f7fbeb689201dfc1cac1/6a7fafb2-31df-43be-a43f-0059d735e3c4?expires=1787744700&signature=e7923045c72bc574c081857bcfabf8af940e632736a0256fedd1ec07a344e321&req=diAjFMp7n4FZWfMW1HO4zU6VRfrNTLhuxNdRzYWrfF7SvzR6NFdPO4W71zgW%0AclX8rfLGeetka%2FZcDuM%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2042352060/162f9e61f7fbeb689201dfc1cac1/6a7fafb2-31df-43be-a43f-0059d735e3c4?expires=1787829300&signature=5215ac332fbcab568b4cfd637e2d6ed79e19dd4640eb84c6216e8e0523cc4730&req=diAjFMp7n4FZWfMW1HO4zU6VRfrCSrVqxNdRzYWrfF6Rdu5tsXi%2BQVSr3nSg%0AIXMivFkdvn8kRVfiM9Q%3D%0A) ### On mobile (iOS and Android) @@ -40,7 +40,7 @@ Voice mode transforms how you interact with Claude by: 2. Tap the voice mode icon (sound wave symbol next to the microphone icon) in the text input field: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2042359690/68879db64559ecf87991f73ce058/671ff972-9e08-4686-bc04-955dab4b2de3?expires=1787744700&signature=2e9d336edd7cd5d3ab42d3ba5b91fa18d0887fcf1498767242e5b32e96ac75fe&req=diAjFMp7lIdWWfMW1HO4zQTUIfN9lNxJD%2FRXAPlQ7LZS3JOvrk10kYQtuBI8%0ARd3Y%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2042359690/68879db64559ecf87991f73ce058/671ff972-9e08-4686-bc04-955dab4b2de3?expires=1787829300&signature=32e78908b36eab13820bbf98c3980648d96180704fd51deed738e70e674deb30&req=diAjFMp7lIdWWfMW1HO4zQTUIfNyktFND%2FRXAPlQ7LZeCPlOls9dK1qVrdsY%0A1QdM%0A) 3. Choose a voice to personalize your experience. @@ -78,7 +78,7 @@ To change the voice later: - **On mobile:** Click the settings button in the bottom left corner while chatting with Claude in voice mode, then tap your preferred voice and pace: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2042352063/25eca25bcfd573ecab30dd53158c/074454a6-fa5a-4c49-8b19-02d434b4ca50?expires=1787744700&signature=010ed7e8627757710d246945e035366671963f103f499ff79ea940494949dd72&req=diAjFMp7n4FZWvMW1HO4zZ3%2FGG2SZFQNy8OQfYsvK3w8lTMBEsyF1RJrz3ss%0ArsYWdyqQ0nQxG9R1qAU%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2042352063/25eca25bcfd573ecab30dd53158c/074454a6-fa5a-4c49-8b19-02d434b4ca50?expires=1787829300&signature=80a7e5b5499af794ebec0acc1257a2a306420ba14ebb76917761149dc857d1ff&req=diAjFMp7n4FZWvMW1HO4zZ3%2FGG2dYlkJy8OQfYsvK3xAsckg6M3GgudgtJlD%0AUSOuo1gsS%2BOFKNLQxPE%3D%0A) ## Choose a model diff --git a/content/support/11725453-set-up-the-claude-lti-in-canvas-by-instructure.md b/content/support/11725453-set-up-the-claude-lti-in-canvas-by-instructure.md index 58ff7e48e..50468196c 100644 --- a/content/support/11725453-set-up-the-claude-lti-in-canvas-by-instructure.md +++ b/content/support/11725453-set-up-the-claude-lti-in-canvas-by-instructure.md @@ -44,7 +44,7 @@ This article provides information on how to enable the Claude LTI integration in 5. Click "Install" and refresh the course page. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1611422430/c8e0875feac1f2c7cb033be74fc9/AD_4nXfLU_bui3EXcCjQ0qm70HD97neqjGayKeDer_t76utlci8gZSUjYRhw6ZSOlDdqSEcwXBzd_shAh7pQEJ-8OoE0O21DM5coOgxmO_WD5hlwiuwtS2iYXcTavhIRyQT5zKFWvfn3NA?expires=1787744700&signature=700c8e9d2a1968c8e512fab3b414a304148e95710aa7b6eeee65c43f88a00ade&req=dSYmF818n4VcWfMW1HO4zTEDauwZn%2FeGEv2ojHLMylbz9pLLIi1LkAOJJV%2BB%0AIZ1YNZVEBcHnDJOLOnI%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1611422430/c8e0875feac1f2c7cb033be74fc9/AD_4nXfLU_bui3EXcCjQ0qm70HD97neqjGayKeDer_t76utlci8gZSUjYRhw6ZSOlDdqSEcwXBzd_shAh7pQEJ-8OoE0O21DM5coOgxmO_WD5hlwiuwtS2iYXcTavhIRyQT5zKFWvfn3NA?expires=1787829300&signature=d1a8ce997dba649d51c9afcb796d55cb60635c3592cc50e42dbd7d57d653fda5&req=dSYmF818n4VcWfMW1HO4zTEDauwWmfqCEv2ojHLMylZaiPUZocM73orcJ1ro%0AjKOqokamowD1gD6ITUI%3D%0A) ## Turn on the Claude LTI Integration in Claude for Education organization settings diff --git a/content/support/11818288-why-am-i-being-asked-to-verify-my-payment-method.md b/content/support/11818288-why-am-i-being-asked-to-verify-my-payment-method.md index 51c39e22a..d20c10828 100644 --- a/content/support/11818288-why-am-i-being-asked-to-verify-my-payment-method.md +++ b/content/support/11818288-why-am-i-being-asked-to-verify-my-payment-method.md @@ -2,7 +2,7 @@ If you see the following pop-up when you log in to your Claude account, you’ll need to click the “Verify now” button to verify your payment method: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1631413861/42c3b13d7fc44a11a88ec2b9cd03/AD_4nXeMx8QXpeZZCkfAnVSwx8KZ9n4Vr2rvPdQddyE6ZNxch__F6ZqFs1G4ZmU52Wvb7gRlwRqquTLdw8IQv-gICDyP-MXqiQK_Oe7gX3SKsCKKt2IEpMx4qDeMeeZufMaJfv16XgOH5g?expires=1787744700&signature=4bc07e8cbbc4695cb9770051da0f8144dee70a601d15ed1b48bf02d76a59daa1&req=dSYkF81%2FnolZWPMW1HO4zf7%2BjEPp7IT1n6MrEicvimANrK8mpG4Oan8tdhaE%0A97VYjSd3NbdVgJVeqHY%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1631413861/42c3b13d7fc44a11a88ec2b9cd03/AD_4nXeMx8QXpeZZCkfAnVSwx8KZ9n4Vr2rvPdQddyE6ZNxch__F6ZqFs1G4ZmU52Wvb7gRlwRqquTLdw8IQv-gICDyP-MXqiQK_Oe7gX3SKsCKKt2IEpMx4qDeMeeZufMaJfv16XgOH5g?expires=1787829300&signature=0a51c3ae83a3e8447a97327c700c642a62ef558cea958206e36b0878fb5f0361&req=dSYkF81%2FnolZWPMW1HO4zf7%2BjEPm6onxn6MrEicvimCFOj%2FIZEaOmKA6NG0V%0AKa777oSkFPIcy6eFnUg%3D%0A) ## What happens if I click “Remind me later?” diff --git a/content/support/12005970-manage-usage-credits-for-team-and-seat-based-enterprise-plans.md b/content/support/12005970-manage-usage-credits-for-team-and-seat-based-enterprise-plans.md index 0d8065e53..11fb9be06 100644 --- a/content/support/12005970-manage-usage-credits-for-team-and-seat-based-enterprise-plans.md +++ b/content/support/12005970-manage-usage-credits-for-team-and-seat-based-enterprise-plans.md @@ -70,7 +70,7 @@ After navigating to **[Organization settings > Usage](https://claude.ai/admin-se The **Usage and spend limits** section will show the current limit (if any) or **Unlimited**. Clicking on "Adjust limit" opens a modal where you can either input an amount and click "Set spend limit," or click "Set to unlimited" to remove the organization-wide monthly spend limit. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149347604/936ac4eb025d3ef1f00c3b8a26b0/image.png?expires=1787744700&signature=493766006894818d8faa585250b08c5a3ad6dfbe43eec2dabb1f05f200ea095c&req=diEjH8p6modfXfMW1HO4zQHwg6bQkiqh6DwhVVpk1mBHSyGzziqTDcofOhG%2B%0APZkp9MhhdcYoI1uzNbY%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149347604/936ac4eb025d3ef1f00c3b8a26b0/image.png?expires=1787829300&signature=e888613352d0362bdf5b20d15bc4fa10c240ebc57a1971df456f04e87610afd1&req=diEjH8p6modfXfMW1HO4zQHwg6bflCel6DwhVVpk1mAb3iwJLPMDlB5TMWI0%0A35VLxGUW7OUyrMqvXQ0%3D%0A) Changes to your organization’s overall spend limit go into effect immediately. @@ -78,11 +78,11 @@ Changes to your organization’s overall spend limit go into effect immediately. Owners and Primary Owners on **seat-based Enterprise plans only** can set spend limits that apply to all users within a specific seat tier. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149351600/c5b979c366ac2738f60ea84e85b3/CleanShot+2026-03-10+at+15_37_41%402x.png?expires=1787744700&signature=ce73c202243ff05420af0cd577c968cc4ed2acc38654eeb4f85809c8aa2bd8c6&req=diEjH8p7nIdfWfMW1HO4zYnqMIKTJ3SO0wfO62ivdG9szxvwRekBd486UNBm%0A%2Bf2w31n4QfasBVANVTE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149351600/c5b979c366ac2738f60ea84e85b3/CleanShot+2026-03-10+at+15_37_41%402x.png?expires=1787829300&signature=2e24f500f3341c2388c3625f84b83e5f8dc46792eede3b5fcb8e04b8d941aaf5&req=diEjH8p7nIdfWfMW1HO4zYnqMIKcIXmK0wfO62ivdG8PZVs4g9U8BPi%2BkmJt%0AJRHat%2FNRsQm%2FxWWOTJc%3D%0A) Select the "By group" tab to see **Standard seats** and **Premium seats** groups. Click the "..." icon next to the current limit, then "Edit limit." This opens a modal where you can either select "Set dollar amount" and input an amount, or click "Unlimited" to remove the limit for that seat type. Click "Set limit" to save your changes. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149362056/44993661ca2db771fe924d0346f6/image.png?expires=1787744700&signature=d5a3232ce78ceda9dd0c1f0ea7b198d99ef00f0b1ae6c6d20c329bb3162f7c78&req=diEjH8p4n4FaX%2FMW1HO4zRzvvIIMdElBq7nEDCGq9G6wPpG5LtHHtS1H8che%0AJWDXwFlaMHux4oE0hoQ%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149362056/44993661ca2db771fe924d0346f6/image.png?expires=1787829300&signature=76ac932e6a27c17208c1212afd1c8a5b2f44f94c980d8cd01567875e25cea626&req=diEjH8p4n4FaX%2FMW1HO4zRzvvIIDckRFq7nEDCGq9G70xuJzcy3%2BOj1GvOUq%0AJwQhVv8Qc8KFeRQ0M%2F4%3D%0A) --- @@ -90,11 +90,11 @@ Select the "By group" tab to see **Standard seats** and **Premium seats** groups Owners and Primary Owners can also set individual monthly spend limits for each member by finding **Spend limits by user** and clicking the "..." button next to the user, then "Edit limit." -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149370853/db66f5cd03683b9cc119d0dcd6b8/image.png?expires=1787744700&signature=9955e774df6df917701463af9c76df1a2f83a1dd894b83131dbb82080f1432d3&req=diEjH8p5nYlaWvMW1HO4zaPdGQBQUStBe9HwvwG7ubg7EGjnIs3yK6qhwzDj%0ABDGpqQ%2BGSFPJJuiLcvY%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149370853/db66f5cd03683b9cc119d0dcd6b8/image.png?expires=1787829300&signature=66a47f0b85af3326b9d9775095b9c842fc09b9b6bb4b7d016debfe20f5a27945&req=diEjH8p5nYlaWvMW1HO4zaPdGQBfVyZFe9HwvwG7ubjiLQZzRN9dTIOmI6NG%0AEMNR0OCM5DQXW1j9jxc%3D%0A) Enter the amount and click "Set limit." Alternatively, selecting "Set to unlimited" will remove that member's monthly spend limit (they will still be subject to any organization or seat-level spend limits). -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149374028/97813fe3b515c2e839d8d92abd79/image.png?expires=1787744700&signature=09b75ea2a9ce4cbc91b5c297edee38df717b191084d811c0dc396bcf4a21e02e&req=diEjH8p5mYFdUfMW1HO4zevsAvCNN%2B%2BNw6z2wGSwkbsZoDmy%2BKA23bGz7aU6%0AtLcQt8gfE3lTcEaZPw4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2149374028/97813fe3b515c2e839d8d92abd79/image.png?expires=1787829300&signature=7b53b11b7b4ff830c83d48029cdd03ab1e8da49c62e8ea89c4f2058efc01f9ed&req=diEjH8p5mYFdUfMW1HO4zevsAvCCMeKJw6z2wGSwkbtZVEMbJdDXTCzx2zmo%0Ahdyvm0RG2dB7akekk7I%3D%0A) This allows owners fine control over usage credits, so you can set limits for different members based on their roles or individual needs. Once a user reaches their defined spend limit, this will automatically pause their usage credits until the end of the month. They will need to wait for their usage limits to reset before using Claude again. diff --git a/content/support/12012173-get-started-with-claude-in-chrome.md b/content/support/12012173-get-started-with-claude-in-chrome.md index acdb757a4..b1e018646 100644 --- a/content/support/12012173-get-started-with-claude-in-chrome.md +++ b/content/support/12012173-get-started-with-claude-in-chrome.md @@ -26,7 +26,9 @@ This integration is especially useful for design verification (comparing Figma m When you start a chat, task, or session in Claude Cowork that touches a website, Claude can open the browser directly in Chrome and do the work, clicking, typing, and filling out forms the way a person would. You can let Claude handle work in the browser without switching windows. -Follow these steps to enable the Claude in Chrome connector in your desktop app: +**Note:** Claude Cowork also has a browser built into the Claude Desktop app, with nothing to install. It's rolling out gradually this week. If you already use Claude in Chrome, it stays your preferred browser for Cowork; otherwise Cowork uses the built-in browser by default. Choose either one in **Settings > Cowork > Preferred browser**. Learn more in **[Use the built-in browser in Claude Cowork](https://support.claude.com/en/articles/16607400)**. + +Follow these steps to connect Claude in Chrome in your desktop app: 1. Click your initials in the lower left corner, then select “Settings.” @@ -36,7 +38,7 @@ Follow these steps to enable the Claude in Chrome connector in your desktop app: 4. Toggle the connector on, then download and install the extension if you haven’t already. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2604933811/ae37c41fc808dbdf48d135338334/6cc9ba4b-9d31-43a2-ab80-8048b5f9d791?expires=1787744700&signature=9c74b3ad00dfc6f6dbba2a87ba996bc042112a1064e05554a61a86920af82ee4&req=diYnEsB9noleWPMW1HO4zUOPbPvBkuaKnt%2F2nPMwUPgWrNaqAu6UoZzP8ow4%0AtPTq5LZgRHaOb%2Fr%2FtAM%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2604933811/ae37c41fc808dbdf48d135338334/6cc9ba4b-9d31-43a2-ab80-8048b5f9d791?expires=1787896800&signature=711bbc3805fd2ceac2ed0f38c88b5647f5364d19f890b02142a491f570a29d01&req=diYnEsB9noleWPMW3nq%2BgYRoBvFK8e7NNt1ouCD7O2iMkRRKXBOxZa37nKzb%0AlL7GFas%2BCPl8IHOD8pB0cm83mYU%3D%0A) Completing these steps will add Claude in Chrome to the “Connectors” drop-down on your chats with Claude. This is disabled by default, so you’ll need to enable it manually for each conversation. @@ -64,7 +66,7 @@ The side panel starts in "Automatically approve" mode: Claude works continuously **Note:** On Enterprise plans, the Cowork side panel requires your admin to enable Cowork in the cloud and Claude in Chrome for your organization. If you see the classic side panel, contact your admin. Learn more in **[Claude in Chrome admin controls](https://support.claude.com/en/articles/13065128-claude-in-chrome-admin-controls#h_bdb63199e1)**. -To open the side panel, click the Claude icon in your Chrome toolbar. It stays visible while you browse. If you haven't installed the extension yet, see **[Install Claude in Chrome](#h_e0aabae2db)** below. +To open the side panel, click the Claude icon in your Chrome toolbar. It stays visible while you browse. If you haven't installed the extension yet, see **[Install Claude in Chrome](https://support.claude.com/en/articles/12012173-get-started-with-claude-in-chrome#h_e0aabae2db)** below. **Note:** The side panel reads the tab you're on with no extra setup. Tasks that need your local files, your computer, or Claude driving Chrome from another surface still need the Claude Desktop app open and connected, even though your session runs in the cloud. diff --git a/content/support/12083917-change-your-team-plan-from-monthly-to-annual-billing.md b/content/support/12083917-change-your-team-plan-from-monthly-to-annual-billing.md index ed806e9d0..7c91c4c5a 100644 --- a/content/support/12083917-change-your-team-plan-from-monthly-to-annual-billing.md +++ b/content/support/12083917-change-your-team-plan-from-monthly-to-annual-billing.md @@ -8,11 +8,11 @@ Owners and Primary Owners of Team plans with monthly subscriptions can switch fr 3. Or from /upgrade, click the “Switch to Annual plan” button: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1690325734/d47f714680d78408d6022d06b8d1/image.png?expires=1787832000&signature=c05c3d46cb7401df9baa58edb87805e3b1ecab4696019ad50403dbd4f834d539&req=dSYuFsp8mIZcXfMW3Hu4gZzas%2FXtvjdRn2rRiVwqPzYu1PSMhlV%2Bp6ux23%2Bi%0A7g%3D%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1690325734/d47f714680d78408d6022d06b8d1/image.png?expires=1787940000&signature=dacef57fe98c2943ed269ce8a59d582daa39ff5bdc4e1dad6b34a5817fae835f&req=dSYuFsp8mIZcXfMW3Hu4gZzas%2FXtvjZWnWrRiVwqPzZXUnvgaE6d%2Br00lUX0%0Aog%3D%3D%0A) 4. The confirmation screen will display the total cost for your upgrade from monthly to annual billing: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1690326039/3a91cdc5fff57d188a18ecc6273f/image.png?expires=1787832000&signature=656c8846cadf558f93053b594b2bec4be5dcae6effa4a8178b8575988c2057ae&req=dSYuFsp8m4FcUPMW3Hu4gbNj%2Bk78WwXiie5vzcg6znVwEFmtjEVWOKS9nOj5%0AXw%3D%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1690326039/3a91cdc5fff57d188a18ecc6273f/image.png?expires=1787940000&signature=f9c6dfae962c5d644b726c9e6042d04453d3bbc7b3b9084e1fae7e67de0521fc&req=dSYuFsp8m4FcUPMW3Hu4gbNj%2Bk78WwTli%2B5vzcg6znUIfs%2FQfC%2Bur3mzbTB8%0ACA%3D%3D%0A) 5. Click “Confirm subscription.” diff --git a/content/support/12111783-create-and-edit-files-with-claude.md b/content/support/12111783-create-and-edit-files-with-claude.md index 5311409de..248838348 100644 --- a/content/support/12111783-create-and-edit-files-with-claude.md +++ b/content/support/12111783-create-and-edit-files-with-claude.md @@ -48,7 +48,7 @@ These capabilities make it easy to produce professional documents by simply chat To give Claude access to external data sources, toggle **Allow network egress** on: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2054774005/25bcfffba6c249cd128d6c3f6d52/CleanShot+2026-02-11+at+16_34_47%402x.png?expires=1787744700&signature=fd518f722772f01a95e76552dc033d6cbeff80d3791df971ab648f0b1ffa14e0&req=diAiEs55mYFfXPMW1HO4zYFJywpCCJ3JPQVowIiib2m9JsmWog0j624BWP5p%0AP0nkGjVvrBGAfV2Q0Jg%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2054774005/25bcfffba6c249cd128d6c3f6d52/CleanShot+2026-02-11+at+16_34_47%402x.png?expires=1787829300&signature=b3e4aa87bd1f7b53b569324b49240d57c4b516ec19bc19c3fcaac42a31948f9f&req=diAiEs55mYFfXPMW1HO4zYFJywpNDpDNPQVowIiib2nJg%2FuXwPG1c4FqRujy%0Ayg7cmQ3YQpCmpQFe6ic%3D%0A) ### Enabling on Claude Mobile @@ -66,11 +66,11 @@ Team and Enterprise organization owners can control network access settings in * - **Allow network egress to package managers and specific domains:** Claude can access package managers plus additional domains you specify. Add domains individually to whitelist specific resources your organization needs: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1789945362/ad72504d5429960f369b8b91b43c/86f06c0e-6eaa-4574-a4cb-2c38b273613a?expires=1787744700&signature=de5e5557a317dd6181894d1c45e13f21959388accbe0fa1a5b5042f0af77d85d&req=dScvH8B6mIJZW%2FMW1HO4zXJcBmpEkS1MpMW6Iph6YZd5sljIKs7LgkEh%2F3Mi%0Ar01MiSPvmXwFKNamtCc%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1789945362/ad72504d5429960f369b8b91b43c/86f06c0e-6eaa-4574-a4cb-2c38b273613a?expires=1787829300&signature=ca085c7e604ccce9768eab7af900d04eaba433761959c619c88ad885d6ec52a1&req=dScvH8B6mIJZW%2FMW1HO4zXJcBmpLlyBIpMW6Iph6YZcw%2BbUr3%2BzD2Pna104B%0A16RGRa1lDISOR7FewDE%3D%0A) **All domains:** Claude has full internet access except for domains on Anthropic's legal blocklist. While this provides maximum flexibility for file creation and analysis tasks, it’s also the riskiest option. Please review the **[security considerations below](#h_0ee9d698a1)** before enabling “All domains”: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1789945361/e3188cb8edb9ca7c303615da6378/f1c99a7d-5956-48d5-9ec7-b7ae6c8c3d28?expires=1787744700&signature=9784aa0809973ac6bd87590663c1cbc28e3ccf9100794a9f8b970ac09e0898b4&req=dScvH8B6mIJZWPMW1HO4zdnseBOV6julqgKIA6CM1tp5PqhCGtUWSaw8Gzhr%0AJzKGUdfK7L5P9dHx8N0%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1789945361/e3188cb8edb9ca7c303615da6378/f1c99a7d-5956-48d5-9ec7-b7ae6c8c3d28?expires=1787829300&signature=827a2a95fbc66e4079d5e8fe1da925a06ceb1486727f56dfe165a799ebf58142&req=dScvH8B6mIJZWPMW1HO4zdnseBOa7DahqgKIA6CM1tqfS8zBl3CYQnFSwTJZ%0AX92khlJrQPXWmAYXvvo%3D%0A) --- diff --git a/content/support/12157520-claude-code-usage-analytics.md b/content/support/12157520-claude-code-usage-analytics.md index 3ecd42bd3..b9b5b9407 100644 --- a/content/support/12157520-claude-code-usage-analytics.md +++ b/content/support/12157520-claude-code-usage-analytics.md @@ -50,7 +50,7 @@ The **Usage** tab displays the following metrics for your organization. Data on - **Top commands**: The Claude Code commands used most often across your organization. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1717579277/46c512f4b3ed05c359cecd78ed5c/e0ce2c19-39e2-411f-9a1f-cb1d46439a42?expires=1787744700&signature=ebf7149df4122c84b12d13cf40a8b7383250561d16ce4c2d8009dcb9dc35a3f0&req=dScmEcx5lINYXvMW1HO4zfiEP6FXi33JCX9h5MbdDjO0wk4Xp6hEPZXIZI2E%0AhBh4Go%2FTc8ME4ySZ7sY%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1717579277/46c512f4b3ed05c359cecd78ed5c/e0ce2c19-39e2-411f-9a1f-cb1d46439a42?expires=1787829300&signature=d099a4d6cd13c12378894fefdbcbb2a875a94e90827d275986c14d8ccf1326e4&req=dScmEcx5lINYXvMW1HO4zfiEP6FYjXDNCX9h5MbdDjNZNHw0sTl7c%2FLcdq6V%0Ap9YdL%2BwvIK6VVNac0%2FE%3D%0A) ### User-level metrics diff --git a/content/support/12260368-use-incognito-chats.md b/content/support/12260368-use-incognito-chats.md index 789576483..831e3a7f9 100644 --- a/content/support/12260368-use-incognito-chats.md +++ b/content/support/12260368-use-incognito-chats.md @@ -30,7 +30,7 @@ Incognito chats are temporary conversations that aren't saved to your chat histo When starting a new chat with Claude outside of a project, you'll see a ghost icon in the upper right corner of your screen: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1719768744/c7a2fa56cf284e48472f3b9c4dbf/030563f8-9f97-4891-a749-9ae95968a063?expires=1787744700&signature=3cc278dbfd78008ac2be650a4ca8fefa447da04941845b584703fcf0cd8131b0&req=dScmH854lYZbXfMW1HO4zeUcuwW6auGMDCAt3Cx%2FSO1CZhGKc0zYbHYM1Kk9%0Af8m5iDh4dKNHUFw7EcA%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1719768744/c7a2fa56cf284e48472f3b9c4dbf/030563f8-9f97-4891-a749-9ae95968a063?expires=1787829300&signature=f70cb86cbdbecc765dfd3146717a3ab95d0d4c94c40501301c0d90b7ded9b348&req=dScmH854lYZbXfMW1HO4zeUcuwW1bOyIDCAt3Cx%2FSO2Nxt8w0%2B1HazOMtruP%0AZ73GAxBYX5R0gbj3iRU%3D%0A) 1. Click the ghost icon to enable incognito mode. diff --git a/content/support/12293051-use-claude-in-xcode.md b/content/support/12293051-use-claude-in-xcode.md index 3d2298ef4..318d0b1b2 100644 --- a/content/support/12293051-use-claude-in-xcode.md +++ b/content/support/12293051-use-claude-in-xcode.md @@ -34,7 +34,7 @@ To start using Claude in Xcode: 3. Log in with your Claude account. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1727371585/b18ca03a6357c52d12d10386f28e/dab2dcb2-f670-4173-b77d-38767a34cec1?expires=1787744700&signature=8f38de5ebb352dc62c70d7906376542d576fcb8efd2260e1fa5943a24850b72a&req=dSclEcp5nIRXXPMW1HO4zUAXI8sFVqzTFalhp3bugHInVrkutrnGiT3SK5lQ%0AZCZ1i%2BA3OryhNBTHfoo%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1727371585/b18ca03a6357c52d12d10386f28e/dab2dcb2-f670-4173-b77d-38767a34cec1?expires=1787829300&signature=2973dc4efe971fd8b2af0901588d2e77bba7d8e7fa7ab0115d4ed56e2c49c6b3&req=dSclEcp5nIRXXPMW1HO4zUAXI8sKUKHXFalhp3bugHJ4%2BHz84U%2BGPuSGD5lF%0AzeLUpEjzjA4%2Bq5Yq6S8%3D%0A) ## Usage limits diff --git a/content/support/12429409-manage-usage-credits-for-paid-claude-plans.md b/content/support/12429409-manage-usage-credits-for-paid-claude-plans.md index ba0108f6c..ea58b40ee 100644 --- a/content/support/12429409-manage-usage-credits-for-paid-claude-plans.md +++ b/content/support/12429409-manage-usage-credits-for-paid-claude-plans.md @@ -46,7 +46,7 @@ To enable usage credits on your paid Claude plan: 8. You can also enable auto-reload to automatically make a purchase when your balance falls below a threshold you set: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1805819785/5e203c38e6ba3f76bfd1dab0d5ce/fe062e7c-18cb-48cc-a7e2-754ac6e6c4be?expires=1787744700&signature=57a29a75b80a04f767474d88a23bbd262f249e606dfc3185d9f0a3c0f87d2908&req=dSgnE8F%2FlIZXXPMW1HO4zYj2ARWeofQ%2FopE7m38Ydff62PtlTy4mTIkZzkB%2F%0ABfTaf5hOID6bJxbenmY%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1805819785/5e203c38e6ba3f76bfd1dab0d5ce/fe062e7c-18cb-48cc-a7e2-754ac6e6c4be?expires=1787829300&signature=748587d0776dd194ab8f602ad9be339937e4c0a440a5d533653593c70be43b2e&req=dSgnE8F%2FlIZXXPMW1HO4zYj2ARWRp%2Fk7opE7m38Ydfdhh0cohH%2BQrGsFA3U8%0ATHxOClMVdP0Yz0cnQz4%3D%0A) **Note:** There is a daily redemption limit of $2000. diff --git a/content/support/12466728-troubleshoot-claude-error-messages.md b/content/support/12466728-troubleshoot-claude-error-messages.md index 7c27bc5a2..2967a56d6 100644 --- a/content/support/12466728-troubleshoot-claude-error-messages.md +++ b/content/support/12466728-troubleshoot-claude-error-messages.md @@ -58,4 +58,4 @@ Capacity issues will not appear on our status page because they represent normal Service incidents are disruptions where Claude is unavailable or significantly degraded for all or most users. These represent actual technical problems with our systems. To check for confirmed incidents, visit status.claude.com, where you'll find real-time updates on scope, impact, and resolution progress for any active incidents. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1753796247/e6a8c6ef8653b229c5758e881242/c2fc6fc0-d163-4119-93e0-394104d86bc9?expires=1787744700&signature=8f8ccf456dd34c6d90e6f7333ad289de00327c606ba8e6de8f5509d797218d7f&req=dSciFc53m4NbXvMW1HO4za4BXqgk1rbD7y68oYp%2BYg%2BuhbLteKayQm25Llea%0AOUH3Dr1dBy9j8FWtdNg%3D%0A) \ No newline at end of file +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1753796247/e6a8c6ef8653b229c5758e881242/c2fc6fc0-d163-4119-93e0-394104d86bc9?expires=1787829300&signature=a278d11ff65db3c932821723f4f0fe301873f7c577fa07217fc3aaf550b30063&req=dSciFc53m4NbXvMW1HO4za4BXqgr0LvH7y68oYp%2BYg8iSv7n46vTlRefBWMA%0AHM6IwbtuZjZJ0Bwcv%2BQ%3D%0A) \ No newline at end of file diff --git a/content/support/12512180-use-skills-in-claude.md b/content/support/12512180-use-skills-in-claude.md index 8300b9d90..bfd6da9e1 100644 --- a/content/support/12512180-use-skills-in-claude.md +++ b/content/support/12512180-use-skills-in-claude.md @@ -166,7 +166,7 @@ To remove a custom skill you've uploaded: 4. To delete the custom skill entirely, click the "..." button next to the toggle, then select "Delete": - ![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2105391273/8359cbf8be20dce0f1cd3fd40e6f/CleanShot-2B2026-02-25-2Bat-2B15_50_16.png?expires=1787744700&signature=9baedd86d87852c45ef342a7a12d76b5e41d9bd8ee8d0814aa1779aa6b72fdf5&req=diEnE8p3nINYWvMW1HO4zSOgDywvxuKqH%2BdCnFXB0uguJO3xQDLAz%2Bt86MrF%0AOU4s%0A) + ![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2105391273/8359cbf8be20dce0f1cd3fd40e6f/CleanShot-2B2026-02-25-2Bat-2B15_50_16.png?expires=1787829300&signature=34ca5f8ce1a9f654da80532d30fc4a501609b22d480181ec9338032da171d078&req=diEnE8p3nINYWvMW1HO4zSOgDywgwO%2BuH%2BdCnFXB0uh2mcNRV96FHXBCyv1E%0A6aSO%0A) 5. Click "Delete" in the confirmation prompt. diff --git a/content/support/12592343-enabling-and-using-the-desktop-extension-allowlist.md b/content/support/12592343-enabling-and-using-the-desktop-extension-allowlist.md index df721bb1c..0d6efe008 100644 --- a/content/support/12592343-enabling-and-using-the-desktop-extension-allowlist.md +++ b/content/support/12592343-enabling-and-using-the-desktop-extension-allowlist.md @@ -20,11 +20,11 @@ The desktop extension allowlist is disabled by default, so an organization Owner 4. Switch to the "Desktop" tab: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1781755172/63c92550571842577ad435860ec5/6f5cc4e1-ff7d-48de-863a-c4e6184d4605?expires=1787744700&signature=de27461da3178223639a9f785c72c3996a6d6c099207c465c8b7a8418243b4e9&req=dScvF857mIBYW%2FMW1HO4zQ9pXU0N%2B3Tc0ugSQm1MFW9bZWEjymkA3FoW9xxH%0AXPjU%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1781755172/63c92550571842577ad435860ec5/6f5cc4e1-ff7d-48de-863a-c4e6184d4605?expires=1787829300&signature=a33b9e4739ce661da3d6fa155a0451876b9b9da104564a01cced4505018e8257&req=dScvF857mIBYW%2FMW1HO4zQ9pXU0C%2FXnY0ugSQm1MFW8AYPKYx28P0lTsCogI%0AMM6E%0A) 5. Toggle **Allowlist** on: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1781755578/a6bafff5f084dc86ae463703fd3d/6cf0ee18-4e71-4129-98e8-cc08174e3c3a?expires=1787744700&signature=9cef4205056c96eb69207e1a66c627738109e1bb196db632ef6f370cf86229ec&req=dScvF857mIRYUfMW1HO4zaj0BHYsTaMDTAorLxpdoc8nlw5gBORomnVCscFm%0A%2Bo%2Bh%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1781755578/a6bafff5f084dc86ae463703fd3d/6cf0ee18-4e71-4129-98e8-cc08174e3c3a?expires=1787829300&signature=d1450dbda54c685f120206709edacbc01208fb7fe2351f6220a4bbe3ce193900&req=dScvF857mIRYUfMW1HO4zaj0BHYjS64HTAorLxpdoc%2BevC%2FxGrZpl46tL9X5%0A2yag%0A) ## What happens after enabling the allowlist? @@ -42,7 +42,7 @@ Consider completing the allowlist setup during off-hours to minimize disruption **Important:** The allowlist requires Claude Desktop version 0.13.91 or higher, so users should update the desktop app by clicking “Claude”, then either “Check for updates” or “Restart to update to Claude 0.13.91”: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1781756960/ad18af50c83d35f2673656c23e00/a7ee450f-0c7d-42d6-a75f-fb1bc088cb52?expires=1787744700&signature=09d0ddc9f7ff2452ab0ca1876c30fae3879cbc4292790df91c75be5acd6554ee&req=dScvF857m4hZWfMW1HO4zYUJqYStDjbsCEDZ5AdBjIakkvEBevTkiudYKgEc%0AiD%2B7YTjssooYeicvV3I%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1781756960/ad18af50c83d35f2673656c23e00/a7ee450f-0c7d-42d6-a75f-fb1bc088cb52?expires=1787829300&signature=3fffe529d080e9951fe305fd47e2931fef38c05970d1d1a32ca354c713b4ef93&req=dScvF857m4hZWfMW1HO4zYUJqYSiCDvoCEDZ5AdBjIbMQCgZIFHefU5WWp1J%0AckA6QZR4uPGbhLm2KsI%3D%0A) ## Managing allowed extensions @@ -60,7 +60,7 @@ After enabling the allowlist, you can choose which extensions to allow: If you want to remove an extension from the allowlist, click the “...” button and “Remove from allowlist.” -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1781751250/6558c0f59aea7976bd44b0213d76/e750f02b-cd0d-437e-a83f-9ac362cdf456?expires=1787744700&signature=e3bfe9d01659752dd8f00bc843280167704d896b8fd3bccb326b77a50d281f8f&req=dScvF857nINaWfMW1HO4zTrxBa8u%2B1OSqXridZhfx1L9jBQRzlxzJyj%2FRI3D%0AyPmBMBxq38zTIiPLLWw%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1781751250/6558c0f59aea7976bd44b0213d76/e750f02b-cd0d-437e-a83f-9ac362cdf456?expires=1787829300&signature=d810015ee5119ac7741c755b9e10291647234be438ace1d9f52162d15528aaf4&req=dScvF857nINaWfMW1HO4zTrxBa8h%2FV6WqXridZhfx1LraDKWVIeVZaZV7KHQ%0AOIB%2BbR1k9nFFGKplQxE%3D%0A) ## Uploading custom extensions diff --git a/content/support/12618689-claude-code-on-the-web.md b/content/support/12618689-claude-code-on-the-web.md index 2500176cc..457246484 100644 --- a/content/support/12618689-claude-code-on-the-web.md +++ b/content/support/12618689-claude-code-on-the-web.md @@ -10,7 +10,7 @@ This feature works with repositories you may not have on your local machine. You Claude Code for web enables asynchronous development workflows. With Claude Code in your terminal or editor, you typically work synchronously: you make a request, wait for Claude to respond, review the changes, then make another request. Synchronous work like this gives you fine-grained control but requires your attention throughout the process. Claude Code on the web handles this differently: you can assign a larger task, let Claude work independently, and return later to review the completed work. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1786446157/07ec74cd46317f8278083a317841/6448f3ee-c6df-4417-8a13-90d8c2ca3d55?expires=1787744700&signature=954f23ab27d7be7ec59c937847c3e1ea5dd8d8f12f54d181b1a87fca391cecf7&req=dScvEM16m4BaXvMW1HO4zR8%2BAFSHRplx7XrRA1YwWGsmnOh0atjDZM9mQjPl%0AQYgR5Su5VG%2FKk2ROzQE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1786446157/07ec74cd46317f8278083a317841/6448f3ee-c6df-4417-8a13-90d8c2ca3d55?expires=1787829300&signature=353d693d3e9654b09dac0c00cdd18483563cee3e58546ed1604a25ee6954d40a&req=dScvEM16m4BaXvMW1HO4zR8%2BAFSIQJR17XrRA1YwWGtM7B8MVBairN7z0yq%2F%0A%2FekR3e6nioItQjfVYhs%3D%0A) You can also run multiple tasks in parallel. Since each task runs in its own isolated environment, you can have Claude working on several different issues or repositories simultaneously. Each task proceeds independently and creates its own pull request when complete. More than one task can work on the same repository at the same time. @@ -18,13 +18,13 @@ You can also run multiple tasks in parallel. Since each task runs in its own iso When you start a task, Claude Code on the web creates an isolated virtual machine for your work. Your GitHub repository is cloned into this environment, which comes pre-configured with common development tools and language ecosystems. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1786446158/c092f1383826cb871493f74169d4/97b7cb98-5da2-438e-a920-e170b8b9790e?expires=1787744700&signature=10c2675a59a90faaeb56531332e4b1d89789e6fdae17c2d33747f8f15517a852&req=dScvEM16m4BaUfMW1HO4zcR0rZEzi%2B3H7DtpMiX%2FBYm6zLVXioq6HAcAerVe%0A62xfy1Yf8SLAg5TO%2FRA%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1786446158/c092f1383826cb871493f74169d4/97b7cb98-5da2-438e-a920-e170b8b9790e?expires=1787829300&signature=f9b44fadef851037809f4819cf215e8b8f1d189c908d1ea27a0a606c1065a9ae&req=dScvEM16m4BaUfMW1HO4zcR0rZE8jeDD7DtpMiX%2FBYnppEHF6D2nwYrY3TVq%0A4%2FjC%2Fhv5Wec34VBrbLo%3D%0A) Claude prepares the environment by running any setup commands you've defined in your repository's configuration. This includes installing dependencies, setting up databases, or running other initialization steps your project needs. If your task requires network access, maybe to install packages or fetch data, you can configure the level of internet access the environment has. Once the environment is ready, Claude begins working on your task. Claude reads your code, makes changes, writes tests, and runs commands to verify the work. You can monitor progress and provide guidance through the web interface if needed. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1786446156/83ecf0a5b98eddc9ffc9694c50f7/353589ce-b678-441d-8909-71b45fa2d065?expires=1787744700&signature=c49ca44cd1e98311c992969141eabd4dc17f530c02baf1146c6c65b15dd26018&req=dScvEM16m4BaX%2FMW1HO4zVbcTGSE58DJUQl3YqgIJdY1%2BNrQ3lo%2BWG9e9Zoq%0A1POteIC1GORXQPqXU%2BE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1786446156/83ecf0a5b98eddc9ffc9694c50f7/353589ce-b678-441d-8909-71b45fa2d065?expires=1787829300&signature=557b4bcc6cb00bf348c2731a58b4353be36ee11043159bd23b91b5bbb35c2095&req=dScvEM16m4BaX%2FMW1HO4zVbcTGSL4c3NUQl3YqgIJdZ4O4Ti8JVukMREeoQr%0AgA4%2BTjH4XagLbILqXPM%3D%0A) When Claude completes the task, it pushes the changes to a new branch in your GitHub repository. You receive a notification and can review the changes, then create a pull request directly from the interface. The pull request includes all of Claude's work, ready for your review and any additional changes you want to make. diff --git a/content/support/12626668-use-quick-entry-with-claude-desktop-on-mac.md b/content/support/12626668-use-quick-entry-with-claude-desktop-on-mac.md index eb14fcd65..c860ff172 100644 --- a/content/support/12626668-use-quick-entry-with-claude-desktop-on-mac.md +++ b/content/support/12626668-use-quick-entry-with-claude-desktop-on-mac.md @@ -40,7 +40,7 @@ When you first open the updated version of Claude Desktop, you'll see a prompt t Once enabled, double-tapping Option will open a text box where you can type your message and start a new chat. You can also click "New chat" to see your five most recent conversations. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1893088365/2ca4b782dda90abea1fe5f4150af/CleanShot+2025-12-18+at+13_14_30%402x.png?expires=1787744700&signature=c2fe7227624c4436a5e7e88bf75a0da6409c3d51794f6afa5e85eff13bc938e8&req=dSguFcl2lYJZXPMW1HO4zWggD9lWopidRC8c%2FcM5c2IQUUHn2BLk2xhHglTS%0AE6d2ChiYqMcYZnGtB10%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1893088365/2ca4b782dda90abea1fe5f4150af/CleanShot+2025-12-18+at+13_14_30%402x.png?expires=1787829300&signature=d9f31ee358d50590523a84c654eeb4d74940a138be1c66c42168b7de097b9c63&req=dSguFcl2lYJZXPMW1HO4zWggD9lZpJWZRC8c%2FcM5c2IAcwZBIcofv1NHkM2V%0AJLEsgEmUVVGog3fyMVg%3D%0A) ### Enable the voice shortcut (optional) diff --git a/content/support/12883420-view-usage-analytics-for-team-and-enterprise-plans.md b/content/support/12883420-view-usage-analytics-for-team-and-enterprise-plans.md index adc7b0011..e5681e89f 100644 --- a/content/support/12883420-view-usage-analytics-for-team-and-enterprise-plans.md +++ b/content/support/12883420-view-usage-analytics-for-team-and-enterprise-plans.md @@ -22,7 +22,7 @@ This page includes the following analytics: - Sessions in Cowork -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515895966/9f231a620f47d49e0ee648152189/848c1787-4eaa-4809-8fd2-1dbe2722560f?expires=1787744700&signature=383a474f0a84ca5c348861915299341b83a905f2a035fac2d20458fb59bc3906&req=diUmE8F3mIhZX%2FMW1HO4zZL6waF1n4F2ExEG4dCAGDZvU4%2BmxDriCrNv1zhL%0ACzijoZvUL7%2BHI1SnQd4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515895966/9f231a620f47d49e0ee648152189/848c1787-4eaa-4809-8fd2-1dbe2722560f?expires=1787829300&signature=d781b694617ad03d69294510a1948fbce6c70ab002e40123055441d197e1c04b&req=diUmE8F3mIhZX%2FMW1HO4zZL6waF6mYxyExEG4dCAGDa8Ie7KiNaIR%2Fl8dzk1%0ABqb09LCL0CduxYtf%2BWQ%3D%0A) ### Who’s using Claude? @@ -34,7 +34,7 @@ This page includes the following analytics: Use the dropdown on the **Active members and assigned seats** chart to filter by product, including Claude Design. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896351/4d955858e6662c37489cc1470871/457cf159-8c2a-4403-ba22-cb92cb47e459?expires=1787744700&signature=c9009bd73d324facb60a21f7a92c1676442dc644b78c2f43efe623da25c89a5b&req=diUmE8F3m4JaWPMW1HO4zYEqejCuRpSoYqPRsgaNdTxE0%2F1K2mXP47UCRx%2Fd%0AuWO9TjWPnxXJbNI0gfU%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896351/4d955858e6662c37489cc1470871/457cf159-8c2a-4403-ba22-cb92cb47e459?expires=1787829300&signature=e5d4726a8abc9a8c5d5ef8232fbd2e5224994204a251d4f69fad40200cba70ec&req=diUmE8F3m4JaWPMW1HO4zYEqejChQJmsYqPRsgaNdTwCQmqpqRLNN%2F1HwqRi%0ASsMGTP%2FdV1827mEmASM%3D%0A) ### How are they using Claude? @@ -48,9 +48,9 @@ Use the dropdown on the **Active members and assigned seats** chart to filter by - How agentic is their work? (beta) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2583875713/e3cb3c329f3b643cb9a3809876b3/image.png?expires=1787744700&signature=5a0afb927ecf14d08292c3618256c972315f48fb28ff58995f7863cf3125c8c8&req=diUvFcF5mIZeWvMW1HO4zciS3a%2FunrpsDFD6TO7tG4iMcS1i5sHbI%2Blbx3GN%0AcZ79ZC0fODSSIlHyFLw%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2583875713/e3cb3c329f3b643cb9a3809876b3/image.png?expires=1787829300&signature=5503c7b72cbda417b0f0eed1b5ba281a06eb52a11546599ee7266e2a8ccb418b&req=diUvFcF5mIZeWvMW1HO4zciS3a%2FhmLdoDFD6TO7tG4jljeaKbp7DR57JNJEE%0A9y56VDxhDvtChhzmqd4%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896563/abf008596ce5501297a609696362/fce5423c-4769-4b73-9a0a-c50f6407ebea?expires=1787744700&signature=4f245070f2ff24a36a3cf063f170aa1bdc580ddaf2fdf4f161b3964070e53532&req=diUmE8F3m4RZWvMW1HO4zR%2BIDoBpufPwLS3kobW3ZgR9%2B3wygqamCXQR2Bat%0As5%2F7MT6DqfbQ%2FvxFIm4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896563/abf008596ce5501297a609696362/fce5423c-4769-4b73-9a0a-c50f6407ebea?expires=1787829300&signature=10db4e7db2b854181968c2a0574cb14b95e2ad81c5daecf85f8cc6a03e8bb5d8&req=diUmE8F3m4RZWvMW1HO4zR%2BIDoBmv%2F70LS3kobW3ZgQSkO7TljwWUlqiQbkk%0AvFYr8WsoHG0PXTm%2Flw8%3D%0A) ### What are the results? @@ -66,7 +66,7 @@ Use the dropdown on the **Active members and assigned seats** chart to filter by - Estimated time saved -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896943/dd415f03afe56ca38308ef987f86/189e8ebc-5594-4f4b-bd84-e3c11c824d5b?expires=1787744700&signature=51550039ebd8a33f3a57413b35049b55868da33d4fef60c3e32e117150ae36ba&req=diUmE8F3m4hbWvMW1HO4zfJThCM4rdhBiovaLYNN7RlngmyzBvRSPcUk6LKt%0ACFVbpXzVh%2BBFPGY2kBY%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896943/dd415f03afe56ca38308ef987f86/189e8ebc-5594-4f4b-bd84-e3c11c824d5b?expires=1787829300&signature=be013407c1f849e698a442c28f168a0360f743bb201c1c5fd7bd5971c78a700a&req=diUmE8F3m4hbWvMW1HO4zfJThCM3q9VFiovaLYNN7RmkGyKtYh9iLu52JZRx%0AFcGqKaattnWI7sbzWOA%3D%0A) ### How much is Claude costing? @@ -82,9 +82,9 @@ This section includes the following analytics: - Spend by model (month-to-date, quarter-to-date, year-to-date, 1 year) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896942/b403f2d216fc40b5195911020b8e/446b99f1-3187-4b79-b2be-9f17b1632ff8?expires=1787744700&signature=0c1531bb1c9c6ff88bbda3de61f76b1e89703e50ea6650d34a0b6e43aa559aec&req=diUmE8F3m4hbW%2FMW1HO4zYE%2BQ9kF6DXaWbBLGZ4vBJXe1o3ESInoO%2FXm8Ouy%0ANl29HT3Ezs4RpevPKA4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896942/b403f2d216fc40b5195911020b8e/446b99f1-3187-4b79-b2be-9f17b1632ff8?expires=1787829300&signature=7535a294ca1170811b624784de37375f851ed086793cd4df34d5cbe553623dec&req=diUmE8F3m4hbW%2FMW1HO4zYE%2BQ9kK7jjeWbBLGZ4vBJWDe9aoBVGBLoJPdnxU%0AX5XuuEeZ7ai8jSBbf%2Fk%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896941/2239ce38639df339b24d5af1cb50/f829bc2a-ee52-4135-9b13-09ef1b7d66d6?expires=1787744700&signature=3f45ec6db05213fa1155194bdde16ebfb7489b2c76f707a5caf3f9118fdd209c&req=diUmE8F3m4hbWPMW1HO4zTz0Nu0FI81XC%2BtvTPa1I7E%2FahON08WvU6NvnskD%0A%2BSz%2BSkQGFgdgat6iZug%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515896941/2239ce38639df339b24d5af1cb50/f829bc2a-ee52-4135-9b13-09ef1b7d66d6?expires=1787829300&signature=7eb0e8c8691c95b5270edcdd246e90bd5a3872a7fb06d3b7be31b1139ab185a8&req=diUmE8F3m4hbWPMW1HO4zTz0Nu0KJcBTC%2BtvTPa1I7HaQusveg2ofG9JI%2BRf%0AmU6cU2gOR3wsX18kMz4%3D%0A) ## Export a spend report @@ -160,7 +160,7 @@ Navigate to **[Analytics > Claude Chat](https://claude.ai/analytics/usage)** to - Top members by chats -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515898793/405db0c492da11886c28a2b82731/71a55afc-1cef-4c50-b7e1-86775cb9a168?expires=1787744700&signature=7eaa6f3d12abe17cda148f50a89c577472313bffac9d806808507cdd98517ee5&req=diUmE8F3lYZWWvMW1HO4zbhc8fqbZeAmTcfMEUwBBiU5h8EH7FshyD8V4SDY%0AJrrq5uNCWYPqjkxi4ec%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515898793/405db0c492da11886c28a2b82731/71a55afc-1cef-4c50-b7e1-86775cb9a168?expires=1787829300&signature=9af7e326304541d2cdc0b3f3b89355d91abda66e41246ccacadf76e850327310&req=diUmE8F3lYZWWvMW1HO4zbhc8fqUY%2B0iTcfMEUwBBiWcTWOJhfp6NJemPf%2B2%0AFJYNskGrLq1VFdF7uSk%3D%0A) ### Projects @@ -172,7 +172,7 @@ Navigate to **[Analytics > Claude Chat](https://claude.ai/analytics/usage)** to - Top members by project usage -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515899610/91d93108f0767e795fb9e488e882/71607d6d-dff1-4a13-a445-aa1d79850eed?expires=1787744700&signature=a9b795818b89cac4914c11312e58563d320dcb5ce4904e3ac4d41dc7df87fd2d&req=diUmE8F3lIdeWfMW1HO4zWhGoTuenyelExu5cYiHHN%2FQfdxgG9AhB3R%2BkXAA%0ALHqjQ7b3m931G0TLKuk%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515899610/91d93108f0767e795fb9e488e882/71607d6d-dff1-4a13-a445-aa1d79850eed?expires=1787829300&signature=addfe80a218ad4e17010bdaf426d573c1e11962c95b7aecc10e4ca75f2e48170&req=diUmE8F3lIdeWfMW1HO4zWhGoTuRmSqhExu5cYiHHN8gfFPRZwc4Af6Q0K99%0ALIyi5c0xxAVwQR4VwBI%3D%0A) ### Artifacts @@ -182,7 +182,7 @@ Navigate to **[Analytics > Claude Chat](https://claude.ai/analytics/usage)** to - Top 10 users by artifacts generated (month-to-date, quarter-to-date, year-to-date, 1 year) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515899838/33d737f2357d6e485704669962ae/43faadc3-47da-4a93-bbb7-47a7983e7441?expires=1787744700&signature=241977d27100ea478bead35fc097f14ff3123e709bd491703cd17a43b6cf0e75&req=diUmE8F3lIlcUfMW1HO4zcSk4r3VeurHjHDogqK0V%2BxA1HJS%2FaGPCpffx3hA%0A59ZN%2FsPmAroeXwHHKog%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515899838/33d737f2357d6e485704669962ae/43faadc3-47da-4a93-bbb7-47a7983e7441?expires=1787829300&signature=0f031906f9aaee61120db1918b40ccf9fc6b878a659b9442ab89c67c41a3372f&req=diUmE8F3lIlcUfMW1HO4zcSk4r3afOfDjHDogqK0V%2BzSbs4IqYcWCN4Sbg1B%0AhqkIZgP8k5mDmfxPvOA%3D%0A) --- @@ -278,7 +278,7 @@ Navigate to **[Analytics > Cowork](https://claude.ai/analytics/cowork)** to view - Daily, weekly, and monthly active Cowork users -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515901489/8005693d55b7fefbfe9233258d39/106c22a0-3f47-47a6-abbd-4788dd70f218?expires=1787744700&signature=9ba7811ba301c1e379b481ced338e90f00d66bc71e1d41b202876ce0a9904161&req=diUmE8B%2BnIVXUPMW1HO4zX7WEo%2B2WUWvFSi1Z3SzLLsZBsvj%2BIdrWH3JvCn4%0A2qS%2FrzE6Z6U7byweeEk%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2515901489/8005693d55b7fefbfe9233258d39/106c22a0-3f47-47a6-abbd-4788dd70f218?expires=1787829300&signature=41d37832a8d89f8d4befa83b54119ecadbd97e468fb31ea321e0e81e64aef5fd&req=diUmE8B%2BnIVXUPMW1HO4zX7WEo%2B5X0irFSi1Z3SzLLvLkSYQo%2FQmVZ2HPHjG%0ApLMC%2BJ%2BIIAcEIPmY45k%3D%0A) **Note:** Cowork analytics are available alongside Chat and Claude Code data in the **[Analytics API](https://platform.claude.com/docs/en/manage-claude/analytics-api)**. @@ -288,7 +288,7 @@ Navigate to **[Analytics > Cowork](https://claude.ai/analytics/cowork)** to view When your admin turns on individual usage analytics, any member of the organization can see their own usage broken down by product, model, and skill, along with where they stand against any spend limits set for them. Individual usage analytics are available in **[Settings > Usage](https://claude.ai/settings/usage)**. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2533906328/1f5cd0a57def40676410f8f379b4/member-usage-30d-model.png?expires=1787744700&signature=c5e89fc29f58503010ce0b7dfd731b1682e62aeb16dcf20c11636e72333d10e6&req=diUkFcB%2Bm4JdUfMW1HO4zfveB6jCeO%2FdWGUKUw6QS4%2FiZ%2FshQQwo0NY1%2FnGY%0ANLfRvECJo4pjv7IJy28%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2533906328/1f5cd0a57def40676410f8f379b4/member-usage-30d-model.png?expires=1787829300&signature=d7bf0428a30b9e8d230689e7903304320ee495e1532f6d5b75461a4bbff5d3a6&req=diUkFcB%2Bm4JdUfMW1HO4zfveB6jNfuLZWGUKUw6QS4%2FqmnkdVvQRbs%2F%2B7CTS%0Ao27BvV0TCgO5ybC4dQc%3D%0A) --- diff --git a/content/support/12902446-claude-in-chrome-permissions-guide.md b/content/support/12902446-claude-in-chrome-permissions-guide.md index ef597d659..7d9cd28e4 100644 --- a/content/support/12902446-claude-in-chrome-permissions-guide.md +++ b/content/support/12902446-claude-in-chrome-permissions-guide.md @@ -28,7 +28,7 @@ In "Manually approve," Claude checks with you before it acts. What that looks li Claude creates a plan from your prompt, which you can approve before Claude starts. The plan specifies which websites you're allowing Claude to access, as well as the approach it will follow: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1843320727/8d1c859ae9b8e0cdb536d024bf40/9bc3d239-8eb6-4bae-a032-a236f88ee606?expires=1787744700&signature=3a3064a1eb267046d4d8cf34c1f4601b07c09962a0e3f16317c23f37a5011e58&req=dSgjFcp8nYZdXvMW1HO4zYqyZcVK%2BIawgN0ADj5oqFDBN77UvFrPQPEGD29h%0AK58UDZ7rDpgIj%2BBlJTw%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1843320727/8d1c859ae9b8e0cdb536d024bf40/9bc3d239-8eb6-4bae-a032-a236f88ee606?expires=1787829300&signature=bd9741c5d13b05f004c59a2cabafbf028739c21700aadc645591ddd73225cb76&req=dSgjFcp8nYZdXvMW1HO4zYqyZcVF%2Fou0gN0ADj5oqFBgoqTqZkq0nvgcNMqt%0A1M42LlicSPPOqlnZvUQ%3D%0A) Note that Claude will only use the websites listed in the plan, so you’ll need to manually approve any additional access requests. @@ -62,7 +62,7 @@ When you choose "Skip all approvals," Claude doesn't pause to ask, and nothing c There are some websites on which Claude requires approval for every action. If you navigate to one of these sites, a **New permissions required** prompt will appear in the extension side panel, Claude Cowork, or Claude Code where Claude will ask for permission before accessing the page or taking any action. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2604970825/d7b961271be69e7541b406df1efd/d845324e-6b4a-4f54-83b9-0bea86ec09c6?expires=1787744700&signature=3c3f2524d86cba556a8fae0a944f0a67b33601a045f37d3dc2f34177cc232bc0&req=diYnEsB5nYldXPMW1HO4zZ3NqmF3jCjr7A4lHPBihAXalh1RFhfL7Ustsw7o%0AGgq5CBDg7q7OEaZP100%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2604970825/d7b961271be69e7541b406df1efd/d845324e-6b4a-4f54-83b9-0bea86ec09c6?expires=1787829300&signature=7a812125b1859c7f60129fc351d75a88d53514776950d35c4a32af88fc1ee7f7&req=diYnEsB5nYldXPMW1HO4zZ3NqmF4iiXv7A4lHPBihAXNmRNT%2BvBlz6eiVA%2F8%0AvM056Wf3%2FTYdHoara20%3D%0A) ### Permission options diff --git a/content/support/12997503-team-plan-billing-faqs.md b/content/support/12997503-team-plan-billing-faqs.md index b45eb695a..444ded7c6 100644 --- a/content/support/12997503-team-plan-billing-faqs.md +++ b/content/support/12997503-team-plan-billing-faqs.md @@ -18,7 +18,7 @@ Your organization's billing address determines where your invoices are sent. You If you want to use a name other than the one tied to your payment method, an organization Owner should check the "Use a different name on invoices" box when adding or updating your payment method in **[Organization settings > Billing](https://claude.ai/admin-settings/billing)**: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1922145253/f2e3d4e0fe43a2ea07e89244764c/image.png?expires=1787744700&signature=818e5f38047e48796222e8ce9f0797c4fbd1357a6760a03be3ea8c8d4e0d6332&req=dSklFMh6mINaWvMW1HO4zRZTxF3Gv8%2FUKAqLF4ERnlWQLWLNKbIW1YaUSGg%2F%0Acd6uCF4Ymiq2SePLpk4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1922145253/f2e3d4e0fe43a2ea07e89244764c/image.png?expires=1787829300&signature=dc285aa15b3cd8a6b89add68acda2c43a82b2bb4678a6a05d8ce1cef56263a42&req=dSklFMh6mINaWvMW1HO4zRZTxF3JucLQKAqLF4ERnlWg4MOzIJ41mUil%2Bjip%0AgBopwv9Tz8vDRupyZNk%3D%0A) ## When will I be billed? diff --git a/content/support/13015708-access-the-compliance-api.md b/content/support/13015708-access-the-compliance-api.md index cbee31ebb..b193140f6 100644 --- a/content/support/13015708-access-the-compliance-api.md +++ b/content/support/13015708-access-the-compliance-api.md @@ -2,9 +2,11 @@ The Compliance API lets your organization programmatically pull activity feed events, chat data, and file content across all your Claude deployments. Use it to monitor, audit, and meet compliance requirements with your own tools. -The Compliance API is generally available to Claude Enterprise plans, excluding Public Sector organizations, and Claude Platform customers in Claude chats. +The Compliance API is available to Enterprise plan organizations, excluding Public Sector organizations, and to Claude Platform customers in Claude chats. -Compliance API coverage now extends to Cowork (via Claude, Claude Desktop, and Claude Mobile) and Claude Code (via CLI and Claude Desktop), in beta for Claude Enterprise customers. It uses your organization's existing Compliance Access Key and settings, so no additional integration is required. This beta doesn't include Claude Code on web, Claude Code accessed through the Claude Platform, or sessions run on Amazon Bedrock or Google Vertex AI. +Coverage also includes Cowork (via Claude, Claude Desktop, and Claude Mobile) and Claude Code (via CLI and Claude Desktop). Coverage for the Claude for Microsoft 365 add-ins (Excel, Word, PowerPoint, and Outlook) and Claude Science is available in beta. All of these use your organization's existing Compliance Access Key and settings, so no additional integration is required. + +Coverage doesn't include Claude Code on the web, Claude Code accessed through the Claude Platform, other Microsoft 365 apps, or sessions run on Amazon Bedrock or Google Vertex AI. ## Compliance API technical documentation diff --git a/content/support/13065128-claude-in-chrome-admin-controls.md b/content/support/13065128-claude-in-chrome-admin-controls.md index c440f5d8b..0e775d679 100644 --- a/content/support/13065128-claude-in-chrome-admin-controls.md +++ b/content/support/13065128-claude-in-chrome-admin-controls.md @@ -6,7 +6,7 @@ Claude in Chrome admin controls are available for Team and Enterprise plans. Claude in Chrome is a browser extension that allows Claude to read, click, and navigate websites on behalf of your users. As an owner, you control whether the extension is available for users to install and which sites they can access. -**Note:** On Max and Team plans, the side panel runs as a Claude Cowork session, and this is rolling out to Pro plans in the coming weeks. On Enterprise plans, the side panel runs as a Cowork session once you've enabled it for your organization—see **[Enable the Cowork side panel](#h_bdb63199e1)** below. Where the Cowork side panel isn't enabled, users have the classic side panel, and your existing organization settings apply to it unchanged. +**Note:** On Max and Team plans, the side panel runs as a Claude Cowork session, and this is rolling out to Pro plans in the coming weeks. On Enterprise plans, the side panel runs as a Cowork session once you've enabled it for your organization—see **[Enable the Cowork side panel](https://support.claude.com/en/articles/13065128-claude-in-chrome-admin-controls#h_bdb63199e1)** below. Where the Cowork side panel isn't enabled, users have the classic side panel, and your existing organization settings apply to it unchanged. ## Access Claude in Chrome settings @@ -26,7 +26,7 @@ Use the **Enable for your team** toggle to enable or disable Claude in Chrome fo - **Enterprise plans:** The extension is disabled by default. Enable it when you're ready for users to access the feature. -Claude in Chrome and Claude Cowork are managed separately. Enabling Claude in Chrome for your organization lets users use the extension. Whether Claude can use it within Cowork is a separate capability setting, and users' browsers still need the extension deployed or installed. For Cowork admin settings, see **[Use Claude Cowork on Team and Enterprise plans](https://support.claude.com/en/articles/13455879-use-claude-cowork-on-team-and-enterprise-plans)**. +Claude in Chrome and Claude Cowork are managed separately. Enabling Claude in Chrome for your organization lets users use the extension. Whether Claude can use it within Cowork is a separate capability setting, and users' browsers still need the extension deployed or installed. Cowork also has a browser built into the Claude Desktop app (rolling out this week) that doesn't require the extension; it's off by default on Enterprise plans and managed from **[Organization settings > Cowork](https://claude.ai/admin-settings/cowork)**. You can enable Claude in Chrome, the built-in browser, both, or neither. For Cowork admin settings, see **[Use Claude Cowork on Team and Enterprise plans](https://support.claude.com/en/articles/13455879-use-claude-cowork-on-team-and-enterprise-plans)**. **Note:** When you enable the extension for an Enterprise organization, users are not automatically notified. You may want to communicate availability through your internal channels. diff --git a/content/support/13132885-set-up-single-sign-on-sso.md b/content/support/13132885-set-up-single-sign-on-sso.md index ac6297e1f..d59a1d1bd 100644 --- a/content/support/13132885-set-up-single-sign-on-sso.md +++ b/content/support/13132885-set-up-single-sign-on-sso.md @@ -42,7 +42,7 @@ You can verify multiple domains for a single organization, but all domains must 3. Enter the domain(s) you want to verify in the **Update organization email domains** modal and click the “+” button: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2498843282/561d5ceb1c3a5df75bdfee8bfc3f/d2491145-362d-490b-bdcf-66a0a7656ddc?expires=1787744700&signature=207a5bf4bf20831720ae5d05823b64ee9fec9d69d07263f03b46c4e186e1b6a7&req=diQuHsF6noNXW%2FMW1HO4zSdmHns%2B%2FsCLe3H0OpmIzWHqCa9cNcFVIkXAs2DK%0AsHz0%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2498843282/561d5ceb1c3a5df75bdfee8bfc3f/d2491145-362d-490b-bdcf-66a0a7656ddc?expires=1787829300&signature=dda7be6b9ae4334c48c281c980d7ba11d30969e35c54397a679ddecc08aa0058&req=diQuHsF6noNXW%2FMW1HO4zSdmHnsx%2BM2Pe3H0OpmIzWE6Tl3OLgw1yyDZ%2FKXi%0AgLIp%0A) 4. Click “Save” when you’re finished adding domains. @@ -50,7 +50,7 @@ You can verify multiple domains for a single organization, but all domains must 6. Enter your domain in the text box and click “Continue”: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2047042630/0617a562cd28a7ff0e607d66a30b/6bd08e1d-2b65-40ab-bc79-a257153854c1?expires=1787744700&signature=0125108452a4685a24299a7b7b8b1aafa054b4d3447f030b0801a8d2786c0a06&req=diAjEcl6n4dcWfMW1HO4zWHctRqQk9WtyoyXAW0OlXqYLiMlxamtYbI2ub4n%0AQs50%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2047042630/0617a562cd28a7ff0e607d66a30b/6bd08e1d-2b65-40ab-bc79-a257153854c1?expires=1787829300&signature=22dafc5a4cd7dd762a472dfcbebca5451224b39066641a94f04f1fdd08e3b5d6&req=diAjEcl6n4dcWfMW1HO4zWHctRqfldipyoyXAW0OlXq6OrqeJZ7PBvVUGDnM%0Ag4Ut%0A) 7. The setup screen displays a TXT record. **Copy the full Value using the copy button**—it begins with `anthropic-domain-verification-` and is longer than what's visible in the box. In your DNS provider, add a TXT record with **Host/Name** set to `@` (the root of your domain) and **Value** set to the copied string. Add it alongside any existing TXT records; don't replace them. The value is case-sensitive, so paste it exactly. @@ -76,7 +76,7 @@ Clicking "Refresh" re-checks your DNS; it won't show Verified until the publishe If the record is correct and propagated but the status still shows Pending, contact Support. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2047044496/b8df54a0331784cc9ae8f00112aa/bf9609c1-dc93-4665-a066-4cae2fe4b002?expires=1787744700&signature=1bc579cec74cfa5a6aa140f9bf0aaac91b917de7f8f045e9c8344eadb59dc7dd&req=diAjEcl6mYVWX%2FMW1HO4zVjmWS4Ha3C%2BPM2D8ZcdgrhIPYfR2IG4SqEOUvlx%0AyH5EKcG3L5tcSSOVBuQ%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2047044496/b8df54a0331784cc9ae8f00112aa/bf9609c1-dc93-4665-a066-4cae2fe4b002?expires=1787829300&signature=3a994c686051c4d3354683a4c213dd4f17b59c2d120560003021ee60c80463a3&req=diAjEcl6mYVWX%2FMW1HO4zVjmWS4IbX26PM2D8ZcdgrgqgPq7ozwUpBGCbDZW%0A%2BOTmnE%2FVyL93VndYqEc%3D%0A) **Note:** Once your domain is verified, you'll see a **Restrict organization creation** toggle under **Security** on the Organization and access organization settings page. Enable this if you want to prevent users from creating new Claude or Console organizations—including personal accounts—using your verified domains. @@ -116,7 +116,7 @@ For IdP-specific setup instructions, see: You can now choose to toggle on **Require SSO for Console** and/or **Require SSO for Claude,** on the **Organization and access** page, under the **Authentication** section: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312690200/bd2403586d4f6651ccd79e2a45af/b9f8d7ce-0def-49d9-bfb2-3a14352d7214?expires=1787744700&signature=d0b25520d629b8ccad03e4feb83b64f92551edffac75c3a2a0741e90fc284fc3&req=diMmFM93nYNfWfMW1HO4zdAICwimBngNItXtKivx6ZFkhfYyq%2FJA8DSkKpUa%0AU2QyMzkeFAPSweYOrgA%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312690200/bd2403586d4f6651ccd79e2a45af/b9f8d7ce-0def-49d9-bfb2-3a14352d7214?expires=1787829300&signature=7918f8c33d8814cac35aec0c73e085e38663dd327aea394e0f0d9c3acbe8e0c6&req=diMmFM93nYNfWfMW1HO4zdAICwipAHUJItXtKivx6ZHmSCvwga6NBldR8zsx%0Ao5dxmHjpfD7mBfjl8mo%3D%0A) When SSO is required, users must use the “Continue with SSO” option to log in to their Claude/Console accounts. When SSO is not required, they will have the option to choose “Continue with SSO” or “Continue with email.” diff --git a/content/support/13133195-set-up-jit-or-scim-provisioning.md b/content/support/13133195-set-up-jit-or-scim-provisioning.md index 5dbda8ddc..89e342dfc 100644 --- a/content/support/13133195-set-up-jit-or-scim-provisioning.md +++ b/content/support/13133195-set-up-jit-or-scim-provisioning.md @@ -36,7 +36,7 @@ Use this table to help decide which provisioning mode is right for your organiza Both JIT and SCIM can be combined with **Enable group mappings** to control role or seat tier assignment based on IdP group membership. If you select either of these options for your provisioning mode, **Enable group mappings** will appear within the **User provisioning** section: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312706099/35d5d3ec149880a96bb7acec59f6/a4cfce55-86bf-40b0-b455-c8f412d48e9e?expires=1787744700&signature=10e448c72d9d829c9c666698faa94d30c92fed8132bf5d463ab0380e91988412&req=diMmFM5%2Bm4FWUPMW1HO4zXBDQ6xTCV5xxFMG%2BIEvQSd3yZSuKv7GOxv5MUsE%0AP74lrM%2BdVsvuJFZ%2BjWk%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312706099/35d5d3ec149880a96bb7acec59f6/a4cfce55-86bf-40b0-b455-c8f412d48e9e?expires=1787829300&signature=b4e3693652106f6c89204012718b68889114501678727a52062c7f4f5187c133&req=diMmFM5%2Bm4FWUPMW1HO4zXBDQ6xcD1N1xFMG%2BIEvQSd2ImGqClYWP%2FBl91AM%0A3KrW%2BoxQkFJWVNeRV1c%3D%0A) **Important:** Group mappings set a user’s role type and seat tier only. Users with the Custom role get their permissions from groups in Claude, and those groups sync from your IdP only when your provisioning mode is SCIM directory sync. With JIT, you need to create groups and add users to them manually in **[Organization settings > Groups](https://claude.ai/admin-settings/groups)**. If you map an IdP group to the Custom role under JIT without doing this, those users have no permissions when they log in. Learn more about **[managing groups on Enterprise plans](https://support.claude.com/en/articles/13799932)**. @@ -122,7 +122,7 @@ Once your IdP is connected, continue to Step 3. 4. Toggle **Enable group mappings** on (if it’s not already): - ![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312714635/b57870b51e6511c8293637bceee2/da1ceabc-b6bc-451b-9cda-24ff6aa90d02?expires=1787744700&signature=e84ec5373261ea015bb9d2610e0c1c5aaa0db6402f745470a8a0636fd83ecb95&req=diMmFM5%2FmYdcXPMW1HO4zeBEbsLfk%2F5Pyb72rapuHpP5aTMIA8vkW38ab47T%0ARi8d%0A) + ![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312714635/b57870b51e6511c8293637bceee2/da1ceabc-b6bc-451b-9cda-24ff6aa90d02?expires=1787829300&signature=b0eca0fe152f7d48083313f1a46338de9952933b7be6e56815b560fe8aff8459&req=diMmFM5%2FmYdcXPMW1HO4zeBEbsLQlfNLyb72rapuHpN6iTahSB5aXQrY%2FZXI%0Atij6%0A) 5. In the **Enable group mappings** section, click “Add” next to each role and select the corresponding group from your IdP in the dropdown. @@ -174,7 +174,7 @@ Verify you have enough seats purchased and available to add members to your org. 4. **For SCIM:** Click "Sync" to prompt an immediate sync, or wait for the automatic sync cycle: - ![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312717421/c97fce49ad17d4660880a05fbaaf/59fbfa2a-1072-4662-8ca5-102970d5a795?expires=1787744700&signature=87c1f3f3ff7a1b547aef0216e44c8d696e89893aaa4a9e8d78740582f4e6a1be&req=diMmFM5%2FmoVdWPMW1HO4zZ9La1qqHc7F5hujYvMis4cvdF%2FilfFq9JFZXkvP%0A6KcV%0A) + ![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312717421/c97fce49ad17d4660880a05fbaaf/59fbfa2a-1072-4662-8ca5-102970d5a795?expires=1787829300&signature=7df461eaa4a470f9e8abbc9b00088ff69fd812f68f3b4b0232121035363e29fc&req=diMmFM5%2FmoVdWPMW1HO4zZ9La1qlG8PB5hujYvMis4ccjF4ETDg8%2BoLPdv6N%0AvjaW%0A) ### Users mapped to the Custom role can't access anything after logging in diff --git a/content/support/13163631-configuring-session-security-settings.md b/content/support/13163631-configuring-session-security-settings.md index 6597ea42b..93eee39a6 100644 --- a/content/support/13163631-configuring-session-security-settings.md +++ b/content/support/13163631-configuring-session-security-settings.md @@ -18,7 +18,7 @@ Session duration controls allow Enterprise and Console Admins to set a maximum s 5. Confirm your selection by clicking “Enable.” -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1888469436/1725e63ea1a2615948faecf4ec73/9bd276a1-7329-414d-87a1-d04dac93fff7?expires=1787744700&signature=480d4d5f857779df47d5c1ecd90cd2fbce86247827f8d15190903b907f491ea6&req=dSgvHs14lIVcX%2FMW1HO4zQNx6%2BUgR15Xg%2F6XaftFnjzDAb8igZCYrDyZq5vJ%0A7nPYiD75%2FmZlxVJRFfU%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1888469436/1725e63ea1a2615948faecf4ec73/9bd276a1-7329-414d-87a1-d04dac93fff7?expires=1787829300&signature=2465f9be7e8d5cc74fed358714ff49b417260ec6b9c59a7e03bde82a403c3490&req=dSgvHs14lIVcX%2FMW1HO4zQNx6%2BUvQVNTg%2F6XaftFnjwaN1O4q%2B%2BklpJcSevR%0A9ZEQ0fgEsskBc046P4o%3D%0A) ### For Console Admins @@ -32,7 +32,7 @@ Session duration controls allow Enterprise and Console Admins to set a maximum s 5. Confirm your selection by clicking “Enable.” -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1888469435/7a766bbe02e61c7d8f05deb5b8f0/b0bda400-47c6-43dd-9907-131ebe180b36?expires=1787744700&signature=83e0c3bb952ae12007e046e3f0dfcba025711865439bfe31c1c8d73be4645d34&req=dSgvHs14lIVcXPMW1HO4zWzx2L4xI3smXZ5D7eVpMtc62YX%2BVNJchWKdm1TJ%0Ag6ukA4A4QKQ1h94ZdZI%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1888469435/7a766bbe02e61c7d8f05deb5b8f0/b0bda400-47c6-43dd-9907-131ebe180b36?expires=1787829300&signature=1f6f73817ae83e3ce6ccfda36080531e5edd376b651490cf09c68326028693e1&req=dSgvHs14lIVcXPMW1HO4zWzx2L4%2BJXYiXZ5D7eVpMtc4rMsLch%2BmOIPv7APV%0ABL0eAuNm5ZyAl%2FSyFnU%3D%0A) ### What happens after enabling shortened session length? @@ -50,7 +50,7 @@ You can change the session duration at any time by selecting a new value from th - Sessions scheduled to expire beyond the new duration will have their expiration shortened accordingly. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1888469437/46ac5bc55484ca01556d87a5ade7/b01a7651-ad65-4b32-93ff-16dbc9ca97c0?expires=1787744700&signature=df34bcd6686a08805c5af710d9fcf01ade24aa2a1bc8c0af4f68378ac9267e9d&req=dSgvHs14lIVcXvMW1HO4zZ7mWs%2Bc4z2kA00cbyPOLDW5mCNjJUzJuJOFunyF%0A8S0twz46l9gmPknxH6M%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1888469437/46ac5bc55484ca01556d87a5ade7/b01a7651-ad65-4b32-93ff-16dbc9ca97c0?expires=1787829300&signature=30c860182772d2d97030622f823465a578c356680029daf9099ae4d4d2244871&req=dSgvHs14lIVcXvMW1HO4zZ7mWs%2BT5TCgA00cbyPOLDXZiY46ENVxbo6GwE5d%0AoOqo3KLEi%2FfUd4TiYDg%3D%0A) ## Disabling session length settings diff --git a/content/support/13189465-log-in-to-your-claude-account.md b/content/support/13189465-log-in-to-your-claude-account.md index bebc83053..ee5e4ce5d 100644 --- a/content/support/13189465-log-in-to-your-claude-account.md +++ b/content/support/13189465-log-in-to-your-claude-account.md @@ -2,7 +2,7 @@ When you open Claude on a web browser ([claude.ai](http://claude.ai)), the desktop app, or a mobile app, you will see two different options for logging in to your Claude account. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1893216804/f2209c3ec6cf4fc2e803d13bbc9d/40520c9e-ff82-4a7c-adca-5a064fe18d8c?expires=1787744700&signature=9e9db9a2f9d799b9ea08d2f35825bf8058906238c29527c53aaa28af811e57b2&req=dSguFct%2Fm4lfXfMW1HO4zXg5BoWL5xazzWhrqpWiTMlilo9ThNE29zaeHLpx%0Axv2UNpuPRuILYhJu1eE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1893216804/f2209c3ec6cf4fc2e803d13bbc9d/40520c9e-ff82-4a7c-adca-5a064fe18d8c?expires=1787829300&signature=83a385f90b5ea769995023b6c08b0058ed26685b9a498440844d0dd25c524d45&req=dSguFct%2Fm4lfXfMW1HO4zXg5BoWE4Ru3zWhrqpWiTMnZFpZwLDDIRp0V4qYZ%0ARRy8ivQqFuQcULZPz%2BA%3D%0A) ## Continue with Google diff --git a/content/support/13325567-account-management-faqs.md b/content/support/13325567-account-management-faqs.md index c2e0ef8ae..e7adb84c7 100644 --- a/content/support/13325567-account-management-faqs.md +++ b/content/support/13325567-account-management-faqs.md @@ -44,6 +44,6 @@ The email domain that was used to create your Team or Enterprise plan organizati Owners can remove domains by opening up the same modal and clicking the trash can icon to the right of the domain: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2053873852/1cbccea3b7067e03205f2ff8546b/CleanShot+2026-02-11+at+11_16_07%402x.png?expires=1787744700&signature=2d70d2b266437a80bf8fae46a5a613248420be69304fe7e35d5992cc81e73855&req=diAiFcF5nolaW%2FMW1HO4zUrhFuyfbQwdkeFUnrkrQZhCoVCJgiUiLuutJ%2BZT%0AQqZzyuf5xpXsmQZiHeI%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2053873852/1cbccea3b7067e03205f2ff8546b/CleanShot+2026-02-11+at+11_16_07%402x.png?expires=1787829300&signature=b3da596e14e660f2e1ff5242f8ff2db16d3a4df131d1fcf238efd15651ec8555&req=diAiFcF5nolaW%2FMW1HO4zUrhFuyQawEZkeFUnrkrQZihb60hRqUc4rxXptuB%0AsLYvUnLz8zspF409dSk%3D%0A) While the account creator must use a business email address, you can add public domains like @gmail.com, @yahoo.com, and @hotmail.com as allowed domains for other members of your organization. \ No newline at end of file diff --git a/content/support/13345190-get-started-with-claude-cowork.md b/content/support/13345190-get-started-with-claude-cowork.md index 0c34f9135..df3c32bfc 100644 --- a/content/support/13345190-get-started-with-claude-cowork.md +++ b/content/support/13345190-get-started-with-claude-cowork.md @@ -70,7 +70,7 @@ For important limitations and considerations for Team and Enterprise organizatio - **Projects:** Group related tasks into separate workspaces with their own files, context, instructions, and memory. See **[Organize your tasks with projects in Cowork](https://support.claude.com/en/articles/14116274-organize-your-tasks-with-projects-in-cowork)**. -- **Browser actions:** Claude can open Chrome and work on websites—clicking, typing, navigating, and filling forms—for tasks that touch websites. On Max and Team plans, Pro plans as it rolls out, and Enterprise plans where an admin has enabled it, you can also run a Cowork session directly in the Chrome side panel. See **[Get started with Claude in Chrome](https://support.claude.com/en/articles/12012173-get-started-with-claude-in-chrome)**. +- **Browser actions:** For tasks that touch websites, Claude can open sites, read pages, click, type, and fill forms. On desktop, Claude uses a browser built into the Claude Desktop app by default, with nothing to install. The built-in browser is rolling out gradually this week. If you already use Claude in Chrome, Claude works in your own browser instead, and you can change your preferred browser anytime in **[Settings > Cowork](https://claude.ai/settings/cowork)**. On Max and Team plans, Pro plans as it rolls out, and Enterprise plans where an admin has enabled it, you can also run a Cowork session directly in the Chrome side panel. Learn more in **[Use the built-in browser in Claude Cowork](https://support.claude.com/en/articles/16607400)** and **[Get started with Claude in Chrome](https://support.claude.com/en/articles/12012173-get-started-with-claude-in-chrome)**. --- @@ -158,7 +158,7 @@ As a reminder, you control which connectors Claude can use via the "+" menu in t We tested Claude's safety check extensively before releasing it, including working with outside security experts who tried to sneak dangerous actions past it. It gives you the speed of letting Claude work without interruptions, with a layer of protection that "Skip all approvals" doesn't have: every action still gets reviewed before it happens. *Of course, no defense is perfect and no mode replaces your judgment. For work with real consequences—money, messages sent as you, important files—stay close and review what Claude does or consider switching back to "Manually approve."* -Auto mode applies to all of your existing connectors, plugins, Claude in Chrome, and some Cowork actions like fetching websites. Because Claude does this extra checking for you, **auto mode consumes more of your usage limit than the other modes**. +Auto mode applies to all of your existing connectors, plugins, the built-in browser, Claude in Chrome, and some Cowork actions like fetching websites. Because Claude does this extra checking for you, **auto mode consumes more of your usage limit than the other modes**. **Skip all approvals (Skip)**, formerly "Act without asking." Claude doesn't pause to ask and nothing checks its actions automatically. Only use this when you completely trust every action, connector, file, app, etc. involved in the task. @@ -178,7 +178,7 @@ To set global instructions: 3. Type your instructions in the text box and click "Save": -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2525926874/15324ac4155d7802272e8bdef04b/ec66cd09-a4db-4f1d-8f30-226c9d126333?expires=1787832000&signature=04401821cce8c533387e4c29048e01bb4f6ca451703580c6dae2e0be007e477a&req=diUlE8B8m4lYXfMW3nq%2BgcqgxG%2BD277faVGMqW%2FkK1fj3UBn0LlxqIXEHFzN%0A%2Fis3EcOylHgkGGRrw5uf0eDnVxE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2525926874/15324ac4155d7802272e8bdef04b/ec66cd09-a4db-4f1d-8f30-226c9d126333?expires=1787896800&signature=c80c7c5965663c8c35febf571175f538cf1d9f14c732e38cc99331cd8acf1452&req=diUlE8B8m4lYXfMW3nq%2BgcqgxG%2BD277VbVmMqW%2FkK1c%2BgcpwOAyqTbBRaoNM%0AAtKYpdmhTy2cDX%2BB6%2B1ae5VRd6Q%3D%0A) ### Folder instructions diff --git a/content/support/13346458-customizing-your-console-appearance-settings.md b/content/support/13346458-customizing-your-console-appearance-settings.md index 5a1ad1623..cf75b34ab 100644 --- a/content/support/13346458-customizing-your-console-appearance-settings.md +++ b/content/support/13346458-customizing-your-console-appearance-settings.md @@ -8,4 +8,4 @@ 3. Select from Light, System, or Dark under **Color mode**. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1922579101/ede30d38dca693c59f9c15d79e69/CleanShot+2026-01-08+at+15_45_20%402x.png?expires=1787744700&signature=c96c883eb64bd1e87237d670a95f605fc16ad7414507b2199d670aa12fbdc05e&req=dSklFMx5lIBfWPMW1HO4zRpFC88DSRZxO9Kw38RlAYJir6Qm5L3PsNA%2FpbO2%0Aw%2BxrZcf0AASwa%2Fu%2B3XI%3D%0A) \ No newline at end of file +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1922579101/ede30d38dca693c59f9c15d79e69/CleanShot+2026-01-08+at+15_45_20%402x.png?expires=1787829300&signature=02cfe25b7f6f15a37ea6158817c838c31435ca493859550cb4ad46f5de6fb03f&req=dSklFMx5lIBfWPMW1HO4zRpFC88MTxt1O9Kw38RlAYJIMUgPMGw6xd480PZo%0AA1q8G4cwAmMovbGSo5M%3D%0A) \ No newline at end of file diff --git a/content/support/13364135-use-claude-cowork-safely.md b/content/support/13364135-use-claude-cowork-safely.md index d2da625e7..e220dee63 100644 --- a/content/support/13364135-use-claude-cowork-safely.md +++ b/content/support/13364135-use-claude-cowork-safely.md @@ -38,7 +38,7 @@ For prompt injection attacks to be successful, two things must be true at the sa - Avoid granting access to local files with sensitive information, like financial documents. -- Be deliberate about which sites Claude works in through Claude in Chrome, especially sites where you're signed in or that handle money or personal information. +- Be deliberate about which sites Claude works in, whether through the built-in browser or Claude in Chrome, especially sites where you're signed in or that handle money or personal information. - Extend internet access only to sites you trust. @@ -48,7 +48,7 @@ For prompt injection attacks to be successful, two things must be true at the sa - Be especially cautious with computer use—Claude clicks, types, and navigates your screen directly, without the permission checks that gate other Cowork tools. For details on how computer use works and how to manage permissions, see **[Let Claude use your computer in Cowork](https://support.claude.com/en/articles/14128542-computer-use-safety)**. -**Important:** Cowork has access to Claude in Chrome; we strongly advise against using Claude in Chrome to manage or take actions involving sensitive information. See **[Use Claude in Chrome safely](https://support.claude.com/en/articles/12902428-using-claude-in-chrome-safely#h_044f6a88a7)** for more information about the potential risks. +**Important:** Cowork can work in the browser built into the Claude Desktop app and in Claude in Chrome. Both run the same safeguards, and the same guidance applies to both: we strongly advise against using either to manage or take actions involving sensitive information. See **[Use Claude in Chrome safely](https://support.claude.com/en/articles/12902428-using-claude-in-chrome-safely#h_044f6a88a7)** and **[Use the built-in browser in Claude Cowork](https://support.claude.com/en/articles/16607400)** for more information about the potential risks. Cowork via mobile and web is captured in Compliance API. Learn more about **[retrieving remote sessions in the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-content-data)**. diff --git a/content/support/13371040-log-in-to-your-console-account.md b/content/support/13371040-log-in-to-your-console-account.md index 8af184b77..abe64647b 100644 --- a/content/support/13371040-log-in-to-your-console-account.md +++ b/content/support/13371040-log-in-to-your-console-account.md @@ -2,7 +2,7 @@ When you navigate to the **[Claude Console](https://platform.claude.com)**, you will see two different options for logging in to your Console account. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1935026646/d90d1613a3dbe763fef5abb96e3c/image.png?expires=1787744700&signature=738d3f5b73de9a47204f88391030e3ecae0c3cfb0bb54f1e5e6378d3376beb70&req=dSkkE8l8m4dbX%2FMW1HO4zcrI547rpIQK8vUNcPt4%2B72ep3V8ODspXtImY07F%0AvF%2Fbe2p%2F7j32fil1dbs%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1935026646/d90d1613a3dbe763fef5abb96e3c/image.png?expires=1787829300&signature=2773da17ef6f1ca1f7590bd20b53d16614b1f642e3d6461a45353b0179d92b25&req=dSkkE8l8m4dbX%2FMW1HO4zcrI547kookO8vUNcPt4%2B71zNZwNwwlT1H5Amc%2FE%0AEnNWKJbpkPQk906RX1Q%3D%0A) ## Continue with Google diff --git a/content/support/13455879-use-claude-cowork-on-team-and-enterprise-plans.md b/content/support/13455879-use-claude-cowork-on-team-and-enterprise-plans.md index d3778d7bb..d19c04111 100644 --- a/content/support/13455879-use-claude-cowork-on-team-and-enterprise-plans.md +++ b/content/support/13455879-use-claude-cowork-on-team-and-enterprise-plans.md @@ -54,6 +54,16 @@ For Team and Enterprise plans, there's a separate organization-wide toggle in ** - **Enterprise plans:** off by default. An owner turns on "Run Cowork in the cloud," then grants the Cowork in the cloud capability to a group with custom roles. See **[Manage custom roles on Enterprise plans](https://support.claude.com/en/articles/13930452-manage-custom-roles-on-enterprise-plans)**. +### Enable or disable the built-in browser + +Claude can use the web in Cowork in two ways: a browser built into the Claude Desktop app, or your users' own Chrome browser through the Claude in Chrome extension. You can enable one, both, or neither. + +- **Built-in browser:** Controlled from **[Organization settings > Cowork](https://claude.ai/admin-settings/cowork)**. On Team plans, it's on by default as it rolls out this week. Team owners can turn it off anytime. On Enterprise plans, it's off by default at launch and turns on by default starting September 10, 2026, unless you've turned it off. When it's off, users can't open the built-in browser and Claude can't use it. + +- **Claude in Chrome:** Controlled from **[Organization settings > Claude in Chrome](https://claude.ai/admin-settings/browser-extension)**, and users' browsers still need the extension deployed or installed. See **[Claude in Chrome admin controls](https://support.claude.com/en/articles/13065128)**. + +Both run the same safety layers: a blocklist for high-risk sites and safety checks on every action. The built-in browser needs the Claude Desktop app open and online; Claude in Chrome needs the extension installed in the user's browser. Learn more in **[Use the built-in browser in Claude Cowork](https://support.claude.com/en/articles/16607400)**. + ### Auto mode availability The organization setting **Allow “Automatically approve” mode** in **[Organization settings > Cowork](https://claude.ai/admin-settings/cowork)** (under Permissions) controls whether members can use "Automatically approve" mode in Cowork. This setting is on by default, so the mode is available to your members unless you turn it off. @@ -124,7 +134,7 @@ Cowork via Claude, Claude Desktop, and Claude Mobile is captured in the Complian ### Local conversation storage -For local sessions, Cowork stores conversation history locally on users' computers. This data is not subject to Anthropic's standard **[data retention policies](https://privacy.claude.com/en/articles/7996866-how-long-do-you-store-my-organization-s-data)** and cannot be centrally managed or exported by admins. Claude Enterprise admins can retrieve this session content in beta through the Compliance API; deletion endpoints for local sessions aren't available yet. +For local sessions, Cowork stores conversation history locally on users' computers. This data is not subject to Anthropic's standard **[data retention policies](https://privacy.claude.com/en/articles/7996866-how-long-do-you-store-my-organization-s-data)** and cannot be centrally managed or exported by admins. Claude Enterprise admins can retrieve this session content through the Compliance API; deletion endpoints for local sessions aren't available yet. ​ For sessions in the cloud, your sessions and files are saved to your Claude account. diff --git a/content/support/13641943-visual-and-interactive-content.md b/content/support/13641943-visual-and-interactive-content.md index 7464b57bd..b321b2799 100644 --- a/content/support/13641943-visual-and-interactive-content.md +++ b/content/support/13641943-visual-and-interactive-content.md @@ -18,7 +18,7 @@ Claude can show current weather conditions and forecasts when you ask about the Claude automatically displays temperatures in Fahrenheit for US locations and Celsius for everywhere else. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2040544927/3a9c695b24df387ecdd766ad308c/8be9f393-dcb0-4ff8-89e8-5fa47bedaa38?expires=1787744700&signature=37599c6458bdb50a2fe235c48222fd7bcb31b6036095c5ea932113da54b703a1&req=diAjFsx6mYhdXvMW1HO4zXlB7Tm90RyPdgndksVD5R2e%2BVBIl%2B5JVpFSKRgf%0AlfM0c9rCuqfUFi3cVVE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2040544927/3a9c695b24df387ecdd766ad308c/8be9f393-dcb0-4ff8-89e8-5fa47bedaa38?expires=1787829300&signature=f2f1ac862860047cc64129e8fdebe34f2f63f1a90daa51d733e2b9e9273b47b4&req=diAjFsx6mYhdXvMW1HO4zXlB7Tmy1xGLdgndksVD5R0fWxrddp1xyccN56Iv%0A2ce9wpvKd3XXv0b77u4%3D%0A) Weather is powered by Google Maps (). @@ -28,7 +28,7 @@ When you ask about recipes, Claude can display formatted recipe cards that are e **Note:** Visual recipe cards are available on web and desktop only. On mobile, Claude provides recipe information as text in the conversation. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2040544929/12f4c51eda7779d65d3ea2c7ab16/d0f4a314-cff8-421a-b401-10c2bf50374e?expires=1787744700&signature=86f1f699f815cd2f60f6063090ac721c01065dba134da5098f1ab54ee43722ea&req=diAjFsx6mYhdUPMW1HO4zUQpe7cS1lCQrIPm%2FImZVg34AwibPOlwJFqUrM%2Bb%0AVJ%2Fla2Hx99MFpZBAxJM%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2040544929/12f4c51eda7779d65d3ea2c7ab16/d0f4a314-cff8-421a-b401-10c2bf50374e?expires=1787829300&signature=f3ec284577664f29e01037ce2e6c61beaf1a6be30bbc2e92d31ccfe80c1d4bcc&req=diAjFsx6mYhdUPMW1HO4zUQpe7cd0F2UrIPm%2FImZVg2hNZ1hLMZXIW0zQ0We%0ACvLpLgFxMT3mHxgyq44%3D%0A) ### Custom visuals @@ -76,7 +76,7 @@ For example, if you ask Claude to help you plan a trip, it might ask you to: This content appears at the bottom of the chat. You can still type a response if you prefer. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2040544930/9ad066e137d11e4b559b0217e12d/9bf30d2d-1715-42b3-9da5-2a9298f41f08?expires=1787744700&signature=e654108a36240753c1fe92705ba0c7f2ff48df0bb32b0426505dc7fbb5996585&req=diAjFsx6mYhcWfMW1HO4zWmF5%2FK5bRqlx4wz0C7CTAJdPXYebQ2RXfoVaEOR%0A4godWqHC6T%2B07p2OrCs%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2040544930/9ad066e137d11e4b559b0217e12d/9bf30d2d-1715-42b3-9da5-2a9298f41f08?expires=1787829300&signature=a382165e404dbd219b7f00d7185b2f3f7c8f62b7970cee069ba3e5518819b535&req=diAjFsx6mYhcWfMW1HO4zWmF5%2FK2axehx4wz0C7CTALw2rNyWAmDJ1wKoH%2Fs%0AElorvIDro5xO%2B1E6muM%3D%0A) --- diff --git a/content/support/13756069-public-sector-faqs.md b/content/support/13756069-public-sector-faqs.md index b97020f74..711a0dd17 100644 --- a/content/support/13756069-public-sector-faqs.md +++ b/content/support/13756069-public-sector-faqs.md @@ -6,7 +6,7 @@ Select your product based on both your technical/functional requirements, and also your compliance/security/deployment environment requirements. Here is a list of options: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2197717161/79965a24090029e9e58c727c3c24/pubsec-product-matrix_png+%281%29.jpg?expires=1787744700&signature=e949cd29800492f0cb68e535be1bcdf25a8fc6b7f536823e3539e5babd63386d&req=diEuEc5%2FmoBZWPMW1HO4zU94Ll4iGdk32WxtU42UVC3Y0HfcWI23PbZHmA0d%0AYeoOC%2BNBJ3kx5skRoF4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2197717161/79965a24090029e9e58c727c3c24/pubsec-product-matrix_png+%281%29.jpg?expires=1787829300&signature=d01742ce317ab3d2a910238acda237dfb2b6b333955e39ec9323894c61b992a3&req=diEuEc5%2FmoBZWPMW1HO4zU94Ll4tH9Qz2WxtU42UVC3IyJgYbyRiE%2BkvJi%2BJ%0ACYYBa9ZACbcogw9XkIg%3D%0A) ### What is Claude for Government (C4G)? diff --git a/content/support/13837433-manage-plugins-for-your-organization.md b/content/support/13837433-manage-plugins-for-your-organization.md index 8b7b47b9b..4af6e4e41 100644 --- a/content/support/13837433-manage-plugins-for-your-organization.md +++ b/content/support/13837433-manage-plugins-for-your-organization.md @@ -110,7 +110,7 @@ Your personal GitHub token is verified to confirm you have access, then Cowork u An initial sync runs automatically when you connect a repository. After that, organization owners can opt-in to continued automatic updates per marketplace by going to **[Organization settings > Plugins](https://claude.ai/admin-settings/plugins)**, clicking the menu button in the upper right corner of the marketplace, then toggling "Sync automatically" on: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2193200015/a239033a9ab19fbd39f1a0d9edce/CleanShot+2026-03-23+at+11_41_31%402x.png?expires=1787744700&signature=e930f4c1158f8ca64f209a58ba38546100cfc885b5521adb3a93c21c71df1867&req=diEuFct%2BnYFeXPMW1HO4zUYv5tr%2BxXsTRDH%2FtUo5ov6tU2IezXf60xpEhNFj%0ACq1%2FZ9RlohQ6SiqwWM0%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2193200015/a239033a9ab19fbd39f1a0d9edce/CleanShot+2026-03-23+at+11_41_31%402x.png?expires=1787829300&signature=f4d4e57efc1dd83f4ccb9296ca899a6536333ea0ec6cdd3b882e7917464e376e&req=diEuFct%2BnYFeXPMW1HO4zUYv5trxw3YXRDH%2FtUo5ov53bShw1VLwHrC5nkx%2B%0A7ET%2FXZsBUq5nX6iRZ74%3D%0A) Enabling automatic sync creates a webhook on the connected repository. The person turning the toggle on must have admin-level access to that repository on GitHub. This is checked through their personal GitHub connection, which is separate from the Claude GitHub App installation. Without admin access, the page shows "Cannot access repository. Ensure the repository exists and the Claude GitHub App is installed," even when the App is installed correctly and manual updates work. diff --git a/content/support/13837440-use-plugins-in-claude.md b/content/support/13837440-use-plugins-in-claude.md index 0d601969a..662c92d30 100644 --- a/content/support/13837440-use-plugins-in-claude.md +++ b/content/support/13837440-use-plugins-in-claude.md @@ -40,7 +40,7 @@ In Cowork, open the "Cowork" tab first, then open **Customize**. You can also upload a custom plugin file if you built one yourself or received one from a colleague. On Claude Desktop and in Cowork, plugins you add yourself are saved locally to your computer. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2100409211/fc01614dde1a616fa31ffaa9cb04/47bacf5b-a810-45b5-a468-9769f1a58ef8?expires=1787744700&signature=9c5357ec8447ec2ac622990fbf12ee90509c3900d141a6f72ff5b661d6966107&req=diEnFs1%2BlINeWPMW1HO4zZF3IhLaN%2FFSxakFVfq5WwwlZYa3EGpGgxEzhhDs%0AgNdFDNEIGVraVM9eWIs%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2100409211/fc01614dde1a616fa31ffaa9cb04/47bacf5b-a810-45b5-a468-9769f1a58ef8?expires=1787829300&signature=9f38147f9bebc433b4519e9bc802df68c0fcaf9ed764b979e4aa8b755c13e200&req=diEnFs1%2BlINeWPMW1HO4zZF3IhLVMfxWxakFVfq5WwwUC7KGyBCOLNWndh3P%0A%2BIjUZmuMHtlpgotsbKo%3D%0A) If you're on the Enterprise plan and your organization has skill scanning turned on, plugins are checked for malicious content when they're installed or updated. A plugin with malicious content is blocked, and one that may carry risk shows a caution banner. Learn more about **[skill and plugin scanning](https://support.claude.com/en/articles/15927065)**. @@ -50,7 +50,7 @@ If you're on the Enterprise plan and your organization has skill scanning turned Each plugin you install adds skills you can use while working with Claude. Type "/" or click the "+" button to see the available skills from your installed plugins, in chat and in Cowork. Click any skill to see its details. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2157396844/4a790e10f5b88df770783df1d7e9/image.png?expires=1787744700&signature=af15ad54134710195c6eff43c4bebb514400850327ae04bd67bad9819907803d&req=diEiEcp3m4lbXfMW1HO4zf4NBPH7h0STmKUxugP2BQtTxGQti3D%2FBFt51jDp%0AOpSKYliTMUMlFeh20AI%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2157396844/4a790e10f5b88df770783df1d7e9/image.png?expires=1787829300&signature=7cead477d4736e6a47ccd0a84824086ab95598aaff8a528f016d135361758964&req=diEiEcp3m4lbXfMW1HO4zf4NBPH0gUmXmKUxugP2BQv7Zo2AOuB5DaoLjf4H%0ABZyoPsw%2BsdfABhEvrf8%3D%0A) --- diff --git a/content/support/13854387-schedule-recurring-tasks-in-claude-cowork.md b/content/support/13854387-schedule-recurring-tasks-in-claude-cowork.md index d7978639d..31dd7d4ac 100644 --- a/content/support/13854387-schedule-recurring-tasks-in-claude-cowork.md +++ b/content/support/13854387-schedule-recurring-tasks-in-claude-cowork.md @@ -52,7 +52,7 @@ There are two ways to create a scheduled task: 6. You can explicitly confirm you want to schedule the task when prompted by Claude by clicking “Schedule": -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2104085399/4dda7e6f76026fd827db0b9323a9/f20635bf-15e7-4978-a213-5b9f67e9fb9a?expires=1787744700&signature=bbf74b8969ac904e245f0d02d94f5b1180613cc1fe5ed9da841451780c5a189a&req=diEnEsl2mIJWUPMW1HO4zeLJBkLj%2B%2B6APx%2FSrZI7l8zGcyc1R5ni4HeFEHs6%0AM9t4%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2104085399/4dda7e6f76026fd827db0b9323a9/f20635bf-15e7-4978-a213-5b9f67e9fb9a?expires=1787896800&signature=8192eb3586980ac901244954048b1576af98f8010d764f900caaa76aa498b119&req=diEnEsl2mIJWUPMW3nq%2BgUR7lfEEQ4zIv3XPHMydoUN0stPypwqOn%2FuPcJ7Y%0AvI%2F9p7HDKonBhPGhn4Re%2F7%2FUJd4%3D%0A) 7. Claude will create and schedule your task, and it will be added to the **Scheduled tasks** page. diff --git a/content/support/13947068-assign-tasks-from-anywhere-in-claude-cowork.md b/content/support/13947068-assign-tasks-from-anywhere-in-claude-cowork.md index 68266e3d1..9030c3f62 100644 --- a/content/support/13947068-assign-tasks-from-anywhere-in-claude-cowork.md +++ b/content/support/13947068-assign-tasks-from-anywhere-in-claude-cowork.md @@ -48,11 +48,11 @@ Follow these steps to get started: 5. You’ll land on a page describing the functionality. Click “Get started”: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2169954086/419674f781edb2977b93cce062b4/93b1893c-d79a-4eb6-b2f1-2fe3e043bd90?expires=1787744700&signature=d4f3ebc1b7233c220f386ff3014a2ce020f6d5293b2fa8b63d43237e56fb69a5&req=diEhH8B7mYFXX%2FMW1HO4zSZP0pWMEQr4B32drIe5EDnZ6wucgd0hEVF%2FWVtm%0AVjR7%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2169954086/419674f781edb2977b93cce062b4/93b1893c-d79a-4eb6-b2f1-2fe3e043bd90?expires=1787896800&signature=329e8a6c06dae6db519a6f374fa1832f5417d5c87ac15d94cc8e3ec644a61528&req=diEhH8B7mYFXX%2FMW3nq%2BgUgtmyeeWYE7B5y4NuMmOh4OL3qJhes3tKg0Vvyj%0ASz6v4vKZt7I0usqUWxvbZPcUDsM%3D%0A) 6. On the next screen, you can give Claude access to your files and keep your computer awake by toggling those on: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2169955082/de4053ee0eab8fcb9263584bb171/d39b77da-1a69-4682-9fdb-7ed488f236b0?expires=1787744700&signature=71fb2445893c807d6ba5852ac92300f81922a8327555b6d4f21fbe9512611fd6&req=diEhH8B7mIFXW%2FMW1HO4zaZWs92fWQUZepuGRb1rD3Iqlyr17SDA1PvGna4N%0Algod%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2169955082/de4053ee0eab8fcb9263584bb171/d39b77da-1a69-4682-9fdb-7ed488f236b0?expires=1787896800&signature=08ff660ee95dc3faddd0c22d4c11c26676c55e70784157c61fdbeb40fa1caf3d&req=diEhH8B7mIFXW%2FMW3nq%2BgctAEttDz%2FtkDPIGaHdOkURa6%2FuaAt9exk90oOHn%0AAMtFAFt4l%2Fm%2BgQYxg9cQfgHQrF8%3D%0A) 7. Click “Finish setup.” diff --git a/content/support/14116274-organize-your-tasks-with-projects-in-claude-cowork.md b/content/support/14116274-organize-your-tasks-with-projects-in-claude-cowork.md index 4510ca628..0ed223a60 100644 --- a/content/support/14116274-organize-your-tasks-with-projects-in-claude-cowork.md +++ b/content/support/14116274-organize-your-tasks-with-projects-in-claude-cowork.md @@ -22,23 +22,23 @@ Cowork is available for paid plans (Pro, Max, Team, Enterprise) on: Find **Projects** in the left navigation panel and click the “+” button to see the three different ways to create a project: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2183720240/6f6ef438913391703598d86d606c/CleanShot+2026-03-20+at+09_11_43.png?expires=1787744700&signature=be672dd518be7451965a9fb6e47e587e0384ccb3865e0bcfee95bd1128acabd0&req=diEvFc58nYNbWfMW1HO4zcOgiwK91SxyZwSvwegvtgyTVPWalrcNAYfypSdH%0A%2BWgZBZGKqspfxQvUbEU%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2183720240/6f6ef438913391703598d86d606c/CleanShot+2026-03-20+at+09_11_43.png?expires=1787896800&signature=eb590c804999fa0bc2d498b4f0e3097d90fcb16e63b0058d2e8519df928fd930&req=diEvFc58nYNbWfMW3nq%2BgS9JzlhV7PyFR7XmZ15UIz3iHoAQZl%2F4GkudqaIQ%0A6j6muy8XGVXq1g5WaKN56v6g%2BFw%3D%0A) ### Start from scratch Selecting “Start from scratch” allows you to set up a new folder with instructions and files: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2177090014/07832b50003cf7fd3b4e9c7c448b/3385d9b8-c3e7-42b9-ae3f-4d213baa53a7?expires=1787744700&signature=4b7dbee4c36390303b1071273061c33f3ee5266cb3bb9f5c89779c383dbc1b84&req=diEgEcl3nYFeXfMW1HO4zZCoQ4pCSnGRvb0suCMAnj3CQ8w0BLWI4wjGIytF%0AtE%2BZhTmjzkKitRPUVqU%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2177090014/07832b50003cf7fd3b4e9c7c448b/3385d9b8-c3e7-42b9-ae3f-4d213baa53a7?expires=1787896800&signature=8c49b1f9663968c89f43835442cb845d21b6389d980cc236402a95238882d4a3&req=diEgEcl3nYFeXfMW3nq%2BgQzh0zjpgy%2FBy3N%2FmMBCSA1H6%2FFQBmsacwxVxjLe%0AAcM1qcom5cSD9Rv7kxneTdRSLyE%3D%0A) ### Import from a Claude project After selecting “Import from project,” you’ll see a “Search projects in Chat…” field: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2183717962/acdc11bcc825ae76a13f508365bc/CleanShot+2026-03-20+at+09_12_08.png?expires=1787744700&signature=36cde8fd03a1fcb5be3b886ffc45aeadfbbd217481ff9f2fe6fe0043b9ba298b&req=diEvFc5%2FmohZW%2FMW1HO4zQQ7UGRazpwYjggUT7FIJz%2FYsrH9AN%2BgYWWQWSub%0At8OplFnF%2F5R58CcwlW0%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2183717962/acdc11bcc825ae76a13f508365bc/CleanShot+2026-03-20+at+09_12_08.png?expires=1787896800&signature=4563d380730f6aa846bbe76552db2b8db564cccde45b1cac3ce6249028e3c121&req=diEvFc5%2FmohZW%2FMW3nq%2BgTD%2BXnQOQAtufciJnMKe4Xu11CVvLgeXQd4iu6UU%0A3p%2BMZ5tfYVtdz0%2F7Uwa0viwJouU%3D%0A) Clicking into the field will display a drop-down showing your recent projects, but you can also use it to search all your projects. After you select a chat project (bulk upload is not supported), you can name the new Cowork project and choose where to save it on your computer: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2183727973/7a25430123d9e13e7c3cdd411f70/CleanShot+2026-03-20+at+09_13_41.png?expires=1787744700&signature=133020309b05a479c0ce8e2bd828b104340ea48ddc2c7b436e3062ccc8a16992&req=diEvFc58mohYWvMW1HO4zU%2FKAiRB%2BCfLI7f%2FdY0VL6hM4rpKQj3URtX5JJ2K%0ArGt3i8s8YuI8fAwVUqE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2183727973/7a25430123d9e13e7c3cdd411f70/CleanShot+2026-03-20+at+09_13_41.png?expires=1787896800&signature=adf3a0ef3de6f413e44d7feb6b7797ba416dabef636f4ec12b9e59e7ab1797e5&req=diEvFc58mohYWvMW3nq%2Bga1gukvi%2FcgPoQuHI3TxybMqNMt%2FQ9s8eUJXjbdG%0AKul61PhehPtHYCjIelZw4L3QBtw%3D%0A) Clicking “Create” will transfer the files and instructions from your existing Claude project and create a new Cowork project. @@ -46,11 +46,11 @@ Clicking “Create” will transfer the files and instructions from your existin If you select “Use an existing folder,” you’ll be prompted to pick a file to use as context for the new Cowork project: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2177087935/2f0052dae601d0b7fecdc029e1c3/2e3ca9e7-23b1-436e-bbdb-edcd31c41f15?expires=1787744700&signature=5011c89dd0e988fce046c4c0e9c1cf7d47e7ea21794777cf3d673204347b01ff&req=diEgEcl2mohcXPMW1HO4zejrnzHRESdYuv8e2Xj2xOUrXSoALKXbj1QGSZyr%0A7bGoKWnVhKb42X8w2aI%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2177087935/2f0052dae601d0b7fecdc029e1c3/2e3ca9e7-23b1-436e-bbdb-edcd31c41f15?expires=1787896800&signature=d30a17c54d97b299eaecf69907c0bbddfb313824954bebd7ae82bd48a2c88047&req=diEgEcl2mohcXPMW3nq%2BgQekV9tSOcMbF5AJNd33oKo4MMynep%2Fv4SHqa7vh%0A4axObwZeuNe5zUbgMtXX3Oz0GJs%3D%0A) After selecting a folder, you can name the new Cowork project, choose where to save it on your computer, add instructions, and attach any additional files. Click “Create” to start using your new project: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2177087937/f59dbe3fc28448a9597ea097cb4d/96a59acb-4054-4b4b-a208-751f9711f535?expires=1787744700&signature=58ae8ccb044c19fd73feaf9410566e345b52ff5775837a8d85508aa4d3822fd8&req=diEgEcl2mohcXvMW1HO4zUq4V%2BSzh6Y9MfnqHouW6MLlgW5LVU4pvZr%2FhQNO%0A7Oazm%2BFfCd6b%2FpHgmfQ%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2177087937/f59dbe3fc28448a9597ea097cb4d/96a59acb-4054-4b4b-a208-751f9711f535?expires=1787896800&signature=9f8bf7965b4c3e91065726f45d791529ae62bcde1181cc9bb185a648a7e8ed1f&req=diEgEcl2mohcXvMW3nq%2BgY9ePC75r4f5qMmgV6Sj3BITGBKlJ2aJMd6YO1Ty%0Aa9hUk2HoZ2tFyouGzbpWguxoXpY%3D%0A) --- diff --git a/content/support/14128542-let-claude-use-your-computer-in-cowork.md b/content/support/14128542-let-claude-use-your-computer-in-cowork.md index d2aca1277..05dd9baf8 100644 --- a/content/support/14128542-let-claude-use-your-computer-in-cowork.md +++ b/content/support/14128542-let-claude-use-your-computer-in-cowork.md @@ -12,7 +12,7 @@ In Cowork, Claude uses the most precise tool first. When you assign a task, Clau 1. **Connectors.** If a connector is available—like Gmail, Google Drive, or Slack—Claude uses it. This is the fastest and most reliable path. -2. **Browser.** When there isn’t a connector for the tool you need, Claude can navigate the Chrome browser to work on your task using Claude in Chrome. +2. **Browser.** When there isn't a connector for the tool you need, Claude works on your task in the browser built into the Claude Desktop app, or in your own Chrome browser through Claude in Chrome if that's your preferred browser. Learn more in **[Use the built-in browser in Claude Cowork](https://support.claude.com/en/articles/16607400)**. 3. **Screen interaction.** Claude uses computer use to interact directly with your screen: clicking, typing, and navigating your desktop apps. @@ -40,7 +40,7 @@ If your work involves a physical machine, Claude keeps working while you step aw Claude asks for your permission before accessing each application. You’ll see a prompt and must approve before Claude can interact with that app. Some apps are off-limits by default. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2193297849/243cf7bd2386d92a253c2cec7d32/46cb6fcb-c0ee-4d1c-9974-9c1c1058c81c?expires=1787832000&signature=aa2b1e590c4f072d79fb8e55d3de851a2eee888935bfb1c7733df02e94b33af5&req=diEuFct3molbUPMW3nq%2BgUwo4rVPu%2BGWj5A5uJn0DHqTXU1VQ0QAXYZ5kK6z%0A%2FUSj4DzCnRPzkZeNeNEp4s63t7k%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2193297849/243cf7bd2386d92a253c2cec7d32/46cb6fcb-c0ee-4d1c-9974-9c1c1058c81c?expires=1787896800&signature=a3388b75e2f554090aabe7ae89329fab7d3abd75a27b2d4b80430dbd988e08ea&req=diEuFct3molbUPMW3nq%2BgUwo4rVPu%2BGci5g5uJn0DHrB%2BybJD2uggduzcX9Z%0AaCGQlWkdt4cJHKC%2FHoEpZ8PMWhE%3D%0A) Claude is trained to avoid risky operations—like transferring funds, modifying or deleting files, or handling sensitive data—and to flag signs of prompt injection. However, these safeguards aren't perfect, and Claude may occasionally act outside these boundaries. @@ -128,7 +128,7 @@ To start using computer use: 3. Find the **Computer use** toggle and turn it on: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2193911341/630e6df3b08b27d1c7b4f1ca6a1f/image.png?expires=1787832000&signature=9f915eadc52230dbd406aa9a62cd4e02fc5d49a322757ae766d06ed6c6a53af1&req=diEuFcB%2FnIJbWPMW3nq%2BgdUsBqXcDkFI%2FAcnV%2FJm3T%2FNJ%2F4943AFVojZAhip%0A%2BRyY0lLcy9qT7w7ess5SMtlTbvM%3D%0A) + ![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2193911341/630e6df3b08b27d1c7b4f1ca6a1f/image.png?expires=1787896800&signature=bffe59ae4118f9f19052945ffb8a0ea459e2da8006eaa072178d2c1ac4e50d1f&req=diEuFcB%2FnIJbWPMW3nq%2BgdUsBqXcDkFC%2BA8nV%2FJm3T%2FA8ktDHhdakJPO6zgW%0AKW9lwTsbmGwzN09P6P86gieI%2B%2Fw%3D%0A) 4. Open Cowork or Claude Code in the desktop app and start a session. diff --git a/content/support/14128775-claude-code-on-console-to-enterprise-migration.md b/content/support/14128775-claude-code-on-console-to-enterprise-migration.md index 9a7728348..ac093d373 100644 --- a/content/support/14128775-claude-code-on-console-to-enterprise-migration.md +++ b/content/support/14128775-claude-code-on-console-to-enterprise-migration.md @@ -28,8 +28,8 @@ Claude Enterprise adds rich analytics and audit logs (including contribution met | Disable --dangerously-skip-permissions | ❌ No native UI\* | ✅ permissions.disableBypassPermissionsMode: disable | | Disable auto mode | ❌ No native UI\* | ✅ disableAutoMode: disable | | Custom roles (RBAC) | ❌ | ✅ Scope feature access by group and delegate specific admin areas like billing, user management, and identity without granting the Owner role. **[Manage custom roles on Enterprise plans](https://support.claude.com/en/articles/13930452-manage-custom-roles-on-enterprise-plans)** | -| Model governance | ❌ No native UI\* | ✅ Set an organization default model for chat and Cowork (beta) from the admin console, and restrict Claude Code model selection with `availableModels` in managed settings. **[Set a default model for your organization](https://support.claude.com/en/articles/15330088-set-a-default-model-for-your-organization)** | -| Audit logs | ❌ No audit log support
🟡 Claude Code does have support for **[OpenTelemetry](https://code.claude.com/docs/en/monitoring-usage)** | 🟡 Audit logs and the **[Compliance API](https://support.claude.com/en/articles/13015708-access-the-compliance-api)**, which includes audit log events. Transcripts of local CLI and Desktop sessions are available in beta through the Compliance API for Enterprise plans. | +| Model governance | ❌ No native UI\* | ✅ Set an organization default model for chat and Cowork from the admin console, and restrict Claude Code model selection with `availableModels` in managed settings. **[Set a default model for your organization](https://support.claude.com/en/articles/15330088-set-a-default-model-for-your-organization)** | +| Audit logs | ❌ No audit log support
🟡 Claude Code does have support for **[OpenTelemetry](https://code.claude.com/docs/en/monitoring-usage)** | 🟡 Audit logs and the **[Compliance API](https://support.claude.com/en/articles/13015708-access-the-compliance-api)**, which includes audit log events. Transcripts of local CLI and Desktop sessions are available through the Compliance API for Enterprise plans. | | Usage analytics | ✅ Lines of code written, acceptance rate, daily active users, daily spend.
**[Docs](https://code.claude.com/docs/en/analytics#access-analytics-for-api-customers)** | ✅ Lines of code written, acceptance rate, daily active users, and month-to-date spend per member in **Organization settings** → **Usage.**
**[Docs](https://code.claude.com/docs/en/analytics#access-analytics-for-teams-and-enterprise)** | | Programmatic usage and cost reporting | ✅ **[Claude Code Analytics API](https://platform.claude.com/docs/en/manage-claude/claude-code-analytics-api)** | ✅ The **[Claude Enterprise Analytics API](https://platform.claude.com/docs/en/manage-claude/analytics-api)** returns per-user engagement and Claude Code metrics (commits, pull requests, lines of code) plus usage and cost endpoints. The **[Admin API](https://platform.claude.com/docs/en/manage-claude/admin-api)** covers programmatic org management. | | Contribution metrics | ✅ Via the Claude Code Analytics API | ✅ PRs created and lines of code committed with Claude Code assistance. | @@ -147,16 +147,16 @@ Remove migrated developers from the Console org (or rotate their keys). Removal Moving from Console API to Claude Enterprise unlocks richer analytics for Claude Code usage: -| **Metric** | **Console API** | **Claude Enterprise** | -| --------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Token consumption | ✅ | ✅ | -| Lines of code accepted | ✅ | ✅ | -| Suggestion acceptance rate | ✅ | ✅ | -| PRs created with Claude Code assistance | ✅ Via the Claude Code Analytics API | ✅ | -| Lines of code committed with Claude Code assistance | ✅ Via the Claude Code Analytics API | ✅ | -| Spend limit notifications | ✅ Notify-at-limit emails with configurable recipients | ✅
Threshold alerts | -| Month-to-date spend per member | ❌ | ✅
Admin settings → Usage | -| Compliance audit trail | ❌ | ✅ The **[Compliance API](https://support.claude.com/en/articles/13015708-access-the-compliance-api)** includes audit log events. Transcripts of local CLI and Desktop sessions are available in beta through the Compliance API for Enterprise plans. | +| **Metric** | **Console API** | **Claude Enterprise** | +| --------------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Token consumption | ✅ | ✅ | +| Lines of code accepted | ✅ | ✅ | +| Suggestion acceptance rate | ✅ | ✅ | +| PRs created with Claude Code assistance | ✅ Via the Claude Code Analytics API | ✅ | +| Lines of code committed with Claude Code assistance | ✅ Via the Claude Code Analytics API | ✅ | +| Spend limit notifications | ✅ Notify-at-limit emails with configurable recipients | ✅
Threshold alerts | +| Month-to-date spend per member | ❌ | ✅
Admin settings → Usage | +| Compliance audit trail | ❌ | ✅ The **[Compliance API](https://support.claude.com/en/articles/13015708-access-the-compliance-api)** includes audit log events. Transcripts of local CLI and Desktop sessions are available through the Compliance API for Enterprise plans. | All reporting is accessible from **[Analytics](https://claude.ai/analytics/activity)** in the Claude admin panel. For programmatic access, the **[Claude Enterprise Analytics API](https://platform.claude.com/docs/en/manage-claude/analytics-api)** returns per-user engagement metrics, Claude Code activity (commits, pull requests, lines of code), and usage and cost data. Analytics do not migrate: the Enterprise organization starts with fresh reporting history, and its Analytics/Admin API requires a new API key created in the Enterprise organization — Console keys don't carry over. Export any Console analytics you need for historical dashboards before cutover. Traffic that remains on Console API keys (for example CI) continues to appear only in Console reporting. diff --git a/content/support/14477985-monitor-claude-cowork-activity-with-opentelemetry.md b/content/support/14477985-monitor-claude-cowork-activity-with-opentelemetry.md index 4b60c6f7e..2303c4d01 100644 --- a/content/support/14477985-monitor-claude-cowork-activity-with-opentelemetry.md +++ b/content/support/14477985-monitor-claude-cowork-activity-with-opentelemetry.md @@ -82,4 +82,4 @@ A few things to be aware of before you turn on OpenTelemetry export: ## Joining OpenTelemetry data with the Compliance API -The Compliance API now covers Cowork (via Claude, Claude Desktop, and Claude Mobile) and Claude Code (via CLI and Claude Desktop) alongside Claude chats, giving you one audit trail with every session attributable to an individual user. Organizations already using OpenTelemetry can run both in parallel, and OTel coverage now includes Cowork on web and mobile too. Learn more about **[retrieving remote sessions in the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-content-data)**. \ No newline at end of file +The Compliance API covers Cowork (via Claude, Claude Desktop, and Claude Mobile) and Claude Code (via CLI and Claude Desktop) alongside Claude chats, giving you one audit trail with every session attributable to an individual user. Organizations already using OpenTelemetry can run both in parallel, and OTel coverage includes Cowork on web and mobile too. Learn more about **[retrieving remote sessions in the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-content-data)**. \ No newline at end of file diff --git a/content/support/14499648-how-scim-sync-works-for-enterprise-organizations.md b/content/support/14499648-how-scim-sync-works-for-enterprise-organizations.md index 822b86b72..2f74765a9 100644 --- a/content/support/14499648-how-scim-sync-works-for-enterprise-organizations.md +++ b/content/support/14499648-how-scim-sync-works-for-enterprise-organizations.md @@ -50,7 +50,7 @@ You can trigger a manual sync from two places in your admin settings. 2. Click "Check for updates" under **SCIM sync**: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312613548/44cd5970ee3c3b2c7f8dcd592d71/image+%2824%29.png?expires=1787744700&signature=aa98158fb822ee9f3bad2b7e369321fd30982bff4268b708444c71d9ca0d7489&req=diMmFM9%2FnoRbUfMW1HO4zW4gbDKqMcmzrgfl7PnOium%2B9oAvs1wDdAp4I23X%0AHEjj%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312613548/44cd5970ee3c3b2c7f8dcd592d71/image+%2824%29.png?expires=1787829300&signature=548005aee081d75f54ce099ded04e9cd554678aa7b4228d942e18cb90d2bb0d7&req=diMmFM9%2FnoRbUfMW1HO4zW4gbDKlN8S3rgfl7PnOiunly25Pkp8XRT3eGqgo%0AN6ZB%0A) 3. Select whether to sync members, groups, or both. @@ -62,7 +62,7 @@ You can trigger a manual sync from two places in your admin settings. 3. Select whether to sync members, groups, or both: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312608119/e4b0ef4f309f3c4eac8311a6ef47/image.png?expires=1787744700&signature=a81e9654f9d00062dcd42219f6cb976530dee2e6e05162bd4a65e686bb9c5e7c&req=diMmFM9%2BlYBeUPMW1HO4zX%2F4fr33zz8Y43OpyTHzM9TYNz19E%2FJ89enQ9%2FNz%0A2k3%2F%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312608119/e4b0ef4f309f3c4eac8311a6ef47/image.png?expires=1787829300&signature=1a414caf03bc64326d8d1a0abdab8fa779d5338714d110d493d8b3db6a1aeff7&req=diMmFM9%2BlYBeUPMW1HO4zX%2F4fr34yTIc43OpyTHzM9TCSzbGhhWbQp5y%2B2ph%0AFTn2%0A) **Note:** If you trigger a manual sync while background changes are processing, your organization takes the most recent change for each member or group. If multiple changes are queued for the same member or group, you may need to resync again to make sure everything applies correctly. diff --git a/content/support/14503613-sso-login.md b/content/support/14503613-sso-login.md index 96a949fb5..a5cab0b77 100644 --- a/content/support/14503613-sso-login.md +++ b/content/support/14503613-sso-login.md @@ -47,9 +47,9 @@ Before configuring your Identity Provider (IdP), you must verify ownership of yo 3. Wait for the DNS propagation. Once the platform detects the record, the domain status will update to “**Verified**.” -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256015862/476131c3139aec4db01b96127544/10c7a165-8b26-4443-b064-9d659659c65e?expires=1787744700&signature=32c34e652829861d5044a21ad35a35c0cdfef70093e6cdf5b52b000938f6b051&req=diIiEMl%2FmIlZW%2FMW1HO4zdpfuC2PHleI006zz1SmF9WthIVMKhMa34dT6YS7%0Akd8P6p6ssaRmPX49vR4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256015862/476131c3139aec4db01b96127544/10c7a165-8b26-4443-b064-9d659659c65e?expires=1787829300&signature=13ffdfc6bce32120c7164024047aaef3aada25160bfa9b5bc35f2bab562a7855&req=diIiEMl%2FmIlZW%2FMW1HO4zdpfuC2AGFqM006zz1SmF9V57K2DKiruJgr%2B54W6%0ANHMCcuq3HR466aNN5v4%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256025910/a82e2de9382824fa9db7666f67c4/CleanShot%2B2026-04-09%2Bat%2B16_25_20-402x.png?expires=1787744700&signature=f113c0792927752771cfef980d9182fc071777b9c4d31e7ba7598b53a7b9f3ee&req=diIiEMl8mIheWfMW1HO4zV%2BGnR44R7tAx57dwYq5DdKvtpg0K%2BUq0QigCHfx%0AX7%2Bnwf02Hd9SMRTPpP0%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256025910/a82e2de9382824fa9db7666f67c4/CleanShot%2B2026-04-09%2Bat%2B16_25_20-402x.png?expires=1787829300&signature=8e886bfe764233d8bda4cf458ce93d94cdc6d1d2708853e986721cf661299dce&req=diIiEMl8mIheWfMW1HO4zV%2BGnR43QbZEx57dwYq5DdJs0DqaO1IoLVSobZdy%0AsjwxaxO754ulcUQKjO0%3D%0A) **Important:** Each domain can only have one identity provider. If multiple organizations share a single login domain, IT administrators from both organizations will be able to modify login settings. Contact **[Anthropic Support](https://claude.fedstart.com/support)** for assistance with multi-organization setups. For more details about multi-organization setups, see our **[SCIM provisioning guide](https://support.claude.com/en/articles/14503643-set-up-scim-in-claude-for-government)**. @@ -77,7 +77,7 @@ Once your SAML application is set up in your IdP, provide Anthropic with the det - Claims Information — Attribute mappings for user name and email. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256004522/a97b91092b393e93b2d7779f63e6/2db86a6d-1582-419e-925e-cbc914468fa1?expires=1787744700&signature=31803b3834909c3a766d490d59b5503ee9b46a1daf522abfdda17e2733f9f4f9&req=diIiEMl%2BmYRdW%2FMW1HO4zQE9JrCx%2FhD8bfNHh%2Fvd8OFXhU6DL6HhPmtDnFYC%0AGWT8Y3ETPltKYv3ph2E%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256004522/a97b91092b393e93b2d7779f63e6/2db86a6d-1582-419e-925e-cbc914468fa1?expires=1787829300&signature=922ba06d169d9538cc10bf2f7a71d5c80ce832f6ca16684de592bee487bb78cb&req=diIiEMl%2BmYRdW%2FMW1HO4zQE9JrC%2B%2BB34bfNHh%2Fvd8OH%2BDOgGiy6XwxnNJttF%0AnKmp3UDRuefuW6TvcQ4%3D%0A) **Tip:** Using a metadata XML file: Most IdPs let you download a metadata.xml file. Upload it on the identity settings page to auto-fill the Signing Certificate, IdP Entity ID, and SSO URL. Some IdPs (like Entra ID) also include claims information in the metadata file; if present, the system will suggest field mappings automatically. diff --git a/content/support/14503643-set-up-scim-in-claude-for-government.md b/content/support/14503643-set-up-scim-in-claude-for-government.md index 615a5355d..b87c0c6c3 100644 --- a/content/support/14503643-set-up-scim-in-claude-for-government.md +++ b/content/support/14503643-set-up-scim-in-claude-for-government.md @@ -41,7 +41,7 @@ With SCIM, login and provisioning are separate. Your IdP tells Anthropic who sho **Important**: Store this key securely. It cannot be retrieved after you leave the page. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256040196/c3b045028c4c2edef9172b6fb424/9a71258e-ae73-41e3-83a2-d24a240ac0ae?expires=1787744700&signature=14fc3abc19271a8e50bd045d9f1f91292b41f6b40c7bee96a2fb1ab3a0424da9&req=diIiEMl6nYBWX%2FMW1HO4zSrRlasYbTITyIvvU1hav7Pa7NSOc%2FDjYNVuueEa%0ALbcYctg0jVwr6IXvQX8%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256040196/c3b045028c4c2edef9172b6fb424/9a71258e-ae73-41e3-83a2-d24a240ac0ae?expires=1787829300&signature=40e2e4f11bec93d39723bace67a3d8ac8247a1f4dbbda65ae07ea05c27e15d4a&req=diIiEMl6nYBWX%2FMW1HO4zSrRlasXaz8XyIvvU1hav7MgfQDsc8YaG8KWp%2FN1%0Ahk1zDWpC5EXCBcG3wg0%3D%0A) ### Step 2: Configure SCIM in your Identity Provider @@ -67,7 +67,7 @@ After enabling the integration in your IdP: **Warning**: When you fully enable SCIM provisioning, any users who were **not** synced via SCIM will be removed from the organization. Confirm that all expected users appear in the sync before proceeding. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256040198/da9188b8b968d5f900cc08e9ceb2/3814ab37-c3fa-4256-8d16-49c1e1b4c654?expires=1787744700&signature=b7bcaea71334efa55fe731719d46eaf8151a92ce1a28538961c2d93b047cd7fa&req=diIiEMl6nYBWUfMW1HO4zeLvMl9oTkj9oWupW8zJgMo9k%2F09pMutl1%2FFLCBe%0A5IR631vjtCGlSAob6WE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256040198/da9188b8b968d5f900cc08e9ceb2/3814ab37-c3fa-4256-8d16-49c1e1b4c654?expires=1787829300&signature=b55be45839a5b1aac397c172ded5548f274b428c158cff596e3839faa241ce4d&req=diIiEMl6nYBWUfMW1HO4zeLvMl9nSEX5oWupW8zJgMrC1u8cKg0wmtsQdf4Z%0AIC17k2oR9GUeLPib2hU%3D%0A) ### Step 4: Map groups to roles and seat tiers @@ -83,7 +83,7 @@ SCIM provisioning uses IdP groups to assign roles and seat tiers within Claude f 3. Save your mappings. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256056441/f7eb09bba549e9861fc81b961cc7/2760fa5b-87bb-491f-9354-ca3cd2bc4475?expires=1787744700&signature=714d0b8da62c346e777944e45a1608d7c55a4e1910902faabd9fa9d1afc2d859&req=diIiEMl7m4VbWPMW1HO4zaWhsXQltkMch340B79BYGZZWSvNkpwW8RJlWlz1%0AvV5sqDfv0Zk7kKXMChU%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256056441/f7eb09bba549e9861fc81b961cc7/2760fa5b-87bb-491f-9354-ca3cd2bc4475?expires=1787829300&signature=c2fad04f7863394dbab98fa5a8b3e6b88125d32cac87a22c9c69c7e8f69d51a2&req=diIiEMl7m4VbWPMW1HO4zaWhsXQqsE4Yh340B79BYGaWofpYQ2%2FpN9kGKVdU%0AagRXJbqBOzXzc9Auj48%3D%0A) If you manage multiple organizations under a single parent (see below), each organization maintains its own role and seat tier mappings. Switch between organizations using the organization selector in the bottom-left corner of the page. diff --git a/content/support/14503775-mcp-web-search.md b/content/support/14503775-mcp-web-search.md index a88427b5a..6fb7805b9 100644 --- a/content/support/14503775-mcp-web-search.md +++ b/content/support/14503775-mcp-web-search.md @@ -4,7 +4,7 @@ The Web Search connector gives Claude the ability to search the public internet For questions about web search in commercial Claude, see **[Enabling and using web search](https://support.claude.com/en/articles/10684626-enabling-and-using-web-search)**. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256120763/7652c6c669446113eae75f3c5977/9c74d57e-aaa2-4f1c-bfe4-2b9b87fd41ab?expires=1787744700&signature=4a1a2372b34f315476dfe19967061f0b96d97d786ff559624efd8f0b8325b5b9&req=diIiEMh8nYZZWvMW1HO4zQvFLLVUicD%2FM%2Fw5SJgC29GoJPNbkH6HNoqWu%2FGu%0AJH06XFSHlu0bkp51EDk%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2256120763/7652c6c669446113eae75f3c5977/9c74d57e-aaa2-4f1c-bfe4-2b9b87fd41ab?expires=1787829300&signature=16b129c630183d594c5068f35d0e63dc7f40f4f332383fc242311c25eb25c404&req=diIiEMh8nYZZWvMW1HO4zQvFLLVbj837M%2Fw5SJgC29G4jQP1eIbQQih6rUnJ%0AuyDpHF4IKLRRCJP5yKc%3D%0A) ## How Web Search differs for Claude for Government diff --git a/content/support/14554000-claude-code-power-user-tips.md b/content/support/14554000-claude-code-power-user-tips.md index f2a9302a0..bee14241f 100644 --- a/content/support/14554000-claude-code-power-user-tips.md +++ b/content/support/14554000-claude-code-power-user-tips.md @@ -71,7 +71,7 @@ Then prompt naturally: *“Migrate all sync IO to async. Batch the changes and l The `/batch` command interviews you about a migration, then fans the work out to as many worktree agents as needed — dozens, hundreds, or more. Each agent works in isolation, tests its own changes, and creates a PR independently. ``` -> /batch migrate src/ from Solid to React +> /batch migrate src/ from JavaScript to TypeScript ``` --- diff --git a/content/support/14604397-set-up-your-design-system-in-claude-design.md b/content/support/14604397-set-up-your-design-system-in-claude-design.md index 67a116392..3fde5b4d8 100644 --- a/content/support/14604397-set-up-your-design-system-in-claude-design.md +++ b/content/support/14604397-set-up-your-design-system-in-claude-design.md @@ -72,7 +72,7 @@ To validate your design system, create a test project and see if the output matc Once you’re satisfied with the design system quality, make sure the “Published” toggle is switched on. After publishing, any projects created from the Claude Design homescreen while in your organization will use your design system instead of the default. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2287527007/b1c46cb8dba4cd7e8bbea85fb0c3/2819c6cf-9ce1-4df5-84c8-feae0164bf2e?expires=1787744700&signature=83bd7ba4b5fdf217236b8f104e48d57774fca3b9bd8f873f1f23a1076d0cbe0c&req=diIvEcx8moFfXvMW1HO4zWNHF%2FWMCj8QIQKNMXlu0T8rD2k7hOVAB1VWD83G%0ANs9ic0akP%2Fwh%2BqjOoqM%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2287527007/b1c46cb8dba4cd7e8bbea85fb0c3/2819c6cf-9ce1-4df5-84c8-feae0164bf2e?expires=1787829300&signature=1ca4f6c05af631e14abbff8b0be077748b0e6c638662e1b5176895ce85a17949&req=diIvEcx8moFfXvMW1HO4zWNHF%2FWDDDIUIQKNMXlu0T9prmTM4tRM8j6MQGu4%0A16qmykMMJ0pz5KcYzos%3D%0A) --- diff --git a/content/support/14604406-claude-design-admin-guide-for-team-and-enterprise-plans.md b/content/support/14604406-claude-design-admin-guide-for-team-and-enterprise-plans.md index 9c8d928c7..25ab16889 100644 --- a/content/support/14604406-claude-design-admin-guide-for-team-and-enterprise-plans.md +++ b/content/support/14604406-claude-design-admin-guide-for-team-and-enterprise-plans.md @@ -18,7 +18,7 @@ Team and Enterprise plan admins can enable this organization-wide by following t 2. Find the **Claude Design** toggle under **Anthropic Labs** and switch it on. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2289240025/8a528b6cccc3ea1001c25953cb14/image.png?expires=1787744700&signature=00f332a37365df6a1abe35fd4fb4f39f682fb079cd8978283b4f51adb50e9b67&req=diIvH8t6nYFdXPMW1HO4zahp3eUPHeIiDIPtKBLQ9H%2BfQN5kfcj4MeUsTeOD%0AvrYADdRxBeyjJX4S26A%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2289240025/8a528b6cccc3ea1001c25953cb14/image.png?expires=1787829300&signature=8c5769e2c1208a32abb55477be9cdc05e30facd484eca03ecab05e64eae9c9b4&req=diIvH8t6nYFdXPMW1HO4zahp3eUAG%2B8mDIPtKBLQ9H8dDSOqtz3lynU9HeM5%0AsRx9sOZvWVd3aBlOmw8%3D%0A) --- diff --git a/content/support/14604416-get-started-with-claude-design.md b/content/support/14604416-get-started-with-claude-design.md index 1aeefe905..f4432d65e 100644 --- a/content/support/14604416-get-started-with-claude-design.md +++ b/content/support/14604416-get-started-with-claude-design.md @@ -153,7 +153,7 @@ Use the “Export” button in the upper right corner when viewing your project - Send to Claude Code Web -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2287510952/553a03eec5cea7b9eff53b473552/6dc33363-38b1-444e-96bb-f8218b588173?expires=1787744700&signature=6f357eb408d7bba2b974bfa932812d7799cb45b14896df1d66f69b90f9f8e417&req=diIvEcx%2FnYhaW%2FMW1HO4zQFD4Stdn2lznfz9ljnuyXRVQCN3RE8cfJtbxwPN%0AgtrZbR90QFwDf661jQs%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2287510952/553a03eec5cea7b9eff53b473552/6dc33363-38b1-444e-96bb-f8218b588173?expires=1787829300&signature=7304eadb48b5a5898b7181c6dcca8a23a86d42b99a733c8aeaa72a2feae4b774&req=diIvEcx%2FnYhaW%2FMW1HO4zQFD4StSmWR3nfz9ljnuyXQbNnkj8KEtnaRfs7rT%0A4C6CbbBTJ7TakFEoL1o%3D%0A) You can also share projects within your organization using a shareable link. Sharing options include view-only, comment, and edit access. diff --git a/content/support/15167101-get-started-with-claude-compliance-api-integrations.md b/content/support/15167101-get-started-with-claude-compliance-api-integrations.md index c30a81632..f2ef34caa 100644 --- a/content/support/15167101-get-started-with-claude-compliance-api-integrations.md +++ b/content/support/15167101-get-started-with-claude-compliance-api-integrations.md @@ -14,7 +14,9 @@ The Compliance API provides access to different data depending on the product: - **Conversation content** including chats, uploaded files, and projects - - **Cowork (via Claude, Claude Desktop, and Claude Mobile) and Claude Code (via CLI and Claude Desktop) session content**, in beta. Includes prompts and responses, tool calls content, and skills and artifacts content captured as transcript text. + - **Session content from Cowork (via Claude, Claude Desktop, and Claude Mobile) and Claude Code (via CLI and Claude Desktop).** Includes prompts and responses, tool calls content, and skills and artifacts content captured as transcript text. + + - **Session content from the Claude for Microsoft 365 add-ins (Excel, Word, PowerPoint, and Outlook) and Claude Science**, in beta. Includes prompts and responses, plus drafted emails, formulas, and document text from the Microsoft 365 add-ins. - **Activity feed events** covering user logins, admin actions, and configuration changes @@ -30,7 +32,7 @@ For Claude Enterprise customers, using an integration is straightforward: 1. Enable the Compliance API in your organization settings. Learn how to **[access the Compliance API](https://support.claude.com/en/articles/13015708-access-the-compliance-api)**. -2. Connect your instance to a supported security platform. Setup guides are available in the **[Available integrations section](#h_7ff9e34f8e)**. +2. Connect your instance to a supported security platform. Setup guides are available in the **[Available integrations section](https://support.claude.com/en/articles/15167101-get-started-with-claude-compliance-api-integrations#h_7ff9e34f8e)**. Claude activity will flow into the same dashboards and workflows your team uses for every other application. diff --git a/content/support/15330088-set-a-default-model-for-your-organization.md b/content/support/15330088-set-a-default-model-for-your-organization.md index b2e0b155e..c0566a8e6 100644 --- a/content/support/15330088-set-a-default-model-for-your-organization.md +++ b/content/support/15330088-set-a-default-model-for-your-organization.md @@ -46,7 +46,7 @@ The organization default applies to every member. To set it: 4. Click “Save changes.” -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514722139/d05c94072a41ea9090ecf386c53e/c32ee31d-954a-4551-a2da-91677fbd0b6f?expires=1787744700&signature=1da3062fbaaff6c8e84684527523241dbc5e62dc213b116ead41a41bff6b1a05&req=diUmEs58n4BcUPMW1HO4zelOdzVHKUxAfdGVZ664dGFn8XrbEXxkLxOEFIdy%0AgaEfkvOIjcuLMieQY24%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514722139/d05c94072a41ea9090ecf386c53e/c32ee31d-954a-4551-a2da-91677fbd0b6f?expires=1787829300&signature=17e1f1db0fed772bfc12429bd6d3d912f96db4b8add5534e7c14a7c6cd277bd6&req=diUmEs58n4BcUPMW1HO4zelOdzVIL0FEfdGVZ664dGGKdKn1NAswG2LpnwMZ%0AEk1aqC0ztJNjbDG2P9k%3D%0A) --- diff --git a/content/support/15520349-use-claude-cowork-on-web-desktop-and-mobile.md b/content/support/15520349-use-claude-cowork-on-web-desktop-and-mobile.md index 6958a250d..b1590741b 100644 --- a/content/support/15520349-use-claude-cowork-on-web-desktop-and-mobile.md +++ b/content/support/15520349-use-claude-cowork-on-web-desktop-and-mobile.md @@ -58,7 +58,7 @@ Cowork in the cloud is in beta, and some features aren’t available yet. Here's A few notes on the table: -- *Local file access, local connectors, browser use, and computer use from web and mobile work through the Claude Desktop app. A cloud session can read and write files in folders you've connected on your computer only while the desktop app is open on that computer. If the app is closed, the session keeps running but can't reach your local files. +- *Local file access, local connectors, browser use, and computer use from web and mobile work through the Claude Desktop app. A cloud session can read and write files in folders you've connected on your computer only while the desktop app is open on that computer and the session was started on desktop. If the app is closed, the session keeps running but can't reach your local files. - Projects are available on every surface. From a project you can start a chat or a Cowork session, and Claude uses the project's knowledge as context. Projects tied to a local folder support Cowork sessions on desktop only, and Cowork won't change a project's contents, so add anything you want to keep to the project yourself. For more information, see **[Organize your tasks with projects in Claude Cowork](https://support.claude.com/en/articles/14116274)** and **[Use live artifacts in Claude Cowork](https://support.claude.com/en/articles/14729249)**. @@ -78,7 +78,7 @@ Some capabilities reach things on your computer, so they need the Claude Desktop - **Local connectors.** This includes plugins using those connectors. -- **Browser use.** Claude works in your browser through Claude in Chrome. In the Chrome side panel, Claude can read the tab you're on without the desktop app. Claude driving your browser as part of a task still needs the desktop app open. +- **Browser use.** On desktop, Claude uses a browser built into the Claude Desktop app by default (rolling out gradually this week), or your own Chrome browser through Claude in Chrome if that's your preferred browser. When the desktop app is online, the built-in browser is also available in Cowork on web or mobile. A session started on desktop can be steered from web or mobile while the desktop app stays open. In the Chrome side panel, Claude can read the tab you're on without the desktop app. Claude driving a browser as part of a task still needs the desktop app open. Learn more in **[Use the built-in browser in Claude Cowork](https://support.claude.com/en/articles/16607400)**. - **Computer use.** Claude clicks, types, and navigates your screen directly. diff --git a/content/support/15694740-manage-model-access-for-your-organization.md b/content/support/15694740-manage-model-access-for-your-organization.md index c791cfb2e..5dccee561 100644 --- a/content/support/15694740-manage-model-access-for-your-organization.md +++ b/content/support/15694740-manage-model-access-for-your-organization.md @@ -42,9 +42,9 @@ The organization setting is the ceiling, so a role can’t grant access to a mod If any custom role uses the model you’re disabling as its default, you’ll be prompted to change that role’s default before the change can be saved. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514693921/02ea72756f5163f14e5d158516dc/69102088-cd86-498e-97aa-c8a6e0004419?expires=1787744700&signature=805e0348fc6cccc9d6704caaf3a9d8fb72de4c0aa64e5a8a74433423b72ff2b5&req=diUmEs93nohdWPMW1HO4zXlxEuC%2BU9VQQf5Pb7M2Q0s3nPSkJLReeLnE1JX0%0A%2BF6%2BnJkKt%2BECaizLtb4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514693921/02ea72756f5163f14e5d158516dc/69102088-cd86-498e-97aa-c8a6e0004419?expires=1787829300&signature=b1ecb3dd236b9268f4696059a75331828eff37022af2669f71ec1c62242d6b7c&req=diUmEs93nohdWPMW1HO4zXlxEuCxVdhUQf5Pb7M2Q0s2E3h1OXWGo%2BWPt6Fa%0AeB%2FLINPGLuBfM7JgUUc%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514693922/bfc5de6626eb19dca1d7caf818ca/c3cd8bb6-f86c-4d01-92da-6ae4ca966662?expires=1787744700&signature=c0d445f82565f1a9c282ba58b45586b4fe23ea62f81398e31fd6f3a22aa50581&req=diUmEs93nohdW%2FMW1HO4zTqNsY7CQlxQAod9uc510lxFAUor5%2Bk5YgGZ6tK5%0An4NrVporpOFjdYcLL54%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514693922/bfc5de6626eb19dca1d7caf818ca/c3cd8bb6-f86c-4d01-92da-6ae4ca966662?expires=1787829300&signature=c9b2cc4c9d9be11a6db4739b6a12f3662ff11a872a45525b8951938d852b1b8f&req=diUmEs93nohdW%2FMW1HO4zTqNsY7NRFFUAod9uc510lzq5edgvRfHD6RQPUwH%0AUFyi2Va0hfoP0iPGr%2BI%3D%0A) --- @@ -62,7 +62,7 @@ If any custom role uses the model you’re disabling as its default, you’ll be Only models the role grants access to can be selected as that role’s default model. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514693923/880665a87dbd4776cf19d6063a37/29d30c6d-f9fc-408c-8c72-4320c6d88d14?expires=1787744700&signature=7c71e674290808b031666d59d18b4a1134a1024665121a9a521417c046f530b2&req=diUmEs93nohdWvMW1HO4zYj9SfIE6YW6XsqpNqvyFRJwK3SZ8bc7E6Jx5L%2Fn%0A70wQi2zotQcWKU78log%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514693923/880665a87dbd4776cf19d6063a37/29d30c6d-f9fc-408c-8c72-4320c6d88d14?expires=1787829300&signature=3ceb2f5b125a370f80bc32bc7b2408ee178cd32af1b4f2dd0d2fe580ab093fe4&req=diUmEs93nohdWvMW1HO4zYj9SfIL74i%2BXsqpNqvyFRIO6KV5%2BF%2Fd4yfjtuJW%0AKSOrZIG9yhGFafoMvuc%3D%0A) --- @@ -80,7 +80,7 @@ Effort limits determine how much computation members on a role can apply per res 5. Click "Save" to save your changes. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514693927/7a25673b3b075d72adb3cdc371e3/d2d7cd8d-a713-4e91-a706-f589ac46a9fe?expires=1787744700&signature=663f03235ab431e8bf5b2ec9a8286d09e2b69f6c74c46ac19243c8f4ca2f990d&req=diUmEs93nohdXvMW1HO4ze1xBjS7d70eDeA1RkowXUEZYafVfdOEpPrkd3Rx%0AgrXw42Jj5HU4CJEAqxk%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2514693927/7a25673b3b075d72adb3cdc371e3/d2d7cd8d-a713-4e91-a706-f589ac46a9fe?expires=1787829300&signature=fb0c9612e55e5749750ca06fa2aeeeecf429f182622223b30539fd6d75c713d9&req=diUmEs93nohdXvMW1HO4ze1xBjS0cbAaDeA1RkowXUG2cWeFVllhlRSc8A2q%0Aj1U3onPWeGQKY3UErl4%3D%0A) Members on the role see only effort levels at or below the cap in their model menu. Note that available effort levels differ depending on the model, and some models don’t support effort level settings at all. For an explanation of each level, see **[Change the model, effort, and thinking settings](https://support.claude.com/en/articles/8664678)**. diff --git a/content/support/15707726-using-claude-for-legal-work-privilege-confidentiality-and-how-to-think-about-configuration.md b/content/support/15707726-using-claude-for-legal-work-privilege-confidentiality-and-how-to-think-about-configuration.md index 08896fc90..49c4fd8f1 100644 --- a/content/support/15707726-using-claude-for-legal-work-privilege-confidentiality-and-how-to-think-about-configuration.md +++ b/content/support/15707726-using-claude-for-legal-work-privilege-confidentiality-and-how-to-think-about-configuration.md @@ -22,7 +22,7 @@ This is an area of law that's moving quickly. None of these are appellate decisi There are two questions worth separating: *what does Anthropic see*, and *what protections survive even when a vendor sees something*. -On the first—our **[published security and privacy design](https://trust.anthropic.com)** describes the architecture in detail, but in short: +On the first—our **[Trust Center](https://trust.anthropic.com/)** and our **[data retention practices article](https://support.claude.com/en/articles/15425996)** cover the details, but in short: - **We do not train on your content by default.** Under our commercial terms, **[by default](https://privacy.claude.com/en/articles/7996868-is-my-data-used-for-model-training)**, customer content from Claude for Work, the Claude Platform, and the API is not used to train our models. @@ -32,7 +32,7 @@ On the first—our **[published security and privacy design](https://trust.anthr - **You can verify this.** Every human read is logged to a tamper-proof entry that customers with **[Access Transparency](https://platform.claude.com/docs/en/manage-claude/access-transparency)** can retrieve. -- **Customer-managed encryption** is available for **[qualifying customers](https://trust.anthropic.com/resources?s=7ksqkied5hn0pocsj206m&name=%5Banthropic%5D-security-and-privacy-design-of-anthropic-data-retention-and-review)**, putting the encryption keys for the retention store in your own key management system (KMS)—though this controls key custody, not the narrow safety review above. +- **Customer-managed encryption** is available for **[qualifying customers](https://platform.claude.com/docs/en/manage-claude/cmek)**, putting the encryption keys for the retention store in your own key management system (KMS)—though this controls key custody, not the narrow safety review above. - **In-tenancy options.** Claude is also available via AWS Bedrock and Google Cloud Vertex AI for organizations whose policy is that data stay within their own cloud environment. This changes where your data resides and whom you contract with; it does not by itself switch off the safety monitoring described above. diff --git a/content/support/15936181-get-started-with-1password-for-claude.md b/content/support/15936181-get-started-with-1password-for-claude.md index af52bfa3d..39980abd0 100644 --- a/content/support/15936181-get-started-with-1password-for-claude.md +++ b/content/support/15936181-get-started-with-1password-for-claude.md @@ -52,7 +52,7 @@ Once the requirements are in place, you can set up 1Password from a few places i 4. Toggle on **Password managers**: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2546126596/ba71ca47e2df21cec62c243831f8/5b1c67e1-607d-4c73-8f61-d1ceb081082a?expires=1787744700&signature=dd912b911001a4953f9cce8b738640e8d9ca5a41b1790b8b51a96a8bdcb12af0&req=diUjEMh8m4RWX%2FMW1HO4zU5lnmxpqcFkGkiu4hEpcPW0DNUPM9%2B2NZiIyjRM%0AZajqYKoXApKVLEesfBE%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2546126596/ba71ca47e2df21cec62c243831f8/5b1c67e1-607d-4c73-8f61-d1ceb081082a?expires=1787829300&signature=52417447bb1ecbb49c3a5da23f3f95e2bbb8fe81e98123ec6b39ac5368c99abf&req=diUjEMh8m4RWX%2FMW1HO4zU5lnmxmr8xgGkiu4hEpcPUG96Zc3wpA7hQr5oCg%0AtzmUVHWPXZ%2BAwiZ7idU%3D%0A) Once enabled, eligible users will see the discovery options above. Users still need to install and set up the required apps and extensions themselves. diff --git a/content/support/16607638-understanding-your-pro-or-max-plan-invoices.md b/content/support/16607638-understanding-your-pro-or-max-plan-invoices.md index da12192b2..f4c7a6f56 100644 --- a/content/support/16607638-understanding-your-pro-or-max-plan-invoices.md +++ b/content/support/16607638-understanding-your-pro-or-max-plan-invoices.md @@ -40,7 +40,7 @@ You can also open any invoice from your account: **Amount due.** The invoice total minus any applied balance. This is what your payment method was charged. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2629072970/c514f489b65072ccad08e803864f/e8c7a7de-905f-4a40-815f-c9c66edcdbf6?expires=1787767200&signature=9972a72e4ce5309c74ee7b38e80d2d15cb777cf9261b8eaca796390244617b72&req=diYlH8l5n4hYWfMW3nq%2BgfC4Hr1CZDLJ40wuWyZaPcPuMnpw4Am6ndfWrurl%0AdpHQ9xqV6ROX2dkL4Fw%2BPIiucWY%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2629072970/c514f489b65072ccad08e803864f/e8c7a7de-905f-4a40-815f-c9c66edcdbf6?expires=1787829300&signature=7bfb57ac0b11609f79af03ac7676fc8291c2a939b43211eaa0939f337e3268f7&req=diYlH8l5n4hYWfMW1HO4zdWraBY37F0dPZYKVlMiWEUi%2FFFjU%2F4YLcZ%2Bo7ro%0ArnOUcdQfKO4RdT75UK4%3D%0A) ## Billing details on your invoice diff --git a/content/support/8114491-get-started-with-claude.md b/content/support/8114491-get-started-with-claude.md index bc2d4f747..ebb47a4b9 100644 --- a/content/support/8114491-get-started-with-claude.md +++ b/content/support/8114491-get-started-with-claude.md @@ -36,7 +36,7 @@ You use **prompts** to communicate with Claude. The best approach is to speak to Type your prompt into the chat interface and click the submit button to start a conversation with Claude. You can click the "+" button in the lower left or type "/" to view additional options and commands: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1916208578/2cf2ea52f1f884084b57983a8805/image.png?expires=1787744700&signature=ea7cfc69377b19610be9356f7fa311857f0d1e3647679dd072f20c4d072aebff&req=dSkmEMt%2BlYRYUfMW1HO4zV2J7SjNsIOG9crMELaMZPxrq3irkvMKcRasURy6%0AWTRMRjW02OyI59mAZlk%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1916208578/2cf2ea52f1f884084b57983a8805/image.png?expires=1787829300&signature=16b331b48e55be9a9a4e85e3b7a5d984d78e3040ead964764b00a6937e3ffac9&req=dSkmEMt%2BlYRYUfMW1HO4zV2J7SjCto6C9crMELaMZPz%2FKue9gLEXnXQv%2FWEB%0A7i9phezSIhSD%2B%2FoDXgY%3D%0A) --- diff --git a/content/support/8230524-delete-or-rename-a-conversation.md b/content/support/8230524-delete-or-rename-a-conversation.md index cc9cbbff1..c63f2e95d 100644 --- a/content/support/8230524-delete-or-rename-a-conversation.md +++ b/content/support/8230524-delete-or-rename-a-conversation.md @@ -44,15 +44,15 @@ These steps apply to Claude for iOS, listed on the App Store as Claude by Anthro 4. If deleting, tap "Delete" again in the confirmation prompt. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599501318/75c28edc693efbe8befd21e4da64/d18a921a-df4b-4788-833c-12c966a32527?expires=1787744700&signature=f284ff931040a6853914674ec75acbc192b800fc8de36d631a1df4efd2d33dc8&req=diUuH8x%2BnIJeUfMW1HO4zSc12aldjGSs1DBI29QsIlHuR1ruTbFTtArIob5R%0Ap%2FUJNiWObkdadS%2F1Kvw%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599501318/75c28edc693efbe8befd21e4da64/d18a921a-df4b-4788-833c-12c966a32527?expires=1787829300&signature=5848e465df157bc27c1e2c4704bb85938443862839222dc22d7d44d5996974bb&req=diUuH8x%2BnIJeUfMW1HO4zSc12alSimmo1DBI29QsIlGGQMV4dppc3Gv%2FMaTK%0A4J5C9PuDhco2gLe1wis%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493852/2e58b92d18f307bb79ae30650f26/1bbe52f3-202b-4d5d-9f9a-eeda4d6952c3?expires=1787744700&signature=999febbff5c120e83260e52c67800241ab6b7862c74b3d14669c90cabfc37cb8&req=diUuH813nolaW%2FMW1HO4zTjXMuCLKsTij7blKEDtUI14gj6EiOIX3Q4xnoXn%0Ab%2FYj7hm0lhxdPkmmtfI%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493852/2e58b92d18f307bb79ae30650f26/1bbe52f3-202b-4d5d-9f9a-eeda4d6952c3?expires=1787829300&signature=37fd50de9d9d2244212941200df107661575f06a088b131b73db38d8afb9cad2&req=diUuH813nolaW%2FMW1HO4zTjXMuCELMnmj7blKEDtUI3EV55uR0MKCxsnut7C%0A1BbBx6NXtMcWcJiIylQ%3D%0A) You can also delete the conversation you have open: tap the "⋯" button in the top right corner, tap "Delete," then confirm. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493848/997184c386d0e6fb0bd2d7c1f2b6/5d2bc394-25fc-4814-8c2a-2f54d004f83f?expires=1787744700&signature=7cab17388992c2a325818c3dab6216b9829fb2f528d0285cb06a0cea6f422e9a&req=diUuH813nolbUfMW1HO4zVCIqp3Iz9hBzQl%2BKgU984yJeh%2FcZuJr%2FtXb65g3%0AYO2MmhY4kf71S6Ks7eY%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493848/997184c386d0e6fb0bd2d7c1f2b6/5d2bc394-25fc-4814-8c2a-2f54d004f83f?expires=1787829300&signature=7ce5808f43cd7e0f783062bd62fe9475fe3eb24a0c7aaf9cd9488dda217334c2&req=diUuH813nolbUfMW1HO4zVCIqp3HydVFzQl%2BKgU984wQutAS1cw54yBvljOI%0ATd0BV2%2F9NVHUDhGDXTE%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493856/799041da9fa918e90068c5ebf5bd/2e8d5cee-c45a-41d7-a14b-486e50a37f88?expires=1787744700&signature=eb55b04daa41a966f509c320d26e5baed4b42d5ac5298552c048994b4681efad&req=diUuH813nolaX%2FMW1HO4zVCl4A%2F11WFKEDIU8RT6jk1EuvEHUIcm0cek9IZG%0AZlHeYhJM%2F0M8%2B%2BsfK9E%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493856/799041da9fa918e90068c5ebf5bd/2e8d5cee-c45a-41d7-a14b-486e50a37f88?expires=1787829300&signature=29760495e07b7ce40228e93fa749c2843b2eb579314ea98e6640e0e7afcaf78c&req=diUuH813nolaX%2FMW1HO4zVCl4A%2F602xOEDIU8RT6jk04r4C4fZM8vjEpcO7x%0AZM84g8SGARiJkpLf82w%3D%0A) ## Delete or rename a conversation on Claude for Android @@ -66,9 +66,9 @@ These steps apply to the Claude for Android, listed on Google Play as Claude by 3. If deleting, tap "Delete" again in the confirmation prompt. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493850/a64e6561222d535f2f5bd03e71f0/5de429c2-d8ed-4e8a-89e8-a13ccaa49767?expires=1787744700&signature=99670318b5fa4953d208568afaf91fed4b1d6c86b3c9a48a1c208caff0b1794e&req=diUuH813nolaWfMW1HO4zVTdd9UrxlRyrqtc0YNNUtJb0yqM6hE1AcH%2FAzOy%0A9m9ut2WuC4kba0rgWaU%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493850/a64e6561222d535f2f5bd03e71f0/5de429c2-d8ed-4e8a-89e8-a13ccaa49767?expires=1787829300&signature=1e21c76c8451356fbb1b23664b4bec20965546fc8f6cefe91379a3dee2b907ab&req=diUuH813nolaWfMW1HO4zVTdd9UkwFl2rqtc0YNNUtKr4ncmRJ0ugYfmIh0X%0AJh5AOT5Lkva9b4nAqfU%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493851/f21b39c60e88050d4b0745325f0d/0a8c0d08-dc53-4ef1-8d9f-2b995242c1f9?expires=1787744700&signature=7c8e398af74eacd623712944ac33d00d672618f30a2dd5295be77a8d791b6eda&req=diUuH813nolaWPMW1HO4zUYvw1IMpjpb%2FjekULCQNzW1WHv%2FLIuFb4RJxAuW%0A52V8QTN%2BFE71GykCuFo%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493851/f21b39c60e88050d4b0745325f0d/0a8c0d08-dc53-4ef1-8d9f-2b995242c1f9?expires=1787829300&signature=952836f06d38d410b369525ab0bc112bfecc8439fa1ba3967871fbb418b0bf8d&req=diUuH813nolaWPMW1HO4zUYvw1IDoDdf%2FjekULCQNzUqArMC1xoIH1orgtge%0AAsXmSBp6QVMXWm5KgRQ%3D%0A) **To delete multiple conversations at once:** @@ -78,9 +78,9 @@ These steps apply to the Claude for Android, listed on Google Play as Claude by 3. Tap the trash icon, then tap "Delete" in the confirmation prompt. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493849/3013a0ab921337b4544f7ffeffa6/e828ec14-fb52-4205-a840-707b6f2a848d?expires=1787744700&signature=4ba26be4704a15f4d642f51b77aacafca91d2ed2a8bbe3b89123d7c0e80cc108&req=diUuH813nolbUPMW1HO4zWGamMBzfonY4AqhTnZa84WNz0DgFixiJ74v87ZR%0A5i6bAA%2FvJOolqKN1e8o%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493849/3013a0ab921337b4544f7ffeffa6/e828ec14-fb52-4205-a840-707b6f2a848d?expires=1787829300&signature=aafe3ac1ddb82ce6d6996e8e93b15b2f61f8deef6baf639bb35f58d1fc59be18&req=diUuH813nolbUPMW1HO4zWGamMB8eITc4AqhTnZa84XbXhKbz1pPzN%2BIk4tg%0AlrEb0YISTLzWMkGc63Q%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493853/e2507f53cce8a26776a22a457b1a/bd79bb8a-b078-420f-a4e1-75590367aa80?expires=1787744700&signature=0a47308fa1ab86c33b59e1bc2a6e2b2c7d69bdd9ba64f6ac590b45a4592ac3b7&req=diUuH813nolaWvMW1HO4zQTtExL2wEQ%2FSBGfF3I2bRi66Nb8%2FiCSQc6eP8BL%0A3u9KtgVGaMW6%2BLe8hek%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2599493853/e2507f53cce8a26776a22a457b1a/bd79bb8a-b078-420f-a4e1-75590367aa80?expires=1787829300&signature=0a667b15ae8c8b62954b3a14dca1b1a88b47e16640aed3a9c0b0c1dab1329ae2&req=diUuH813nolaWvMW1HO4zQTtExL5xkk7SBGfF3I2bRj6M8KGosD2mITjRH3q%0A9fAFJDHanugijhiTRlE%3D%0A) ## What happens when you delete a conversation diff --git a/content/support/8325618-paid-plan-billing-faqs.md b/content/support/8325618-paid-plan-billing-faqs.md index 99610bd25..9793f5d74 100644 --- a/content/support/8325618-paid-plan-billing-faqs.md +++ b/content/support/8325618-paid-plan-billing-faqs.md @@ -50,7 +50,7 @@ There's no separate option to remove a card, and updating to a new card replaces If you want to use a name other than the one tied to your payment method, check the "Use a different name on invoices" box when adding or updating your payment method in **[Settings > Billing](https://claude.ai/settings/billing)**. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1922141785/666191101c11030b05f03a668a74/image.png?expires=1787744700&signature=1b41e96d4a4a3f3eaaafd3cb40981f7125012de5e16e135d2e979823652be082&req=dSklFMh6nIZXXPMW1HO4zVXW8GqsbzfLQoNvNFTb5ccZwPb9Z0yFb6W85MF2%0AOD6eUwk1q1n%2BgT59D7A%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1922141785/666191101c11030b05f03a668a74/image.png?expires=1787829300&signature=9b84e7a8df40d3424a44fc715b095194109a686cd4bdcdaf4f8d19d916251ba0&req=dSklFMh6nIZXXPMW1HO4zVXW8GqjaTrPQoNvNFTb5cc0XTog69u6KFB30aXt%0Aru1bBHrmivhFUtpRdSE%3D%0A) ## How can I edit a paid invoice? diff --git a/content/support/8664678-change-the-model-effort-and-thinking-settings.md b/content/support/8664678-change-the-model-effort-and-thinking-settings.md index 364dd6782..37da93388 100644 --- a/content/support/8664678-change-the-model-effort-and-thinking-settings.md +++ b/content/support/8664678-change-the-model-effort-and-thinking-settings.md @@ -1,6 +1,6 @@ # Change the model, effort, and thinking settings -The model menu next to the send button controls three settings: which Claude model you're chatting with, how much effort it puts into each response, and whether it uses extended thinking. This article explains how to change each one and when to use them. +The model menu next to the send button controls three settings: which Claude model you're chatting with, how much effort it puts into each response, and whether it uses thinking. This article explains how to change each one and when to use them. --- @@ -48,15 +48,15 @@ Learn more about **[how usage and length limits work](https://support.claude.com --- -## Use extended thinking +## Use thinking -Extended thinking lets Claude spend more time breaking down problems, planning solutions, and exploring different approaches before responding. +Thinking lets Claude spend more time breaking down problems, planning solutions, and exploring different approaches before responding. Thinking and effort are separate settings, and you can use any combination of the two. The effort level controls how thorough Claude is with every response. The thinking toggle controls whether Claude works through its reasoning in an expandable section before responding. -Extended thinking cannot be turned off in Claude when using Claude Opus 5. On the Claude API, thinking can be turned off at effort levels high and below, but attempting to disable thinking at xhigh or max effort returns an error. +Thinking cannot be turned off in Claude when using Claude Opus 5. On the Claude API, thinking can be turned off at effort levels high and below, but attempting to disable thinking at xhigh or max effort returns an error. -### Turn extended thinking on or off +### Turn thinking on or off For models with effort levels: @@ -64,7 +64,7 @@ For models with effort levels: 2. Mouse over "Effort." -3. Switch the "Thinking" toggle on or off. +3. Switch the "Thinking" (or “Extended”) toggle on or off. For other models: @@ -74,7 +74,7 @@ For other models: ### View Claude's thought process -When extended thinking is enabled, you'll see: +When thinking is enabled, you'll see: - A "Thinking" indicator with a timer showing how long Claude has been processing. diff --git a/content/support/8887527-customizing-your-appearance-settings.md b/content/support/8887527-customizing-your-appearance-settings.md index 6f08580e2..0e0257011 100644 --- a/content/support/8887527-customizing-your-appearance-settings.md +++ b/content/support/8887527-customizing-your-appearance-settings.md @@ -8,7 +8,7 @@ 3. Select from Light, Match System, and Dark under **Color mode**. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1648260417/d478c757c7115ad58a12026d4caf/AD_4nXc__Qop4X9hknWGfGj_y_DCpLutLruhxIclJIfir0ilsgNMg7X8ksIVnqk1Oce5FKlGIOYu9CKbVsu8DqD7iIY2aC0ZfXMyFTeAdNq-Cao2mXcj_WUpNF0kM2HoYR_dEx6N_cuJow?expires=1787744700&signature=4e484655583833dab626ed322e4a502df06c73e71904050bb3ed1dc4cf945043&req=dSYjHst4nYVeXvMW1HO4zc2jJ6U6hI%2FjSBkgeTglJrphgN1Rq%2FPPd1DCYe%2Fv%0AjgYoB80G3kYtldG9dYI%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1648260417/d478c757c7115ad58a12026d4caf/AD_4nXc__Qop4X9hknWGfGj_y_DCpLutLruhxIclJIfir0ilsgNMg7X8ksIVnqk1Oce5FKlGIOYu9CKbVsu8DqD7iIY2aC0ZfXMyFTeAdNq-Cao2mXcj_WUpNF0kM2HoYR_dEx6N_cuJow?expires=1787829300&signature=e7fe1dbc9c24abf6617a6118103a4c4158da9a60db26fc4c7e44c919e4e3e15e&req=dSYjHst4nYVeXvMW1HO4zc2jJ6U1goLnSBkgeTglJrqowb2C9tgk%2BRKqRHrU%0AeS%2F5gwM4ZH95mRmF7Xg%3D%0A) ## How to change your font @@ -16,10 +16,10 @@ 2. Select from Default, Match System, and Dyslexic Friendly. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1648260416/7fc0803d44d8de40f8e6636b2eb6/AD_4nXf0UEDa1i2QmqlQtoB5BgpQ-FfZVzss_7wMVQdvkmEDSfoTxixnG0GSxC6qrOs21HdkXH-I2Yn_GHDAf8yjd6FJtoh9FadALozvIErFp9r8LychDGLPb7OpN1CN4PRcgVAYNCre?expires=1787744700&signature=c27a2ea4f63ca3d5568b5fe7b708af2a516ca7e6eca687ad894e2e0ae8488bc8&req=dSYjHst4nYVeX%2FMW1HO4zc8962fiWXU7QtNFlF5%2FHEdesyfAlQt6YzYhqZzj%0A%2BwxXCTmF2eDS3g%2Fqm3c%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1648260416/7fc0803d44d8de40f8e6636b2eb6/AD_4nXf0UEDa1i2QmqlQtoB5BgpQ-FfZVzss_7wMVQdvkmEDSfoTxixnG0GSxC6qrOs21HdkXH-I2Yn_GHDAf8yjd6FJtoh9FadALozvIErFp9r8LychDGLPb7OpN1CN4PRcgVAYNCre?expires=1787829300&signature=703199c77c02ac735dd80b6dfee2d96f8073581a08aa001c508528eefc10a2f7&req=dSYjHst4nYVeX%2FMW1HO4zc8962ftX3g%2FQtNFlF5%2FHEdf78J5DlW4aLuERty%2F%0A9DwWXo6NcO%2FHJh5e4cY%3D%0A) ## Can I disable the sidebar? It's not currently possible to completely disable the sidebar. You can click the button on the top right of the sidebar to open or close it. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1941108004/5217903737ddd9bb62fe5d7a904c/CleanShot+2026-01-14+at+09_12_58.png?expires=1787744700&signature=d7684a7ef2266ba362b78e20d6db1af86a2899bcb5f8c82f9609ebc6f223989f&req=dSkjF8h%2BlYFfXfMW1HO4zUS%2BB1jxXX%2FoylfYa7uDb9nEuGu4nrw9TDhHxSJf%0A%2F%2FA7zQaCAPusY9anL8E%3D%0A) \ No newline at end of file +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1941108004/5217903737ddd9bb62fe5d7a904c/CleanShot+2026-01-14+at+09_12_58.png?expires=1787829300&signature=e425c1d73f05e745bd6c27d05b2bbec54d6f85bcbe01c5fe2f3eccb2c2000512&req=dSkjF8h%2BlYFfXfMW1HO4zUS%2BB1j%2BW3LsylfYa7uDb9mqNlsF3Oi9bqfUW2g%2F%0A6D%2F8qpRL%2FPy3JWZT4L8%3D%0A) \ No newline at end of file diff --git a/content/support/9267400-move-your-personal-claude-account-to-a-team-or-enterprise-organization.md b/content/support/9267400-move-your-personal-claude-account-to-a-team-or-enterprise-organization.md index b2f70f8ae..d531ba0aa 100644 --- a/content/support/9267400-move-your-personal-claude-account-to-a-team-or-enterprise-organization.md +++ b/content/support/9267400-move-your-personal-claude-account-to-a-team-or-enterprise-organization.md @@ -124,7 +124,7 @@ For the full walkthrough of your options, deadlines, and what happens to your su You may have both a personal account and an organization account tied to the same email address. You can switch between them by clicking your initials or name in the lower left corner of the screen. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312193347/712f763fc290b2488c103849f20c/0c135a6f-3442-4ee1-9ab7-98673f03ef6e?expires=1787744700&signature=9b0eea687f1389e7dd9cbdc43d2b9759b2ed11fe68c7540dee6d3aa9286dc5bb&req=diMmFMh3noJbXvMW1HO4zXhPndcxzBtmufhmlOXMdYb5AHm3R0uLP3hbc7Pg%0APx0rFCnSLoywKRnmAbw%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2312193347/712f763fc290b2488c103849f20c/0c135a6f-3442-4ee1-9ab7-98673f03ef6e?expires=1787829300&signature=31b42331bb7c6df08c900f88d39246c322385999368c5c82901d0d8cc1530bf2&req=diMmFMh3noJbXvMW1HO4zXhPndc%2ByhZiufhmlOXMdYYow00U5AYcW6AV6Y1n%0ACiO0B%2Bii6Q3cdlkT4jE%3D%0A) A blue checkmark shows which account you're currently using. Click the other account to switch to it and access its separate conversations and projects. diff --git a/content/support/9519189-manage-project-visibility-and-sharing.md b/content/support/9519189-manage-project-visibility-and-sharing.md index 8aa7fa001..cecd51010 100644 --- a/content/support/9519189-manage-project-visibility-and-sharing.md +++ b/content/support/9519189-manage-project-visibility-and-sharing.md @@ -12,7 +12,7 @@ When creating a project on a Team or Enterprise plan, you can choose between two - **Private:** Only invited members can view and use the project. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370991/2b6b16e5deff094e073a5b4bb0ea/63197103-24c0-41e5-aebd-9b8f431837bb?expires=1787744700&signature=084999331cb09526b15841996824af1988a14bc441420aff9c79a6ab91ec2bea&req=dScjFsp5nYhWWPMW1HO4zd3a2VsjIIqgHK95%2FTFaPynebBHRT9Sn7kr%2BcvS2%0A74zJRzCeiugbjDTqxVQ%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370991/2b6b16e5deff094e073a5b4bb0ea/63197103-24c0-41e5-aebd-9b8f431837bb?expires=1787829300&signature=8cc474cb52423db60fa3802178dba0b1f1f192fb663e6ec3b913ebf26424dc13&req=dScjFsp5nYhWWPMW1HO4zd3a2VssJoekHK95%2FTFaPyn0G9JMfUrLOJ%2FdeEmY%0AJLNt%2B8NK%2BwVd3179vmE%3D%0A) ## What are public projects? @@ -22,11 +22,11 @@ If you choose to share a project with the rest of your organization upon creatio Yes, you can switch the visibility of a project you created as public to private at any time by opening the project and clicking the “Share” button to the right of the project name: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370987/5d5db997e6b42e627ffa62fddf75/4823906b-9535-4a19-b89e-a1003f1e6e68?expires=1787744700&signature=22813dd929cce7194ee9b327c41b121dafb63ebea8b5dca27b1c888c1e8c14ff&req=dScjFsp5nYhXXvMW1HO4zUiDoi7whQIuE8Kp5wh0MSAUyOYdwDGxOfDNPK30%0AZekvpIKjXl5XMScP%2BZU%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370987/5d5db997e6b42e627ffa62fddf75/4823906b-9535-4a19-b89e-a1003f1e6e68?expires=1787829300&signature=7c9a1348017bacab0fde7a2d09975b5c1a3e8f83b093b5ade8ad1b9ee3b3ced6&req=dScjFsp5nYhXXvMW1HO4zUiDoi7%2Fgw8qE8Kp5wh0MSBkUw6HmERZwgKE3JUV%0AtddstY5XtoMM3LI4DVQ%3D%0A) Click “Everyone at [your organization]” under **General access** and select “Only people invited” to change the project from public to private: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370988/386407facbf3e73d2f5538623a18/69d8ffcd-e1ca-470f-a219-5b88704e41f2?expires=1787744700&signature=31d24b7715709de7600da9446d0305ad83689955fe8c2abc92895d567b362fff&req=dScjFsp5nYhXUfMW1HO4zckCIfVlZiajl3XeGelDRW3Ch%2BkLYXvOv9sTJOeR%0AS%2F0TVnOODK4%2Bwcim010%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370988/386407facbf3e73d2f5538623a18/69d8ffcd-e1ca-470f-a219-5b88704e41f2?expires=1787829300&signature=f32bc65beb5d63036526a4d4ac67bf8678a24931bea22910010fe06c767a5bd9&req=dScjFsp5nYhXUfMW1HO4zckCIfVqYCunl3XeGelDRW1lFe%2BcvdM2TEsLzZcj%0AVkv59rWoQ2BsganFYfk%3D%0A) ## What are private projects? @@ -36,11 +36,11 @@ Choosing “Only people invited” keeps your project private so that you are th Yes, you can switch the visibility of a project you created as private to public at any time by opening the project and clicking the “Share” button to the right of the project name: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370989/f829dcd8bdd88e944322f678323f/9d25eff1-6df3-40be-82eb-ba7fe09187e8?expires=1787744700&signature=25a38f4b4be90a6e6da4c3296e8b1b3ae0a259d345120631ea6ebaffb0cdc28c&req=dScjFsp5nYhXUPMW1HO4zaSEGlSbTrwK2JrJefVtywlGCZHZ0v8QBav1ZgTT%0AEHIImRB3EU9nUMWjXx4%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370989/f829dcd8bdd88e944322f678323f/9d25eff1-6df3-40be-82eb-ba7fe09187e8?expires=1787829300&signature=329729da2a0730c9b9705d7367ba08a8f93344245fdd80c96d830af5b3aab10c&req=dScjFsp5nYhXUPMW1HO4zaSEGlSUSLEO2JrJefVtywlFeT%2BQiwsLz7cK5wGu%0Atb7GDdTEzpycWiBPR6I%3D%0A) Click “Only people invited” under General access and select “Everyone at [your organization]” to change the project from private to public: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370990/d173fbc6f030780d30c6d7b8e204/7e47b9d1-89fe-4607-8b5b-f7b06e7ad0d6?expires=1787744700&signature=f17b728aaa832b430c750db6b3264b599cd3d06bc3e0d414d1e8ea28c4c11d15&req=dScjFsp5nYhWWfMW1HO4zT7Q08%2B8uQgRAmYRPrgMBZmY8oZC%2B75JOWBDeflP%0AAEimZFJnChj6qZaJrs8%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1740370990/d173fbc6f030780d30c6d7b8e204/7e47b9d1-89fe-4607-8b5b-f7b06e7ad0d6?expires=1787829300&signature=e5d0d21acd678bf4cfae64facd80de4c098f5e760cc836d385ad1cc3c851cb7e&req=dScjFsp5nYhWWfMW1HO4zT7Q08%2BzvwUVAmYRPrgMBZl%2BEX%2BXNRZv96BXkRfa%0A0AGdJWNtRDs5007bE2k%3D%0A) ## Add and remove access to private projects diff --git a/content/support/9534590-cost-and-usage-reporting-in-the-claude-console.md b/content/support/9534590-cost-and-usage-reporting-in-the-claude-console.md index a893b97b8..31d146a78 100644 --- a/content/support/9534590-cost-and-usage-reporting-in-the-claude-console.md +++ b/content/support/9534590-cost-and-usage-reporting-in-the-claude-console.md @@ -8,7 +8,7 @@ The Claude Console provides detailed cost and usage reporting to help you effect Users with access to these reports can click into them on the left navigation menu on the Console: -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1584654217/db0a977417e38e43639f060d96e0/image.png?expires=1787744700&signature=2cf4dc6ad76d341016c3a594771dd81ae15e0040b3916d582f5d3358d817633b&req=dSUvEs97mYNeXvMW1HO4zYCWiSMfhcKduqqBX2puyxRjP1YtoJfZqdIBTBm1%0Awz0SnYqWyIFO6InHImo%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1584654217/db0a977417e38e43639f060d96e0/image.png?expires=1787829300&signature=2f23caa36d752a0de5b2571091c94390e16faa3e5d912b3ccf73664f37bef76e&req=dSUvEs97mYNeXvMW1HO4zYCWiSMQg8%2BZuqqBX2puyxQ%2BSUFUUaRIfAJyyR84%0ApM2QswTk%2BwgJ49uhJ%2Fo%3D%0A) --- @@ -46,9 +46,9 @@ The [Usage page](https://platform.claude.com/usage) offers a detailed breakdown 6. Use the export button to download a CSV of the displayed data. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1584664321/59b50eba0b61e0789f7055fcf9f4/image+%285%29.png?expires=1787744700&signature=101bfedb702618753d2bbe7ab8833d063e58f99369f84c71531d8aa20c4746f5&req=dSUvEs94mYJdWPMW1HO4zQwER3QtJYthqMITUZbanFAZ1I%2B2NR2rvnaKtnk0%0AUQQPaaDbytsDzq%2FR%2BPQ%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1584664321/59b50eba0b61e0789f7055fcf9f4/image+%285%29.png?expires=1787829300&signature=fa0748a4850e8934fb8084404d47883c155deb01de9c67b197b071c8f2d9afd7&req=dSUvEs94mYJdWPMW1HO4zQwER3QiI4ZlqMITUZbanFDJ72MoGLynf0rF0J19%0Ac28Y7XAXutGErdCjIuA%3D%0A) -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1584693386/aed472efe163abcbc14fa32f3699/rate+limited+requests.png?expires=1787744700&signature=73b79cf0fe2ba62bc483f7dc20d2b31f78e3c654b05d8b341ee9d5527a853b8f&req=dSUvEs93noJXX%2FMW1HO4zRxEwWxK4lVr21D6pckxWMZ4OT6Mv30XkvAaco1j%0AZXRId2saKcVr8JZGTyw%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1584693386/aed472efe163abcbc14fa32f3699/rate+limited+requests.png?expires=1787829300&signature=451fb25a1067bf1c1811a0176173de35fceeaed69c24ed98da1d28604fa256a7&req=dSUvEs93noJXX%2FMW1HO4zRxEwWxF5Fhv21D6pckxWMajYJknmYxcRv27hsBJ%0ACGM%2FxqLmIOuR68EXOYw%3D%0A) ### Rate Limit Use @@ -88,6 +88,6 @@ The [Cost page](https://platform.claude.com/cost) helps you understand your spen 5. Use the export button to download a CSV of the cost data. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1584679401/4d0bc8ed08625e1adee414e77030/CleanShot+2025-06-23+at+08_54_40%402x.png?expires=1787744700&signature=3d7f2ea308599e88cfdfcd2613d49f7b1d30723c04d01d2a7f891f03eedfbeaf&req=dSUvEs95lIVfWPMW1HO4zUR%2Bh5vEV9RmCyIF5nuUsbxQy4sEAiSbvVze%2FdoY%0AjbwSg00hh9AVKAQr8C0%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1584679401/4d0bc8ed08625e1adee414e77030/CleanShot+2025-06-23+at+08_54_40%402x.png?expires=1787829300&signature=eef696efa060ffc66b625556858edac78829fb65924f87ddbfe9f96db2677e31&req=dSUvEs95lIVfWPMW1HO4zUR%2Bh5vLUdliCyIF5nuUsbyB4KVV6%2BmmgWoxRtia%0ABnf2UX7r5%2FAV6BxCBgY%3D%0A) **Note**: Currently, it's not possible to break down usage or cost by individual users. \ No newline at end of file diff --git a/content/support/9547008-publish-and-share-artifacts.md b/content/support/9547008-publish-and-share-artifacts.md index be0c503a3..4b7cf103d 100644 --- a/content/support/9547008-publish-and-share-artifacts.md +++ b/content/support/9547008-publish-and-share-artifacts.md @@ -56,11 +56,11 @@ Publishing also adds the artifact to the **[Artifacts](https://claude.ai/artifac After publishing, you'll see a “Get embed code” button. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1951684960/0cd917c4455b31e86b70a97f8234/image.png?expires=1787744700&signature=735a955d3bf7c33965d4c4b25da140f44fac10ff85425d344c205cacb2cab164&req=dSkiF892mYhZWfMW1HO4zdcpD1FV4QeGR8xgMH3ra8iY%2B5Y6fHsnbyoe42Yu%0AoGOLKCDCVNWlBq9w1qc%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1951684960/0cd917c4455b31e86b70a97f8234/image.png?expires=1787829300&signature=8f85e25055d53ec76943eb63d6fdfe3fa26b0c45c4ca84649acea05d8b2e7b4e&req=dSkiF892mYhZWfMW1HO4zdcpD1Fa5wqCR8xgMH3ra8jCPY6oYM8e6%2FcF5JQ5%0AlOp2Bn6Y%2Bbcb61n2ILY%3D%0A) Click it to open a modal with automatically generated code you can copy and paste to embed your artifact on another website. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1951685860/6bf1aa2c57d6ff95804797779e9c/image.png?expires=1787744700&signature=0d6b5bf320faad4284842816931add3cfc9deeef7f0e9e183bda442b0b47bb11&req=dSkiF892mIlZWfMW1HO4zcqH796EzYBqf3CUbx4Ru6WqM7N5xo%2Fh2pq4Qxu%2F%0AqIEFb%2BhjEqLAK4P%2B%2FCc%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1951685860/6bf1aa2c57d6ff95804797779e9c/image.png?expires=1787829300&signature=9df92b1052f32128b421bd2a48f603fc74e061e0465cac7e02fba112db342927&req=dSkiF892mIlZWfMW1HO4zcqH796Ly41uf3CUbx4Ru6UyuYOUFpBOwlAYzk99%0A2kBaUvDDFxcYt6fzvSQ%3D%0A) You must specify which websites can embed your artifact by entering URLs in the **Allowed domains** field, separated by commas. @@ -116,7 +116,7 @@ Artifacts created on Team or Enterprise accounts can only be shared within your 4. Click “Share & copy link” to make this version shareable. -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1951680160/d5a38784df4c6d0cc55eda339279/Screenshot%2B2025-10-28%2Bat%2B2_00_15-E2-80-AFPM.png?expires=1787744700&signature=f38a009ccc70eb074e27c5745dbdfc8cc09b36426123d906d59a1f1074ba1320&req=dSkiF892nYBZWfMW1HO4zbvYOlbiKX2UK6hAzMpXfmP1ghRUJlfeI4DgHPw4%0Ag01acaersR%2BubOF45Us%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1951680160/d5a38784df4c6d0cc55eda339279/Screenshot%2B2025-10-28%2Bat%2B2_00_15-E2-80-AFPM.png?expires=1787829300&signature=bddc1599ab2b1ecd27d501b5bda6026bb7315d4469aeeadff32f76c700efc3f1&req=dSkiF892nYBZWfMW1HO4zbvYOlbtL3CQK6hAzMpXfmPB1a0LgvCurs4Ayqlz%0AjLw34UHQnL61zaJMJBU%3D%0A) ### Who can access shared artifacts @@ -138,7 +138,7 @@ When you share an artifact, viewers also gain access to any attachments and file 2. In the **Artifact shared** modal, click “Unshare.” -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1951676927/c66153a2c075c6a64404306aefd0/Screenshot%2B2025-10-28%2Bat%2B1_58_24-E2-80-AFPM.png?expires=1787744700&signature=54d1c35e37f26cddc1ef4eea68793879dbe3e3e4f8d1f8c536db8ad5a19f7edf&req=dSkiF895m4hdXvMW1HO4zW9Ewg66%2FXC0gj8mTHivCKabxacMkS3Ur9TrFtM2%0A%2F1SVEVuUGmrO9KQRi5s%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/1951676927/c66153a2c075c6a64404306aefd0/Screenshot%2B2025-10-28%2Bat%2B1_58_24-E2-80-AFPM.png?expires=1787829300&signature=d4bf434a7affbcb16aacd19c9f9209b0cfb698c1b5c484ee1c71d7baa8e6bb51&req=dSkiF895m4hdXvMW1HO4zW9Ewg61%2B32wgj8mTHivCKanZ8w1BjmKXnebsemL%0AI3IokqjPblTxZ6pGcoo%3D%0A) --- diff --git a/content/support/9927533-disable-public-projects-for-your-organization.md b/content/support/9927533-disable-public-projects-for-your-organization.md index 7331c35ef..002e52ba7 100644 --- a/content/support/9927533-disable-public-projects-for-your-organization.md +++ b/content/support/9927533-disable-public-projects-for-your-organization.md @@ -10,7 +10,7 @@ Follow these steps: 2. Find **Public projects** and toggle it off -![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2053902291/8c39d1a79dedc97411eed54dec5c/CleanShot+2026-02-11+at+11_25_34%402x.png?expires=1787744700&signature=53b86dd17a3681a8e51c9a8e582734939b9e382b10651a2dd1e9eff6626df980&req=diAiFcB%2Bn4NWWPMW1HO4zfGib2CjbwRYYabJlVJ9VPwHxZTWEaKrv77SR5XJ%0AR6xcZRH%2FhHGPHCK3HWM%3D%0A) +![](https://downloads.intercomcdn.com/i/o/lupk8zyo/2053902291/8c39d1a79dedc97411eed54dec5c/CleanShot+2026-02-11+at+11_25_34%402x.png?expires=1787829300&signature=d4b5e75c5f8c8d2372b38f89fbd9b3b562816ab4965189c6e68400c02adb08df&req=diAiFcB%2Bn4NWWPMW1HO4zfGib2CsaQlcYabJlVJ9VPzC1efG6JLe5ow5IxtA%0A9WdQqpD4Y5EsE0dn%2FRo%3D%0A) ## How does disabling public projects work? diff --git a/discovery.json b/discovery.json index cef8f53ab..acf969f66 100644 --- a/discovery.json +++ b/discovery.json @@ -1,7 +1,7 @@ { "version": 1, "note": "What the last full run could see outside sources.json. Written by the fetcher so a new source arrives as a diff a human reviews, not as a line in an Actions log nobody reads. Stable facts only: a change here is always news. `review` is the actionable list \u2014 domains we could archive today and do not.", - "updated": "2026-08-26", + "updated": "2026-08-27", "domains": { "anthropic.com": { "status": "frozen", diff --git a/tombstones.json b/tombstones.json index 0bd08cf0b..f49c50bbe 100644 --- a/tombstones.json +++ b/tombstones.json @@ -1,7 +1,7 @@ { "version": 1, "note": "URLs confirmed gone upstream. Kept so a page that died once does not report as a fresh failure on every later run, which would bury the failure that is actually new. An entry clears itself if the URL answers again -- but only while something still probes it. Entries whose local file was removed are no longer fetched, so they stay as a record of the restructure rather than a live check.", - "updated": "2026-08-26", + "updated": "2026-08-27", "urls": { "https://code.claude.com/docs/en/sdk/migration-guide": { "since": "2026-08-25",